From: Junio C Hamano Date: Wed, 12 Dec 2012 19:08:13 +0000 (-0800) Subject: Merge branch 'so/prompt-command' X-Git-Tag: v1.8.1-rc2~6 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/4881616c1a4fa7b19ca2c722ef0b3d48316ac8ef?ds=inline;hp=-c Merge branch 'so/prompt-command' * so/prompt-command: git-prompt.sh: update PROMPT_COMMAND documentation --- 4881616c1a4fa7b19ca2c722ef0b3d48316ac8ef diff --combined contrib/completion/git-prompt.sh index a8b53ba5f3,899eb095c6..9b074e148d --- a/contrib/completion/git-prompt.sh +++ b/contrib/completion/git-prompt.sh @@@ -10,14 -10,20 +10,20 @@@ # 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh). # 2) Add the following line to your .bashrc/.zshrc: # source ~/.git-prompt.sh - # 3a) In ~/.bashrc set PROMPT_COMMAND=__git_ps1 - # To customize the prompt, provide start/end arguments - # PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "' - # 3b) Alternatively change your PS1 to call __git_ps1 as + # 3a) Change your PS1 to call __git_ps1 as # command-substitution: # Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ ' # ZSH: PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ ' - # the optional argument will be used as format string + # the optional argument will be used as format string. + # 3b) Alternatively, if you are using bash, __git_ps1 can be + # used for PROMPT_COMMAND with two parameters,
 and
+ #        , which are strings you would put in $PS1 before
+ #        and after the status string generated by the git-prompt
+ #        machinery.  e.g.
+ #           PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
+ #        will show username, at-sign, host, colon, cwd, then
+ #        various status string, followed by dollar and SP, as
+ #        your prompt.
  #
  # The argument to __git_ps1 will be displayed only if you are currently
  # in a git repository.  The %s token will be the name of the current
@@@ -55,19 -61,10 +61,19 @@@
  # 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)
 +#     branch        relative to newer tag or branch (master~4)
 +#     describe      relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
 +#     default       exactly matching tag
 +#
  # If you would like a colored hint about the current dirty state, set
  # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
  # the colored output of "git status -sb".
 -#
 +
  # __gitdir accepts 0 or 1 arguments (i.e., location)
  # returns location of .git repo
  __gitdir ()