Re: [PATCH] read_gitfile_gently(): return non-repo path on error
- From
Jeff King <peff@peff.net>
- Date
- Jun 2, 2026, 08:02 UTC
- Message-ID
- <20260602080223.GA763528@coredump.intra.peff.net>
- In-Reply-To
- <xmqq4ijlz8vc.fsf@gitster.g>
On Tue, Jun 02, 2026 at 04:42:15PM +0900, Junio C Hamano wrote:
Show 10 quoted lines
> > One, I'm not sure how useful printing the pointed-to directory is. We > > _could_ just say: > > > > fatal: gitfile does not point to a valid repository: /path/to/.git > > > > which is enough for somebody to investigate themselves. That would > > certainly make the patch smaller. > > Thanks. While reading the main explanation, it was the first thing > that came to me.
Here's what that looks like, for reference. It is nice and simple, if we think the change in error message is acceptable. I hate to change user-facing error messages because of internal code details, but I really do wonder if the existing message is the most useful thing to print in the first place.
diff --git a/setup.c b/setup.c index 075bf89fa9..ed86671d84 100644 --- a/setup.c +++ b/setup.c @@ -920,7 +920,7 @@ int verify_repository_format(const struct repository_format *format, return 0; } -void read_gitfile_error_die(int error_code, const char *path, const char *dir) +void read_gitfile_error_die(int error_code, const char *path) { switch (error_code) { case READ_GITFILE_ERR_NOT_A_FILE: @@ -940,7 +940,8 @@ void read_gitfile_error_die(int error_code, const char *path, const char *dir) case READ_GITFILE_ERR_NO_PATH: die(_("no path in gitfile: %s"), path); case READ_GITFILE_ERR_NOT_A_REPO: - die(_("not a git repository: %s"), dir); + die(_("gitfile does not point to a valid repository: %s"), + path); default: BUG("unknown error code"); } @@ -1031,7 +1032,7 @@ const char *read_gitfile_gently(const char *path, int *return_error_code) if (return_error_code) *return_error_code = error_code; else if (error_code) - read_gitfile_error_die(error_code, path, dir); + read_gitfile_error_die(error_code, path); free(buf); return error_code ? NULL : path; @@ -1641,7 +1642,7 @@ static enum discovery_result setup_git_directory_gently_1(struct strbuf *dir, return GIT_DIR_INVALID_GITFILE; default: if (die_on_error) - read_gitfile_error_die(error_code, dir->buf, NULL); + read_gitfile_error_die(error_code, dir->buf); else return GIT_DIR_INVALID_GITFILE; } diff --git a/setup.h b/setup.h index 7878c9d267..436aaa22c1 100644 --- a/setup.h +++ b/setup.h @@ -38,7 +38,7 @@ int is_nonbare_repository_dir(struct strbuf *path); #define READ_GITFILE_ERR_TOO_LARGE 8 #define READ_GITFILE_ERR_MISSING 9 #define READ_GITFILE_ERR_IS_A_DIR 10 -void read_gitfile_error_die(int error_code, const char *path, const char *dir); +void read_gitfile_error_die(int error_code, const char *path); const char *read_gitfile_gently(const char *path, int *return_error_code); #define read_gitfile(path) read_gitfile_gently((path), NULL) const char *resolve_gitdir_gently(const char *suspect, int *return_error_code); diff --git a/submodule.c b/submodule.c index a939ff5072..c36732ca0b 100644 --- a/submodule.c +++ b/submodule.c @@ -2578,7 +2578,7 @@ void absorb_git_dir_into_superproject(const char *path, if (err_code != READ_GITFILE_ERR_NOT_A_REPO) /* We don't know what broke here. */ - read_gitfile_error_die(err_code, path, NULL); + read_gitfile_error_die(err_code, path); /* * Maybe populated, but no git directory was found? diff --git a/t/t0002-gitfile.sh b/t/t0002-gitfile.sh index dfbcdddbcc..6356e9ec72 100755 --- a/t/t0002-gitfile.sh +++ b/t/t0002-gitfile.sh @@ -27,7 +27,7 @@ test_expect_success 'bad setup: invalid .git file format' ' test_expect_success 'bad setup: invalid .git file path' ' echo "gitdir: $REAL.not" >.git && test_must_fail git rev-parse 2>.err && - test_grep "not a git repository" .err + test_grep "gitfile does not point to a valid repository" .err ' test_expect_success 'final setup + check rev-parse --git-dir' '