Skip to content

Commit 4881616

Browse files
committed
Merge branch 'so/prompt-command'
* so/prompt-command: git-prompt.sh: update PROMPT_COMMAND documentation
2 parents 75ed918 + de29a7a commit 4881616

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

contrib/completion/git-prompt.sh

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,20 @@
1010
# 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
1111
# 2) Add the following line to your .bashrc/.zshrc:
1212
# 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
1714
# command-substitution:
1815
# Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
1916
# 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.
2127
#
2228
# The argument to __git_ps1 will be displayed only if you are currently
2329
# in a git repository. The %s token will be the name of the current

0 commit comments

Comments
 (0)