From: Edward D'Souza <edsouza@xxxxxxxxx> Clarify the need to set variables like GIT_PS1_SHOWDIRTYSTATE before "source ~/.git-prompt.sh" is executed in your shell init process. If you set these preferences too late i.e. after .git-prompt.sh executes, they will silently fail to take effect. Signed-off-by: Edward D'Souza <edsouza@xxxxxxxxx> --- contrib/completion/git-prompt.sh | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh index c6cbef38c2..ab5bcc0fec 100644 --- a/contrib/completion/git-prompt.sh +++ b/contrib/completion/git-prompt.sh @@ -35,6 +35,11 @@ # # The prompt status always includes the current branch name. # +# The prompt can be customized by setting various shell variables +# (GIT_PS1_SHOWDIRTYSTATE, GIT_PS1_SHOWSTASHSTATE, etc.), which are described +# below. Make sure that these variables get set *before* the +# "source ~/.git-prompt.sh" line from step 2 (above) runs. +# # In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value, # unstaged (*) and staged (+) changes will be shown next to the branch # name. You can configure this per-repository with the -- gitgitgadget
