git/list[1] front-page[2] threads[3] people[4] search[5] about
wed 2026-10-07 17:18 UTC

[GSoC Patch v4 3/4] repo: add path.commondir with absolute and relative suffix formatting

From
K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
Date
Jun 15, 2026, 04:51 UTC
Message-ID
<20260615045112.50686-4-jayatheerthkulkarni2005@gmail.com>
In-Reply-To
<20260615045112.50686-1-jayatheerthkulkarni2005@gmail.com>

Scripts working with worktree setups need a reliable way to discover the common directory, which diverges from the git directory when multiple worktrees are in use. There is no way to retrieve this path from git repo info today.

Introduce path.commondir.absolute and path.commondir.relative keys. Exposing explicit format variants rather than a single key with a default avoids ambiguity for scripts that require predictable output.

Add a test helper test_repo_info_path that creates isolated repositories per test case to prevent state leaks, captures the repo root before changing directories to avoid eval, and accepts an optional init_command to cover environment variable overrides such as GIT_COMMON_DIR and GIT_DIR.

Mentored-by: Justin Tobler <jltobler@gmail.com>
Mentored-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
Signed-off-by: K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
---
 Documentation/git-repo.adoc |  9 ++++++
 builtin/repo.c              | 26 ++++++++++++++++
 t/t1900-repo-info.sh        | 61 +++++++++++++++++++++++++++++++++++++
 3 files changed, 96 insertions(+)
diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
index 42262c1983..890c34051d 100644
--- a/Documentation/git-repo.adoc
+++ b/Documentation/git-repo.adoc
@@ -104,6 +104,15 @@ values that they return:
 `object.format`::
 	The object format (hash algorithm) used in the repository.
 
+`path.commondir.absolute`::
+	The canonical absolute path to the Git repository's common
+	directory (the shared `.git` directory containing objects,
+	refs, and global configuration).
+
+`path.commondir.relative`::
+	The path to the Git repository's common directory relative to
+	the current working directory.
+
 `references.format`::
 	The reference storage format. The valid values are:
 +
diff --git a/builtin/repo.c b/builtin/repo.c
index 71a5c1c29c..c4cc3bf3fc 100644
--- a/builtin/repo.c
+++ b/builtin/repo.c
@@ -7,12 +7,14 @@
 #include "hex.h"
 #include "odb.h"
 #include "parse-options.h"
+#include "path.h"
 #include "path-walk.h"
 #include "progress.h"
 #include "quote.h"
 #include "ref-filter.h"
 #include "refs.h"
 #include "revision.h"
+#include "setup.h"
 #include "strbuf.h"
 #include "string-list.h"
 #include "shallow.h"
@@ -75,6 +77,28 @@ static int get_object_format(struct repository *repo, struct strbuf *buf)
 	return 0;
 }
 
