git-prompt.sh: update PROMPT_COMMAND documentation
The description of __git_ps1 function operating in two-arg mode was not very clear. It said "set PROMPT_COMMAND=__git_ps1" which is not the right usage for this mode, followed by "To customize the prompt, do this", giving a false impression that those who do not want to customize it can get away with no-arg form, which was incorrect. Make it clear that this mode always takes two arguments, pre and post, with an example. The straight-forward one should be listed as the primary usage, and the confusing one should be an alternate for advanced users. Swap the order of these two. Acked-by: Simon Oosthoek <s.oosthoek@xs4all.nl> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Dec 11, 2012 at 15:04 UTC
de29a7ac0ec31d8f5fa91b7d2f0294165787d558
1 file changed
+11
-5
contrib/completion/git-prompt.sh
+11
-5
@@ -10,14 +10,20 @@
10
# 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
11
# 2) Add the following line to your .bashrc/.zshrc:
12
# source ~/.git-prompt.sh
13
-# 3a) In ~/.bashrc set PROMPT_COMMAND=__git_ps1
14
-# To customize the prompt, provide start/end arguments
15
-# PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
16
-# 3b) Alternatively change your PS1 to call __git_ps1 as
13
+# 3a) Change your PS1 to call __git_ps1 as
14
# command-substitution:
15
# Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
16
# ZSH: PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
20
-# the optional argument will be used as format string
17
+# the optional argument will be used as format string.
18
+# 3b) Alternatively, if you are using bash, __git_ps1 can be
19
+# used for PROMPT_COMMAND with two parameters, <pre> and
20
+# <post>, which are strings you would put in $PS1 before
21
+# and after the status string generated by the git-prompt
22
+# machinery. e.g.
23
+# PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
24
+# will show username, at-sign, host, colon, cwd, then
25
+# various status string, followed by dollar and SP, as
26
+# your prompt.
27
#
28
# The argument to __git_ps1 will be displayed only if you are currently
29
# in a git repository. The %s token will be the name of the current