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

[RFC] setup: fail if .git is not a file or directory

From
Tian Yuchen <a3205153416@gmail.com>
Date
Feb 11, 2026, 18:21 UTC
Message-ID
<20260211182122.35352-1-a3205153416@gmail.com>

Currently, `setup_git_directory_gently_1()` checks if `.git` is a regular file (handling submodules/worktrees) or a directory. If it is neither (e.g., a FIFO), the code hits a NEEDSWORK comment and simply ignores the entity, continuing the discovery process in the parent directory.

This behavior can be very dangerous. If a user is inside a subdirectory containing a melformed/broken `.git` entity, the Git will traverse up, attach to a parent repository and might execute destructive commands.

I tried to resolve the NEEDSWORK by using `lstat()` to explicitly check the entity's mode. If it is neither a regular file nor a directory, we kill the discovery process.

But I still have questions:
1. Is failing hard the desired behavior here? Should skipping it and
   continuing discovery be an option for the user, which might seem
   more fault-tolerant?
2. Should we die() immediately here, or return GIT_DIR_INVALID_GITFILE
   and let the caller decide?
Signed-off-by: Tian Yuchen <a3205153416@gmail.com>
---
 setup.c | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/setup.c b/setup.c
index 3a6a048620..a1b56de67a 100644
--- a/setup.c
+++ b/setup.c
@@ -1581,7 +1581,17 @@ static enum discovery_result setup_git_directory_gently_1(struct strbuf *dir,
 		if (!gitdirenv) {
 			if (die_on_error ||
 			    error_code == READ_GITFILE_ERR_NOT_A_FILE) {
-				/* NEEDSWORK: fail if .git is not file nor dir */
+				struct stat st;
+				if (!lstat(dir->buf, &st) &&
+					!S_ISREG(st.st_mode) &&
+					!S_ISDIR(st.st_mode)){
+
+					if (die_on_error)
+						die(_("Invalid %s: not a regular file or directory"), dir->buf);
+					else
+						return GIT_DIR_INVALID_GITFILE;
+				}
+
 				if (is_git_directory(dir->buf)) {
 					gitdirenv = DEFAULT_GIT_DIR_ENVIRONMENT;
 					gitdir_path = xstrdup(dir->buf);
-- 
2.43.0
Next: Junio C Hamano
Message 1 of 35 in “[RFC] setup: fail if .git is not a file or directory”
  1. Tian YuchenFeb 11, 2026
  2. Junio C HamanoFeb 11, 2026
  3. Tian YuchenFeb 12, 2026
  4. setup: fail if .git is not a file or directoryTian Yuchen, Feb 12, 2026
  5. Junio C HamanoFeb 12, 2026
  6. Tian YuchenFeb 13, 2026
  7. setup: fail if .git is not a file or directoryTian Yuchen, Feb 14, 2026
  8. Junio C HamanoFeb 15, 2026
  9. Tian YuchenFeb 15, 2026
  10. Junio C HamanoFeb 16, 2026
  11. Tian YuchenFeb 16, 2026
  12. setup: allow cwd/.git to be a symlink to a directoryTian Yuchen, Feb 17, 2026
  13. Karthik NayakFeb 17, 2026
  14. Tian YuchenFeb 17, 2026
  15. Karthik NayakFeb 17, 2026
  16. Junio C HamanoFeb 17, 2026
  17. Junio C HamanoFeb 17, 2026
  18. Karthik NayakFeb 17, 2026
  19. Tian YuchenFeb 18, 2026
  20. Karthik NayakFeb 17, 2026
  21. 0/2 setup.c: v5 rerollTian Yuchen, Feb 18, 2026
  22. 1/2 setup: distingush ENOENT from other stat errorsTian Yuchen, Feb 18, 2026
  23. Karthik NayakFeb 18, 2026
  24. Tian YuchenFeb 18, 2026
  25. Junio C HamanoFeb 18, 2026
  26. Junio C HamanoFeb 18, 2026
  27. 2/2 setup: allow cwd/.git to be a symlink to a directoryTian Yuchen, Feb 18, 2026
  28. Karthik NayakFeb 18, 2026
  29. Tian YuchenFeb 18, 2026
  30. Junio C HamanoFeb 18, 2026
  31. Tian YuchenFeb 19, 2026
  32. Tian YuchenFeb 15, 2026
  33. brian m. carlsonFeb 12, 2026
  34. Junio C HamanoFeb 12, 2026
  35. brian m. carlsonFeb 12, 2026

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.