[PATCH] bash: Disable __git_ps1() if NO_GIT_PS1 is set

Øyvind A. Holm· May 4, 2011, 22:11 UTC · lore

If the user works in a big repository on a slow USB disk or network drive, __git_ps1() can result in a significant delay before the prompt reappears. By setting the environment variable NO_GIT_PS1 to a nonempty value, the use of __git_ps1() is temporarily disabled.

Signed-off-by: Øyvind A. Holm <sunny@sunbase.org>
---
 contrib/completion/git-completion.bash |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

Show changes to contrib/completion/git-completion.bash +6 −0

diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index 0df356d..ee8cef5 100755
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -60,6 +60,11 @@
 #       per-repository basis by setting the bash.showUpstream config
 #       variable.
 #
+#       When working in a big repository on a slow USB disk or network
+#       drive, __git_ps1 may result in a noticeable delay before the prompt
+#       reappears.  To temporarily disable the use of __git_ps1, set
+#       NO_GIT_PS1 to a nonempty value.
+#
 #
 # To submit patches:
 #
@@ -225,6 +230,7 @@ __git_ps1_show_upstream ()
 # returns text to add to bash PS1 prompt (includes branch name)
 __git_ps1 ()
 {
+	[ -z "$NO_GIT_PS1" ] || return
 	local g="$(__gitdir)"
 	if [ -n "$g" ]; then
 		local r=""

-- 
1.7.5.185.g0b9dee

Stefan Haller· May 5, 2011, 17:48 UTC · re: Øyvind A. Holm · lore

Re: [PATCH] bash: Disable __git_ps1() if NO_GIT_PS1 is set

Øyvind A. Holm <sunny@sunbase.org> wrote:

> If the user works in a big repository on a slow USB disk or network
> drive, __git_ps1() can result in a significant delay before the prompt
> reappears. By setting the environment variable NO_GIT_PS1 to a nonempty
> value, the use of __git_ps1() is temporarily disabled.

As far as I can tell, the only thing that makes the prompt slow in large repositories is determining the dirty state; so instead of disabling the prompt entirely, you may want to just unset GIT_PS1_SHOWDIRTYSTATE. That way you still see which branch you are on, for example.

-- 
Stefan Haller
Berlin, Germany
http://www.haller-berlin.de/

patchbash: Disable __git_ps1() if NO_GIT_PS1 is set