Variable: magit-read-worktree-directory-function

magit-read-worktree-directory-function is a customizable variable defined in magit-worktree.el.

Value

magit-read-worktree-directory-sibling

Documentation

Function used to read the directory to be used as a new worktree.

This is called with two arguments, the prompt and the commit to be checked out.

This variable was added, or its default value changed, in magit version 4.4.0.

Source Code

;; Defined in ~/.emacs.d/elpa/magit-20260822.1158/magit-worktree.el
;;; Options

(defcustom magit-read-worktree-directory-function
  #'magit-read-worktree-directory-sibling
  "Function used to read the directory to be used as a new worktree.
This is called with two arguments, the prompt and the commit to be
checked out."
  :package-version '(magit . "4.4.0")
  :group 'magit-commands
  :type `(radio (function-item ,#'magit-read-worktree-directory)
                (function-item ,#'magit-read-worktree-directory-nested)
                (function-item ,#'magit-read-worktree-directory-sibling)
                (function-item ,#'magit-read-worktree-directory-offsite)
                function))