magit-remote-ref-format: Improved documentation
This commit is contained in:
parent
f5ba22f966
commit
997ecb4e10
1 changed files with 7 additions and 1 deletions
8
magit.el
8
magit.el
|
@ -153,9 +153,15 @@ after a confirmation."
|
||||||
(defcustom magit-remote-ref-format 'branch-then-remote
|
(defcustom magit-remote-ref-format 'branch-then-remote
|
||||||
"What format to use for autocompleting refs, in pariticular for remotes.
|
"What format to use for autocompleting refs, in pariticular for remotes.
|
||||||
|
|
||||||
|
Autocompletion is used by functions like `magit-checkout',
|
||||||
|
`magit-interactive-rebase' and others which offer branch name
|
||||||
|
completion.
|
||||||
|
|
||||||
The value 'name-then-remote means remotes will be of the
|
The value 'name-then-remote means remotes will be of the
|
||||||
form \"name (remote)\", while the value 'remote-slash-name
|
form \"name (remote)\", while the value 'remote-slash-name
|
||||||
means that they'll be of the form \"remote/name\"."
|
means that they'll be of the form \"remote/name\". I.e. something that's
|
||||||
|
listed as \"remotes/upstream/next\" by \"git branch -l -a\"
|
||||||
|
will be \"upstream/next\"."
|
||||||
:group 'magit
|
:group 'magit
|
||||||
:type '(choice (const :tag "name (remote)" branch-then-remote)
|
:type '(choice (const :tag "name (remote)" branch-then-remote)
|
||||||
(const :tag "remote/name" remote-slash-branch)))
|
(const :tag "remote/name" remote-slash-branch)))
|
||||||
|
|
Loading…
Reference in a new issue