[PATCH] git-prompt: Document GIT_PS1_DESCRIBE_STYLE

2012-12-11 Thread Anders Kaseorg
GIT_PS1_DESCRIBE_STYLE was introduced in v1.6.3.2~35.  Document it in the 
header comments.

Signed-off-by: Anders Kaseorg ande...@mit.edu
---
 contrib/completion/git-prompt.sh | 9 +
 1 file changed, 9 insertions(+)

diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index bf20491..5ab488c 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -49,6 +49,15 @@
 # find one, or @{upstream} otherwise.  Once you have set
 # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
 # setting the bash.showUpstream config variable.
+#
+# If you would like to see more information about the identity of
+# commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
+# to one of these values:
+#
+# contains  relative to newer annotated tag (v1.6.3.2~35)
+# branchrelative to newer tag or branch (master~4)
+# describe  relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
+# default   exactly matching tag
 
 # __gitdir accepts 0 or 1 arguments (i.e., location)
 # returns location of .git repo
-- 
1.8.0

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] git-prompt: Document GIT_PS1_DESCRIBE_STYLE

2012-12-11 Thread Junio C Hamano
Anders Kaseorg ande...@mit.edu writes:

 GIT_PS1_DESCRIBE_STYLE was introduced in v1.6.3.2~35.  Document it in the 
 header comments.

 Signed-off-by: Anders Kaseorg ande...@mit.edu
 ---

Thanks.

  contrib/completion/git-prompt.sh | 9 +
  1 file changed, 9 insertions(+)

 diff --git a/contrib/completion/git-prompt.sh 
 b/contrib/completion/git-prompt.sh
 index bf20491..5ab488c 100644
 --- a/contrib/completion/git-prompt.sh
 +++ b/contrib/completion/git-prompt.sh
 @@ -49,6 +49,15 @@
  # find one, or @{upstream} otherwise.  Once you have set
  # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
  # setting the bash.showUpstream config variable.
 +#
 +# If you would like to see more information about the identity of
 +# commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
 +# to one of these values:
 +#
 +# contains  relative to newer annotated tag (v1.6.3.2~35)
 +# branchrelative to newer tag or branch (master~4)
 +# describe  relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
 +# default   exactly matching tag
  
  # __gitdir accepts 0 or 1 arguments (i.e., location)
  # returns location of .git repo
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html