repo: add path.git-prefix

Scripts sometimes need the path from the repository's working tree root
to the current working directory. While this information can be derived
through existing Git commands, `git repo info` does not currently expose
it as a scriptable key.

Introduce the `path.git-prefix` key to `git repo info`. The key returns
the path from the working tree root to the current working directory,
returning the empty string when invoked from the working tree root.

Mentored-by: Justin Tobler <jltobler@gmail.com>
Mentored-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
Signed-off-by: K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
seen
K Jayatheerth 2026-08-25 23:28:17 +05:30 committed by Junio C Hamano
parent 84c231683e
commit 5a6afc2ec4
3 changed files with 39 additions and 0 deletions

View File

@ -113,6 +113,11 @@ values that they return:
The path to the Git repository's common directory relative to
the current working directory.

`path.git-prefix`::
The path from the root of the working tree to the current working
directory. Returns the empty string when the current working directory
is the root of the working tree.

`path.gitdir.absolute`::
The canonical absolute path to the Git repository directory (the `.git` directory).


View File

@ -100,6 +100,16 @@ static int get_path_commondir_relative(struct repository *repo, struct strbuf *b
return 0;
}

static int get_path_git_prefix(struct repository *repo, struct strbuf *buf)
{
/*
* repo->prefix is NULL when the current working directory is
* the worktree root.
*/
strbuf_addstr(buf, repo->prefix ? repo->prefix : "");
return 0;
}

static int get_path_gitdir_absolute(struct repository *repo, struct strbuf *buf)
{
const char *git_dir = repo_get_git_dir(repo);
@ -250,6 +260,7 @@ static const struct repo_info_field repo_info_field[] = {
{ "object.format", get_object_format },
{ "path.commondir.absolute", get_path_commondir_absolute },
{ "path.commondir.relative", get_path_commondir_relative },
{ "path.git-prefix", get_path_git_prefix },
{ "path.gitdir.absolute", get_path_gitdir_absolute },
{ "path.gitdir.relative", get_path_gitdir_relative },
{ "path.grafts.absolute", get_path_grafts_absolute },

View File

@ -215,6 +215,29 @@ test_repo_info_path 'commondir with only GIT_DIR' 'commondir' \
'.git' \
'GIT_DIR="../.git" && export GIT_DIR'

test_expect_success 'path.git-prefix at repository root' '
test_when_finished "rm -rf repo" &&
git init repo &&
(
cd repo &&
echo "path.git-prefix=" >expect &&
git repo info path.git-prefix >actual &&
test_cmp expect actual
)
'

test_expect_success 'path.git-prefix in subdirectory' '
test_when_finished "rm -rf repo" &&
git init repo &&
mkdir -p repo/sub/dir &&
(
cd repo/sub/dir &&
echo "path.git-prefix=sub/dir/" >expect &&
git repo info path.git-prefix >actual &&
test_cmp expect actual
)
'

test_repo_info_path 'gitdir standard' 'gitdir' '.git'

test_repo_info_path 'gitdir with explicit GIT_DIR' 'gitdir' \