git-prompt.sh: update shell variable instructions.

edsouza · edsouza · commit 0074d3da7ad4 · 2019-06-04T02:01:21.000-04:00
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 &lt;edsouza@gmail.com&gt;
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,11 @@`
`35`	`35`	`#`
`36`	`36`	`# The prompt status always includes the current branch name.`
`37`	`37`	`#`
	`38`	`+# The prompt can be customized by setting various shell variables`
	`39`	`+# (GIT_PS1_SHOWDIRTYSTATE, GIT_PS1_SHOWSTASHSTATE, etc.), which are described`
	`40`	`+# below. Make sure that these variables get set before the`
	`41`	`+# "source ~/.git-prompt.sh" line from step 2 (above) runs.`
	`42`	`+#`
`38`	`43`	`# In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value,`
`39`	`44`	`# unstaged (*) and staged (+) changes will be shown next to the branch`
`40`	`45`	`# name. You can configure this per-repository with the`