git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCHv3 11/16] bash prompt: combine 'git rev-parse' for detached head

From
SZEDER Gábor <szeder@ira.uka.de>
Date
Jun 24, 2013, 16:39 UTC
Message-ID
<1372091966-19315-12-git-send-email-szeder@ira.uka.de>
In-Reply-To
<1372091966-19315-1-git-send-email-szeder@ira.uka.de>

When describing a detached HEAD according to the $GIT_PS1_DESCRIBE environment variable fails, __git_ps1() now runs the '$(git rev-parse --short HEAD)' command substitution to get the abbreviated detached HEAD commit object name. This imposes the overhead of fork()ing a subshell and fork()+exec()ing a git process.

Avoid this overhead by combining this command substitution with the "main" 'git rev-parse' execution for getting the path to the .git directory & co. This means that we'll look for the abbreviated commit object name even when it's not necessary, because we're on a branch or the detached HEAD can be described. It doesn't matter, however, because once 'git rev-parse' is up and running to fulfill all those other queries, the additional overhead of looking for the abbreviated commit object name is not measurable because it's lost in the noise.

There is a caveat, however, when we are on an unborn branch, because in that case HEAD doesn't point to a valid commit, hence the query for the abbreviated commit object name fails. Therefore, '--short HEAD' must be the last options to 'git rev-parse' in order to get all the other necessary information for the prompt even on an unborn branch. Furthermore, in that case, and in that case only, 'git rev-parse' doesn't output the last line containing the abbreviated commit object name, obviously, so we have to take care to only parse it if 'git rev-parse' exited without any error.

Although there are tests already excercising __git_ps1() on unborn branches, they all do so implicitly. Add a test that checks this explicitly.

Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
---
 contrib/completion/git-prompt.sh | 16 ++++++++++++----
 t/t9903-bash-prompt.sh           |  8 ++++++++
 2 files changed, 20 insertions(+), 4 deletions(-)
diff --git a/contrib/completion/git-prompt.sh b/contrib/completion/git-prompt.sh
index 7d226251..88d6121d 100644
--- a/contrib/completion/git-prompt.sh
+++ b/contrib/completion/git-prompt.sh
@@ -311,8 +311,12 @@ __git_ps1 ()
 		;;
 	esac
 
-	local repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
-		--is-bare-repository --is-inside-work-tree 2>/dev/null)"
+	local repo_info rev_parse_exit_code
+	repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
+		--is-bare-repository --is-inside-work-tree \
+		--short HEAD 2>/dev/null)"
+	rev_parse_exit_code="$?"
+
 	if [ -z "$repo_info" ]; then
 		if [ $pcmode = yes ]; then
 			#In PC mode PS1 always needs to be set
@@ -321,6 +325,11 @@ __git_ps1 ()
 		return
 	fi
 
+	local short_sha
+	if [ "$rev_parse_exit_code" = "0" ]; then
+		short_sha="${repo_info##*$'\n'}"
+		repo_info="${repo_info%$'\n'*}"
+	fi
 	local inside_worktree="${repo_info##*$'\n'}"
 	repo_info="${repo_info%$'\n'*}"
 	local bare_repo="${repo_info##*$'\n'}"
@@ -392,8 +401,7 @@ __git_ps1 ()
 					git describe --tags --exact-match HEAD ;;
 				esac 2>/dev/null)" ||
 
-				b="$(git rev-parse --short HEAD 2>/dev/null)..." ||
-				b="unknown"
+				b="$short_sha..."
 				b="($b)"
 			fi
 		fi
diff --git a/t/t9903-bash-prompt.sh b/t/t9903-bash-prompt.sh
index 0d53aa6d..b9895c79 100755
--- a/t/t9903-bash-prompt.sh
+++ b/t/t9903-bash-prompt.sh
@@ -49,6 +49,14 @@ test_expect_success SYMLINKS 'prompt - branch name - symlink symref' '
 	test_cmp expected "$actual"
 '
 
+test_expect_success 'prompt - unborn branch' '
+	printf " (unborn)" >expected &&
+	git checkout --orphan unborn &&
+	test_when_finished "git checkout master" &&
+	__git_ps1 >"$actual" &&
+	test_cmp expected "$actual"
+'
+
 test_expect_success 'prompt - detached head' '
 	printf " ((%s...))" $(git log -1 --format="%h" --abbrev=13 b1^) >expected &&
 	test_config core.abbrev 13 &&
-- 
1.8.3.1.599.g4459181
Previous: SZEDER GáborNext: SZEDER Gábor
Message 12 of 19 in “[PATCHv3 00/16] bash prompt speedup”
  1. SZEDER GáborJun 24, 2013
  2. 01/16 bash prompt: fix redirection coding style in testsSZEDER Gábor, Jun 24, 2013
  3. 02/16 bash prompt: use 'write_script' helper in interactive rebase testSZEDER Gábor, Jun 24, 2013
  4. 03/16 completion, bash prompt: move __gitdir() tests to completion test suiteSZEDER Gábor, Jun 24, 2013
  5. 04/16 bash prompt: add a test for symbolic link symbolic refsSZEDER Gábor, Jun 24, 2013
  6. 05/16 bash prompt: print unique detached HEAD abbreviated object nameSZEDER Gábor, Jun 24, 2013
  7. 06/16 bash prompt: return early from __git_ps1() when not in a git repositorySZEDER Gábor, Jun 24, 2013
  8. 07/16 bash prompt: run 'git rev-parse --git-dir' directly instead of __gitdir()SZEDER Gábor, Jun 24, 2013
  9. 08/16 bash prompt: use bash builtins to find out rebase stateSZEDER Gábor, Jun 24, 2013
  10. 09/16 bash prompt: use bash builtins to find out current branchSZEDER Gábor, Jun 24, 2013
  11. 10/16 bash prompt: combine 'git rev-parse' executions in the main code pathSZEDER Gábor, Jun 24, 2013
  12. 11/16 bash prompt: combine 'git rev-parse' for detached headSZEDER Gábor, Jun 24, 2013
  13. 12/16 bash prompt: use bash builtins to check for unborn branch for dirty stateSZEDER Gábor, Jun 24, 2013
  14. 13/16 bash prompt: use bash builtins to check stash stateSZEDER Gábor, Jun 24, 2013
  15. 14/16 bash prompt: avoid command substitution when checking for untracked filesSZEDER Gábor, Jun 24, 2013
  16. 15/16 bash prompt: avoid command substitution when finalizing gitstringSZEDER Gábor, Jun 24, 2013
  17. 16/16 bash prompt: mention that PROMPT_COMMAND mode is fasterSZEDER Gábor, Jun 24, 2013
  18. Junio C HamanoJun 24, 2013
  19. Eduardo R. D'AvilaJun 25, 2013

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.