git-prompt: document how in-progress operations affect the prompt
Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Elijah Newren committed
Jun 21, 2020 at 05:21 UTC
30b00f009c28d595fba967bbf33a9c4031b3292b
1 file changed
+4
contrib/completion/git-prompt.sh
+4
@@ -70,6 +70,10 @@
70
# state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
71
# is SP.
72
#
73
+# When there is an in-progress operation such as a merge, rebase,
74
+# revert, cherry-pick, or bisect, the prompt will include information
75
+# related to the operation, often in the form "|<OPERATION-NAME>".
76
+#
77
# By default, __git_ps1 will compare HEAD to your SVN upstream if it can
78
# find one, or @{upstream} otherwise. Once you have set
79
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by