+static int get_path_commondir_absolute(struct repository *repo, struct strbuf *buf)
+{
+	const char *common_dir = repo_get_common_dir(repo);
+
+	if (!common_dir)
+		return error(_("unable to get common directory"));
+
+	append_formatted_path(buf, common_dir, startup_info->prefix, PATH_FORMAT_CANONICAL);
+	return 0;
+}
+
+static int get_path_commondir_relative(struct repository *repo, struct strbuf *buf)
+{
+	const char *common_dir = repo_get_common_dir(repo);
+
+	if (!common_dir)
+		return error(_("unable to get common directory"));
+
+	append_formatted_path(buf, common_dir, startup_info->prefix, PATH_FORMAT_RELATIVE);
+	return 0;
+}
+
 static int get_references_format(struct repository *repo, struct strbuf *buf)
 {
 	strbuf_addstr(buf,
@@ -87,6 +111,8 @@ static const struct repo_info_field repo_info_field[] = {
 	{ "layout.bare", get_layout_bare },
 	{ "layout.shallow", get_layout_shallow },
 	{ "object.format", get_object_format },
+	{ "path.commondir.absolute", get_path_commondir_absolute },
+	{ "path.commondir.relative", get_path_commondir_relative },
 	{ "references.format", get_references_format },
 };
 
diff --git a/t/t1900-repo-info.sh b/t/t1900-repo-info.sh
index 39bb77dda0..0c0228687f 100755
--- a/t/t1900-repo-info.sh
+++ b/t/t1900-repo-info.sh
@@ -155,4 +155,65 @@ test_expect_success 'git repo info -h shows only repo info usage' '
 	test_grep ! "git repo structure" actual
 '
 
+# Helper function to test path keys in both absolute and relative formats.
+# $1: label for the test
+# $2: field_name (e.g., commondir)
+# $3: unique repo name for isolation
+# $4: expect_absolute (suffix appended to repo root)
+# $5: expect_relative (the relative path string expected)
+# $6: init_command (extra setup like exporting env vars)
+test_repo_info_path () {
+	label=$1
+	field_name=$2
+	repo_name=$3
+	expect_absolute_suffix=$4
+	expect_relative=$5
+	init_command=$6
+
+	absolute_root="$repo_name-absolute"
+	relative_root="$repo_name-relative"
+
+	test_expect_success "setup: $label" '
+		git init "$absolute_root" &&
+		git init "$relative_root" &&
+		mkdir -p "$absolute_root/sub" "$relative_root/sub"
+	'
+
+	test_expect_success "absolute: $label" '
+		(
+			cd "$absolute_root/sub" &&
+			ROOT="$(test-tool path-utils real_path ..)" && export ROOT &&
+			eval "$init_command" &&
+			expect_path="$ROOT${expect_absolute_suffix:+/$expect_absolute_suffix}" &&
+			echo "path.$field_name.absolute=$expect_path" >expect &&
+			git repo info "path.$field_name.absolute" >actual &&
+			test_cmp expect actual
+		)
+	'
+
+	test_expect_success "relative: $label" '
+		(
+			cd "$relative_root/sub" &&
+			ROOT="$(test-tool path-utils real_path ..)" && export ROOT &&
+			eval "$init_command" &&
+			echo "path.$field_name.relative=$expect_relative" >expect &&
+			git repo info "path.$field_name.relative" >actual &&
+			test_cmp expect actual
+		)
+	'
+}
+
+test_repo_info_path 'commondir standard' 'commondir' 'commondir-std' \
+	'.git' '../.git'
+
+test_repo_info_path 'commondir with GIT_COMMON_DIR and GIT_DIR' 'commondir' \
+	'commondir-envs' 'custom-common' '../custom-common' \
+	'GIT_COMMON_DIR="$ROOT/custom-common" && export GIT_COMMON_DIR &&
+	 GIT_DIR="../.git" && export GIT_DIR &&
+	 git init --bare "$ROOT/custom-common"'
+
+test_repo_info_path 'commondir with only GIT_DIR' 'commondir' \
+	'commondir-only-gitdir' '.git' '../.git' \
+	'GIT_DIR="../.git" && export GIT_DIR'
+
 test_done
-- 
2.54.0
Previous: K JayatheerthNext: K Jayatheerth
Message 48 of 82 in “teach git repo info to handle path keys”
  1. K JayatheerthJun 1, 2026
  2. [GSoC][PATCH 1/4] path: add strbuf_add_path for formatting pathsK Jayatheerth, Jun 1, 2026
  3. [GSoC][PATCH 2/4] rev-parse: use strbuf_add_path for path formattingK Jayatheerth, Jun 1, 2026
  4. [GSoC][PATCH 3/4] repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 1, 2026
  5. [GSoC][PATCH 4/4] repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 1, 2026
  6. Lucas Seiki OshiroJun 1, 2026
  7. Lucas Seiki OshiroJun 1, 2026
  8. Lucas Seiki OshiroJun 1, 2026
  9. Lucas Seiki OshiroJun 1, 2026
  10. Lucas Seiki OshiroJun 1, 2026
  11. Junio C HamanoJun 1, 2026
  12. Junio C HamanoJun 1, 2026
  13. Phillip WoodJun 2, 2026
  14. Phillip WoodJun 2, 2026
  15. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 5, 2026
  16. 1/4 path: introduce format_path() for centralized path formattingK Jayatheerth, Jun 5, 2026
  17. 2/4 rev-parse: use format_path for path formattingK Jayatheerth, Jun 5, 2026
  18. 3/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 5, 2026
  19. 4/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 5, 2026
  20. Kristoffer HaugsbakkJun 5, 2026
  21. Lucas Seiki OshiroJun 5, 2026
  22. Lucas Seiki OshiroJun 8, 2026
  23. Justin ToblerJun 8, 2026
  24. Justin ToblerJun 8, 2026
  25. Justin ToblerJun 8, 2026
  26. Lucas Seiki OshiroJun 8, 2026
  27. Junio C HamanoJun 8, 2026
  28. Lucas Seiki OshiroJun 8, 2026
  29. K JayatheerthJun 9, 2026
  30. K JayatheerthJun 9, 2026
  31. K JayatheerthJun 9, 2026
  32. K JayatheerthJun 9, 2026
  33. K JayatheerthJun 9, 2026
  34. Justin ToblerJun 9, 2026
  35. K JayatheerthJun 10, 2026
  36. Lucas Seiki OshiroJun 10, 2026
  37. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 12, 2026
  38. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 12, 2026
  39. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 12, 2026
  40. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 12, 2026
  41. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 12, 2026
  42. Lucas Seiki OshiroJun 15, 2026
  43. Lucas Seiki OshiroJun 15, 2026
  44. Lucas Seiki OshiroJun 15, 2026
  45. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 15, 2026
  46. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 15, 2026
  47. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 15, 2026
  48. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 15, 2026
  49. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 15, 2026
  50. Justin ToblerJun 15, 2026
  51. Justin ToblerJun 15, 2026
  52. K JayatheerthJun 16, 2026
  53. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 16, 2026
  54. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 16, 2026
  55. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 16, 2026
  56. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 16, 2026
  57. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 16, 2026
  58. Phillip WoodJun 16, 2026
  59. Phillip WoodJun 16, 2026
  60. K JayatheerthJun 16, 2026
  61. Phillip WoodJun 16, 2026
  62. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 20, 2026
  63. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 20, 2026
  64. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 20, 2026
  65. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 20, 2026
  66. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 20, 2026
  67. Junio C HamanoJun 20, 2026
  68. K JayatheerthJun 20, 2026
  69. 0/3 teach git repo info to handle path keysK Jayatheerth, Jun 21, 2026
  70. 1/3 path: extract append_formatted_path() and use in rev-parseK Jayatheerth, Jun 21, 2026
  71. 2/3 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 21, 2026
  72. 3/3 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 21, 2026
  73. Junio C HamanoJun 21, 2026
  74. Junio C HamanoJun 22, 2026
  75. K JayatheerthJun 22, 2026
  76. Phillip WoodJun 23, 2026
  77. 0/3 teach git repo info to handle path keysK Jayatheerth, Jun 24, 2026
  78. 1/3 path: extract format_path() and use in rev-parseK Jayatheerth, Jun 24, 2026
  79. 2/3 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 24, 2026
  80. 3/3 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 24, 2026
  81. K JayatheerthJun 24, 2026
  82. Junio C HamanoJun 24, 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.