[PATCH v3 4/5] setup: provide hint about auto-discovery boundaries
- From
Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
- Date
- Oct 28, 2026, 11:54 UTC
- Message-ID
- <20261028115412.169748-5-kaartic.sivaraam@gmail.com>
- In-Reply-To
- <20261028115412.169748-1-kaartic.sivaraam@gmail.com>
In the same spirit as the previous commit, we want to improve the UX of the Git repository discovery case when the GIT_CEILING_DIRECTORIES environment varaible is set. For instance, consider the following scenario:
$ cd ~ && git init # dotfiles repo at ~/.git
$ echo 'export GIT_CEILING_DIRECTORIES=$HOME' >> ~/.bashrc
# stop ~/.git swallowing every
# non-repo directory under ~
...weeks later...
$ cd ~/.config/nvim
$ vim init.lua
$ git status
fatal: not a git repository (or any of the parent directories): .gitThe error message is a bit unhelpful as the gut reaction of the user would be to wonder why their ~/.git directory was not discovered even though the message says it checked the parent directories. We can't really blame the user for not remembering that they had GIT_CEILING_DIRECTORIES configured in their ~/.bashrc.
Improve this error reporting UX by giving an additional hint about the ceiling that auto-discovery was bounded by and also mention what GIT_CEILING_DIRECTORIES was configured to. With this, the user would see the following:
... $ git status fatal: not a git repository (or any of the parent directories): .git searched from '/home/user/.config/nvim' up to '/home/user/.config' $GIT_CEILING_DIRECTORIES is set to '/home/user'
Signed-off-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com> --- setup.c | 29 ++++++++++++++++++++++++++--- t/t0009-git-dir-validation.sh | 4 +++- 2 files changed, 29 insertions(+), 4 deletions(-)
diff --git a/setup.c b/setup.c index 8f6b609240..87fcead87e 100644 --- a/setup.c +++ b/setup.c @@ -1997,9 +1997,32 @@ static void repo_discover(struct repo_discovery *discovery, int *nongit_ok) repo_discover_bare_gitdir(discovery, &cwd, dir.len, nongit_ok); break; case GIT_DIR_HIT_CEILING: - if (!nongit_ok) - die(_("not a git repository (or any of the parent directories): %s"), - DEFAULT_GIT_DIR_ENVIRONMENT); + if (!nongit_ok) { + struct strbuf message = STRBUF_INIT; + const char *ceiling = getenv(CEILING_DIRECTORIES_ENVIRONMENT); + + strbuf_addf(&message, + /* + * TRANSLATORS: The first %s is ".git", the + * second and third %s are the directories + * where the search for a repository started + * and where it stopped. + */ + _("not a git repository (or any of the parent directories): %s\n" + "searched from '%s' up to '%s'"), + DEFAULT_GIT_DIR_ENVIRONMENT, cwd.buf, dir.buf); + if (ceiling && *ceiling) { + strbuf_addch(&message, '\n'); + /* + * TRANSLATORS: The first %s is the name of + * the environment variable, the second %s is + * its value. + */ + strbuf_addf(&message, _("$%s is set to '%s'"), + CEILING_DIRECTORIES_ENVIRONMENT, ceiling); + } + die("%s", message.buf); + } *nongit_ok = 1; break; case GIT_DIR_HIT_MOUNT_POINT: diff --git a/t/t0009-git-dir-validation.sh b/t/t0009-git-dir-validation.sh index fed1b045bb..ab3d2593aa 100755 --- a/t/t0009-git-dir-validation.sh +++ b/t/t0009-git-dir-validation.sh @@ -101,7 +101,9 @@ test_expect_success 'setup: discovery fails when a valid git directory not found cd parent/no-valid-git-directory-within-ceiling/ceil/sub && test_must_fail env GIT_CEILING_DIRECTORIES="$(pwd)/../../" \ git rev-parse --is-bare-repository 2>stderr && - test_grep "not a git repository (or any of the parent directories)" stderr + test_grep "not a git repository (or any of the parent directories)" stderr && + test_grep "searched from .*ceil/sub.*up to.*ceil." stderr && + test_grep "GIT_CEILING_DIRECTORIES is set to" stderr ) '
-- 2.55.0.1003.g10538fe699