summaryrefslogtreecommitdiff
path: root/contrib/completion
diff options
context:
space:
mode:
authorElijah Newren <newren@gmail.com>2020-06-21 05:21:26 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-06-22 16:29:59 (GMT)
commit30b00f009c28d595fba967bbf33a9c4031b3292b (patch)
tree2c03a9cd0d68b0eedecbc867dad326d532c68a31 /contrib/completion
parent051df3cfe8ed7d113197636f860edea14f283037 (diff)
downloadgit-30b00f009c28d595fba967bbf33a9c4031b3292b.zip
git-30b00f009c28d595fba967bbf33a9c4031b3292b.tar.gz
git-30b00f009c28d595fba967bbf33a9c4031b3292b.tar.bz2
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>
Diffstat (limited to 'contrib/completion')
-rw-r--r--contrib/completion/git-prompt.sh4
1 files changed, 4 insertions, 0 deletions
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index 014cd7c..179b96e 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -70,6 +70,10 @@
# state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
# is SP.
#
+# When there is an in-progress operation such as a merge, rebase,
+# revert, cherry-pick, or bisect, the prompt will include information
+# related to the operation, often in the form "|<OPERATION-NAME>".
+#
# By default, __git_ps1 will compare HEAD to your SVN upstream if it can
# find one, or @{upstream} otherwise. Once you have set
# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by