[PATCH v3 3/5] setup: provide hint about the source of the explicit git directory
- From
Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
- Date
- Oct 28, 2026, 11:54 UTC
- Message-ID
- <20261028115412.169748-4-kaartic.sivaraam@gmail.com>
- In-Reply-To
- <20261028115412.169748-1-kaartic.sivaraam@gmail.com>
Git directories can be specified explicitly by setting the GIT_DIR environment variable or by passing --git-dir / --bare before a sub-command. When discovery fails in these cases, the error message that we print is a bit unhelpful. This is especially more pronounced when someone sets GIT_DIR and forgets about it.
$ cd /srv/git $ export GIT_DIR=project.git # saves typing --git-dir on every command $ git log --oneline -3 $ git for-each-ref --sort=-committerdate refs/heads | head $ cd ~/src/myproject # later, same terminal $ git status fatal: not a git repository: 'project.git'
The blunt message does not help the user understand where 'project.git' came from. They are on their own in figuring this out.
Improve this error reporting UX by giving an additional hint to the user that the path comes via GIT_DIR. With this, the user would see the more helpful hint:
... $ cd ~/src/myproject # later, same terminal $ git status fatal: not a git repository: 'project.git' this path was taken from $GIT_DIR (which can also be set with --git-dir or --bare)
Signed-off-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com> --- setup.c | 8 +++++++- t/t0009-git-dir-validation.sh | 6 ++++-- 2 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/setup.c b/setup.c index 4789b2d79d..8f6b609240 100644 --- a/setup.c +++ b/setup.c @@ -1152,7 +1152,13 @@ static void repo_discover_explicit_gitdir(struct repo_discovery *discovery, *nongit_ok = 1; goto out; } - die(_("not a git repository: '%s'"), gitdirenv); + /* + * TRANSLATORS: The first %s is a path, the second %s is the + * name of the environment variable it was taken from. + */ + die(_("not a git repository: '%s'\n" + "this path was taken from $%s (which can also be set with --git-dir or --bare)"), + gitdirenv, GIT_DIR_ENVIRONMENT); } if (read_and_verify_repository_format(&discovery->format, gitdirenv, nongit_ok)) diff --git a/t/t0009-git-dir-validation.sh b/t/t0009-git-dir-validation.sh index bc607e6c2a..fed1b045bb 100755 --- a/t/t0009-git-dir-validation.sh +++ b/t/t0009-git-dir-validation.sh @@ -78,13 +78,15 @@ test_expect_success 'setup: --git-dir pointing to an invalid directory is reject test_when_finished "rm -rf parent/empty-dir" && mkdir -p parent/empty-dir && test_must_fail git --git-dir parent/empty-dir rev-parse --is-bare-repository 2>stderr && - test_grep "not a git repository" stderr + test_grep "not a git repository" stderr && + test_grep "taken from \$GIT_DIR" stderr ' test_expect_success 'setup: discovery fails when GIT_DIR points to an invalid directory' ' test_must_fail env GIT_DIR="/path/to/does-not-exist" \ git rev-parse --is-bare-repository 2>stderr && - test_grep "not a git repository" stderr + test_grep "not a git repository" stderr && + test_grep "taken from \$GIT_DIR" stderr ' test_expect_success 'setup: command that does not need a repository stays silent for invalid GIT_DIR' '
-- 2.55.0.1003.g10538fe699