kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

repo: add path.index with absolute and relative suffix formatting 

External script workflows and formatting layers require straightforward
access to the location of the index staging file. Currently, tracking
this necessitates a legacy call to `git rev-parse --git-path index` or
`--show-toplevel` logic abstractions.

Introduce `path.index.absolute` and `path.index.relative` keys to
`git repo info`. This allows tooling utilities to discover the active
index context cleanly while scaling transparently with localized
`GIT_INDEX_FILE` environment overrides.

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-07-17 19:00:13 +05:30 committed by Junio C Hamano
parent 97ceb64012
commit c99912d7c8
3 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/git-repo.adoc
View File

@ -127,6 +127,14 @@ values that they return:
The path to the repository's hooks directory relative to the current
working directory. Respects `core.hooksPath` configuration adjustments.

`path.index.absolute`::
The canonical absolute path to the repository's current index file.
Respects the `GIT_INDEX_FILE` environment override.

`path.index.relative`::
The path to the repository's current index file relative to the current
working directory. Respects the `GIT_INDEX_FILE` environment override.

`path.objects.absolute`::
The canonical absolute path to the repository's object database directory.
Respects the `GIT_OBJECT_DIRECTORY` environment override.

24
builtin/repo.c
View File

@ -142,6 +142,28 @@ static int get_path_hooks_relative(struct repository *repo, struct strbuf *buf)
return 0;
}

static int get_path_index_absolute(struct repository *repo, struct strbuf *buf)
{
const char *index_file = repo_get_index_file(repo);

if (!index_file)
return error(_("unable to get index file"));

format_path(buf, index_file, startup_info->prefix, PATH_FORMAT_CANONICAL);
return 0;
}

static int get_path_index_relative(struct repository *repo, struct strbuf *buf)
{
const char *index_file = repo_get_index_file(repo);

if (!index_file)
return error(_("unable to get index file"));

format_path(buf, index_file, startup_info->prefix, PATH_FORMAT_RELATIVE);
return 0;
}

static int get_path_objects_absolute(struct repository *repo, struct strbuf *buf)
{
const char *obj_dir = repo_get_object_directory(repo);
@ -238,6 +260,8 @@ static const struct repo_info_field repo_info_field[] = {
{ "path.gitdir.relative", get_path_gitdir_relative },
{ "path.hooks.absolute", get_path_hooks_absolute },
{ "path.hooks.relative", get_path_hooks_relative },
{ "path.index.absolute", get_path_index_absolute },
{ "path.index.relative", get_path_index_relative },
{ "path.objects.absolute", get_path_objects_absolute },
{ "path.objects.relative", get_path_objects_relative },
{ "path.superproject-working-tree.absolute", get_path_superproject_absolute },

6
t/t1900-repo-info.sh
View File

@ -219,6 +219,12 @@ test_repo_info_path 'hooks with core.hooksPath override' 'hooks' \
'custom-hooks' \
'git config core.hooksPath "$ROOT/custom-hooks" && mkdir -p "$ROOT/custom-hooks"'

test_repo_info_path 'index standard' 'index' '.git/index'

test_repo_info_path 'index with GIT_INDEX_FILE override' 'index' \
'custom-index-file' \
'GIT_INDEX_FILE="$ROOT/custom-index-file" && export GIT_INDEX_FILE'

test_repo_info_path 'objects standard' 'objects' '.git/objects'

test_repo_info_path 'objects with GIT_OBJECT_DIRECTORY override' 'objects' \