From: Federico Bruni <fede@inventati.org>
Date: Thu, 20 Jul 2017 20:23:57 +0000 (+0100)
Subject: Doc: CG, explain other git prompt variables
X-Git-Url: https://git.donarmstrong.com/?p=lilypond.git;a=commitdiff_plain;h=68dbc841e3401f14b900f6750ebb49b406caf357

Doc: CG, explain other git prompt variables

The use of these environment variables is documented within the
git source code: git/contrib/completion/git-prompt.sh
---

diff --git a/Documentation/contributor/source-code.itexi b/Documentation/contributor/source-code.itexi
index ac8ecb6ee4..620368280a 100644
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -209,13 +209,25 @@ git config --global core.editor @var{nano}
 @end example
 
 Finally, and in some ways most importantly, let's make sure that
-we know what branch we're on.  If you're not using LilyDev, add
-this to your @file{~/.bashrc}:
+we can easily see the state of our working copy, without the need
+of typing @code{git status} repeatedly.  If you're not using
+LilyDev, add the following lines to your @file{~/.bashrc}:
 
 @verbatim
 export PS1="\u@\h \w\$(__git_ps1)$ "
+export GIT_PS1_SHOWDIRTYSTATE=true
+export GIT_PS1_SHOWUNTRACKEDFILES=true
+export GIT_PS1_SHOWUPSTREAM=auto
 @end verbatim
 
+The first line will show the branch we're on.  The other lines
+will use some symbols next to the branch name to indicate some
+kind of state. @qq{*} means that there are unstaged changes,
+@qq{+} indicates staged changes; if there are untracked files,
+a @qq{%} will appear.  Finally, we can also see if our HEAD is
+behind (@qq{<}) or ahead (@qq{>}) of its upstream, and if they
+have diverged (@qq{<>}) or they are synced (@qq{=}).
+
 You may need to install the additional @code{bash-completion}
 package, but it is definitely worth it.  After installation
 you must log out, and then log back in again to enable it.