[PATCH v3 2/3] git-prompt: document how in-progress operations affect the prompt

From

Elijah Newren via GitGitGadget <gitgitgadget@gmail.com>

Date

Jun 21, 2020, 05:21 UTC

Message-ID

<1fd1b919684173d0971869a9aaf8554055760d63.1592716887.git.gitgitgadget@gmail.com>

In-Reply-To

<pull.808.v3.git.git.1592716887.gitgitgadget@gmail.com>

From: Elijah Newren <newren@gmail.com>

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 contrib/completion/git-prompt.sh | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index 014cd7c3cfc..179b96e4936 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

-- 
gitgitgadget