From 997ecb4e104a75666e0f41cdadbf26d9682db784 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Date: Sat, 3 Jul 2010 00:31:48 +0800 Subject: [PATCH] magit-remote-ref-format: Improved documentation --- magit.el | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/magit.el b/magit.el index 5c6c3af1..f62137cf 100644 --- a/magit.el +++ b/magit.el @@ -153,9 +153,15 @@ after a confirmation." (defcustom magit-remote-ref-format 'branch-then-remote "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 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 :type '(choice (const :tag "name (remote)" branch-then-remote) (const :tag "remote/name" remote-slash-branch)))