Show 418 quoted lines
> Changes since v7:
> - Dropped `path.grafts`.
> - In patch 2 (`submodule: use repository to find superproject`), moved the
> test for `--git-dir` to `t/t1500-rev-parse.sh` exercising the existing
> `rev-parse --show-superproject-working-tree` interface (since
> `path.superproject-root` is only added in patch 3), and ensured clean
> isolation of test directories (`sub` and `super`).
> - In patch 3 (`path.superproject-root`), simplified the getter functions
> by eliminating redundant early returns.
> - In patch 4 (`path.hooks`):
> - Special-cased `/dev/null` in both `path.hooks.absolute` and
> `path.hooks.relative` to output `/dev/null` directly, making it easy
> for scripts to detect when hooks are disabled. Documented this
> behavior in `Documentation/git-repo.adoc`.
> - Reverted changes to the `test_repo_info_path` helper in
> `t/t1900-repo-info.sh` and wrote a standalone test block for the
> `/dev/null` case.
> - Set `hooksPath = /dev/null` directly in the config file rather than
> passing it through `git config core.hooksPath /dev/null` to prevent
> MSYS2 argument mangling on Windows (which rewrites `/dev/null` to
> `nul`), allowing the test to run portably on all platforms without
> requiring `!MINGW`.
> - In patch 7 (`path.cdup`), removed unnecessary braces on the single-line
> `if`, added an early return when invoked outside a worktree, and ensured
> `cd repo` in the test runs within a subshell.
> > Thanks to Justin Tobler and Lucas Seiki Oshiro for their reviews and
> mentorship.
> > K Jayatheerth (7):
> repo: add path.toplevel with absolute and relative suffix formatting
> submodule: use repository to find superproject
> repo: add path.superproject-root with absolute and relative suffixes
> repo: add path.hooks with absolute and relative suffixes
> repo: add path.index with absolute and relative suffixes
> repo: add path.git-prefix
> repo: add path.cdup
> > Documentation/git-repo.adoc | 52 ++++++++++
> builtin/repo.c | 131 +++++++++++++++++++++++++
> builtin/rev-parse.c | 2 +-
> submodule.c | 43 +++++----
> submodule.h | 2 +-
> t/t1500-rev-parse.sh | 20 ++++
> t/t1900-repo-info.sh | 185 ++++++++++++++++++++++++++++++++++++
> 7 files changed, 412 insertions(+), 23 deletions(-)
> > Range-diff against v7:
> 5: 351b4b7de7 ! 1: 27b9811163 repo: add path.grafts with absolute and relative suffixes
> @@ Metadata
> Author: K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
> > ## Commit message ##
> - repo: add path.grafts with absolute and relative suffixes
> + repo: add path.toplevel with absolute and relative suffix formatting
> > - The repository grafts file specifies alternate parent relationships for
> - commits and may be used by repository tooling that needs to inspect or
> - manage grafts. Scripts currently retrieve its location by invoking
> - `git rev-parse --git-path info/grafts`.
> + Scripts frequently need to find the root directory of a repository's
> + working tree. Currently, this requires using `git rev-parse --show-toplevel`
> + or inferring it from other repository information.
> > - Introduce `path.grafts.absolute` and `path.grafts.relative` keys to
> - `git repo info`. This exposes the grafts file location as a scriptable
> - config-like key using standard format rules, allowing scripts to
> - retrieve it through the same interface as other repository path
> - information.
> + Introduce `path.toplevel.absolute` and `path.toplevel.relative` keys
> + to `git repo info`. This allows scripts to retrieve the top-level
> + working tree path in a predictable, strictly formatted manner without
> + relying on `rev-parse`.
> +
> + If requested in a bare repository where no working tree exists, the
> + command returns an empty string.
> > Mentored-by: Justin Tobler <jltobler@gmail.com>
> Mentored-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
> @@ Documentation/git-repo.adoc: values that they return:
> `path.gitdir.relative`::
> The path to the Git repository directory relative to the current working directory.
> > -+`path.grafts.absolute`::
> -+ The canonical absolute path to the repository's graft file.
> -+ Respects the `GIT_GRAFT_FILE` environment override. The path is
> -+ returned regardless of whether the file currently exists on disk.
> ++`path.toplevel.absolute`::
> ++ The canonical absolute path to the top-level directory of the
> ++ repository's working tree. Outputs an empty string if the repository
> ++ is bare.
> +
> -+`path.grafts.relative`::
> -+ The path to the repository's graft file relative to the current
> -+ working directory. Respects the `GIT_GRAFT_FILE` environment
> -+ override. The path is returned regardless of whether the file
> -+ currently exists on disk.
> ++`path.toplevel.relative`::
> ++ The path to the top-level directory of the repository's working
> ++ tree relative to the current working directory. Outputs an empty
> ++ string if the repository is bare.
> +
> - `path.hooks.absolute`::
> - The canonical absolute path to the repository's hooks directory.
> - Respects the `core.hooksPath` configuration. If `core.hooksPath` is
> + `references.format`::
> + The reference storage format. The valid values are:
> + +
> > ## builtin/repo.c ##
> @@ builtin/repo.c: static int get_path_gitdir_relative(struct repository *repo, struct strbuf *buf)
> return 0;
> }
> > -+static int get_path_grafts_absolute(struct repository *repo, struct strbuf *buf)
> ++static int get_path_toplevel_absolute(struct repository *repo, struct strbuf *buf)
> +{
> -+ const char *graft_file = repo_get_graft_file(repo);
> ++ const char *work_tree = repo_get_work_tree(repo);
> +
> -+ if (!graft_file)
> -+ return error(_("unable to get graft file"));
> ++ if (!work_tree)
> ++ return 0;
> +
> -+ format_path(buf, graft_file, "", PATH_FORMAT_CANONICAL);
> ++ format_path(buf, work_tree, "", PATH_FORMAT_CANONICAL);
> + return 0;
> +}
> +
> -+static int get_path_grafts_relative(struct repository *repo, struct strbuf *buf)
> ++static int get_path_toplevel_relative(struct repository *repo, struct strbuf *buf)
> +{
> -+ const char *graft_file = repo_get_graft_file(repo);
> ++ const char *work_tree = repo_get_work_tree(repo);
> +
> -+ if (!graft_file)
> -+ return error(_("unable to get graft file"));
> ++ if (!work_tree)
> ++ return 0;
> +
> -+ format_path(buf, graft_file, repo->prefix, PATH_FORMAT_RELATIVE);
> ++ format_path(buf, work_tree, repo->prefix, PATH_FORMAT_RELATIVE);
> + return 0;
> +}
> +
> - static int get_path_hooks_absolute(struct repository *repo, struct strbuf *buf)
> + static int get_references_format(struct repository *repo, struct strbuf *buf)
> {
> - struct strbuf hooks_path = STRBUF_INIT;
> + strbuf_addstr(buf,
> @@ builtin/repo.c: static const struct repo_info_field repo_info_field[] = {
> { "path.commondir.relative", get_path_commondir_relative },
> { "path.gitdir.absolute", get_path_gitdir_absolute },
> { "path.gitdir.relative", get_path_gitdir_relative },
> -+ { "path.grafts.absolute", get_path_grafts_absolute },
> -+ { "path.grafts.relative", get_path_grafts_relative },
> - { "path.hooks.absolute", get_path_hooks_absolute },
> - { "path.hooks.relative", get_path_hooks_relative },
> - { "path.index.absolute", get_path_index_absolute },
> ++ { "path.toplevel.absolute", get_path_toplevel_absolute },
> ++ { "path.toplevel.relative", get_path_toplevel_relative },
> + { "references.format", get_references_format },
> + };
> +
> > ## t/t1900-repo-info.sh ##
> @@ t/t1900-repo-info.sh: test_repo_info_path 'gitdir with explicit GIT_DIR' 'gitdir' \
> '.git' \
> 'GIT_DIR="../.git" && export GIT_DIR'
> > -+test_repo_info_path 'grafts standard' 'grafts' '.git/info/grafts'
> ++test_expect_success 'path.toplevel absolute and relative' '
> ++ test_when_finished "rm -rf repo" &&
> ++ git init repo &&
> ++ (
> ++ mkdir -p repo/sub &&
> ++ cd repo/sub &&
> +
> -+test_repo_info_path 'grafts with GIT_GRAFT_FILE override' 'grafts' \
> -+ 'custom-graft-file' \
> -+ 'GIT_GRAFT_FILE="$ROOT/custom-graft-file" && export GIT_GRAFT_FILE'
> ++ ROOT="$(test-tool path-utils real_path ..)" &&
> +
> - test_repo_info_path 'hooks standard' 'hooks' '.git/hooks'
> -
> - test_repo_info_path 'hooks with core.hooksPath override' 'hooks' \
> ++ echo "path.toplevel.absolute=$ROOT" >expect.abs &&
> ++ git repo info path.toplevel.absolute >actual.abs &&
> ++ test_cmp expect.abs actual.abs &&
> ++
> ++ echo "path.toplevel.relative=../" >expect.rel &&
> ++ git repo info path.toplevel.relative >actual.rel &&
> ++ test_cmp expect.rel actual.rel
> ++ )
> ++'
> ++
> ++test_expect_success 'path.toplevel absolute and relative in a bare repository' '
> ++ test_when_finished "rm -rf bare.git" &&
> ++ git init --bare bare.git &&
> ++ (
> ++ cd bare.git &&
> ++
> ++ echo "path.toplevel.absolute=" >expect.abs &&
> ++ git repo info path.toplevel.absolute >actual.abs &&
> ++ test_cmp expect.abs actual.abs &&
> ++
> ++ echo "path.toplevel.relative=" >expect.rel &&
> ++ git repo info path.toplevel.relative >actual.rel &&
> ++ test_cmp expect.rel actual.rel
> ++ )
> ++'
> ++
> + test_done
> 1: 7c90603a1b ! 2: 2274dd8be2 submodule: use repository to find superproject
> @@ submodule.h: void absorb_git_dir_into_superproject(const char *path,
> > #endif
> > - ## t/t7400-submodule-basic.sh ##
> -@@ t/t7400-submodule-basic.sh: test_expect_success 'submodule add fails when name is reused' '
> + ## t/t1500-rev-parse.sh ##
> +@@ t/t1500-rev-parse.sh: test_expect_success ':/ and HEAD^{/} favor more recent matching commits' '
> )
> '
> > -+test_expect_success 'path.superproject-root works with --git-dir' '
> ++test_expect_success '--show-superproject-working-tree works with --git-dir' '
> ++ rm -rf sub super &&
> + test_when_finished "rm -rf sub super" &&
> + git init sub &&
> + test_commit -C sub initial &&
> @@ t/t7400-submodule-basic.sh: test_expect_success 'submodule add fails when name i
> + SUPER_ROOT="$(test-tool path-utils real_path .)" &&
> + MODULE_DIR="$SUPER_ROOT/.git/modules/sub" &&
> +
> -+ echo "path.superproject-root.absolute=$SUPER_ROOT" >expect &&
> -+ git --git-dir="$MODULE_DIR" repo info path.superproject-root.absolute >actual &&
> ++ echo "$SUPER_ROOT" >expect &&
> ++ git --git-dir="$MODULE_DIR" rev-parse --show-superproject-working-tree >actual &&
> + test_cmp expect actual
> + )
> +'
> 2: 1bfb0c8c1d ! 3: 34c54cdafd repo: add path.superproject-root with absolute and relative suffixes
> @@ builtin/repo.c: static int get_path_gitdir_relative(struct repository *repo, str
> +{
> + struct strbuf superproject = STRBUF_INIT;
> +
> -+ if (!get_superproject_working_tree(repo, &superproject)) {
> -+ strbuf_release(&superproject);
> -+ return 0;
> -+ }
> ++ if (get_superproject_working_tree(repo, &superproject))
> ++ format_path(buf, superproject.buf, "", PATH_FORMAT_CANONICAL);
> +
> -+ format_path(buf, superproject.buf, "", PATH_FORMAT_CANONICAL);
> + strbuf_release(&superproject);
> + return 0;
> +}
> @@ builtin/repo.c: static int get_path_gitdir_relative(struct repository *repo, str
> +{
> + struct strbuf superproject = STRBUF_INIT;
> +
> -+ if (!get_superproject_working_tree(repo, &superproject)) {
> -+ strbuf_release(&superproject);
> -+ return 0;
> -+ }
> ++ if (get_superproject_working_tree(repo, &superproject))
> ++ format_path(buf, superproject.buf, repo->prefix, PATH_FORMAT_RELATIVE);
> +
> -+ format_path(buf, superproject.buf, repo->prefix, PATH_FORMAT_RELATIVE);
> + strbuf_release(&superproject);
> + return 0;
> +}
> 3: 09d2937fcd ! 4: 985403c7b3 repo: add path.hooks with absolute and relative suffixes
> @@ Documentation/git-repo.adoc: values that they return:
> +
> +`path.hooks.relative`::
> + The path to the repository's hooks directory relative to the current
> -+ working directory. Respects the `core.hooksPath` configuration.
> ++ working directory. Respects the `core.hooksPath` configuration. If
> ++ `core.hooksPath` is set to `/dev/null`, that value is returned unchanged.
> +
> `path.superproject-root.absolute`::
> The canonical absolute path to the working tree root of the superproject
> @@ builtin/repo.c: static int get_path_gitdir_relative(struct repository *repo, str
> + struct strbuf hooks_path = STRBUF_INIT;
> +
> + repo_git_path_replace(repo, &hooks_path, "hooks");
> -+ format_path(buf, hooks_path.buf, "", PATH_FORMAT_CANONICAL);
> ++ if (!strcmp(hooks_path.buf, "/dev/null"))
> ++ strbuf_addstr(buf, "/dev/null");
> ++ else
> ++ format_path(buf, hooks_path.buf, "", PATH_FORMAT_CANONICAL);
> ++
> + strbuf_release(&hooks_path);
> + return 0;
> +}
> @@ builtin/repo.c: static int get_path_gitdir_relative(struct repository *repo, str
> + struct strbuf hooks_path = STRBUF_INIT;
> +
> + repo_git_path_replace(repo, &hooks_path, "hooks");
> -+ format_path(buf, hooks_path.buf, repo->prefix, PATH_FORMAT_RELATIVE);
> ++ if (!strcmp(hooks_path.buf, "/dev/null"))
> ++ strbuf_addstr(buf, "/dev/null");
> ++ else
> ++ format_path(buf, hooks_path.buf, repo->prefix, PATH_FORMAT_RELATIVE);
> ++
> + strbuf_release(&hooks_path);
> + return 0;
> +}
> @@ builtin/repo.c: static const struct repo_info_field repo_info_field[] = {
> { "path.toplevel.absolute", get_path_toplevel_absolute },
> > ## t/t1900-repo-info.sh ##
> -@@ t/t1900-repo-info.sh: test_repo_info_path () {
> - cd repo/sub &&
> - ROOT="$(test-tool path-utils real_path ..)" && export ROOT &&
> - eval "$init_command" &&
> -- echo "path.$field_name.absolute=$ROOT/$expected_dir" >expect &&
> -+ case "$expected_dir" in
> -+ /*) EXPECT_ABS="$expected_dir" ;;
> -+ *) EXPECT_ABS="$ROOT/$expected_dir" ;;
> -+ esac &&
> -+ echo "path.$field_name.absolute=$EXPECT_ABS" >expect &&
> - git repo info "path.$field_name.absolute" >actual &&
> - test_cmp expect actual
> - )
> -@@ t/t1900-repo-info.sh: test_repo_info_path () {
> - cd repo/sub &&
> - ROOT="$(test-tool path-utils real_path ..)" && export ROOT &&
> - eval "$init_command" &&
> -- echo "path.$field_name.relative=../$expected_dir" >expect &&
> -+ case "$expected_dir" in
> -+ /*) EXPECT_REL="$(test-tool path-utils relative_path "$expected_dir" "$PWD")" ;;
> -+ *) EXPECT_REL="../$expected_dir" ;;
> -+ esac &&
> -+ echo "path.$field_name.relative=$EXPECT_REL" >expect &&
> - git repo info "path.$field_name.relative" >actual &&
> - test_cmp expect actual
> - )
> @@ t/t1900-repo-info.sh: test_repo_info_path 'gitdir with explicit GIT_DIR' 'gitdir' \
> '.git' \
> 'GIT_DIR="../.git" && export GIT_DIR'
> @@ t/t1900-repo-info.sh: test_repo_info_path 'gitdir with explicit GIT_DIR' 'gitdir
> + 'custom-hooks' \
> + 'git config core.hooksPath "$ROOT/custom-hooks" && mkdir -p "$ROOT/custom-hooks"'
> +
> -+# /dev/null is not a real, canonicalizable filesystem path on Windows,
> -+# so path resolution for core.hooksPath=/dev/null cannot be expected to
> -+# produce a literal "/dev/null" the way it does on POSIX systems.
> -+if ! test_have_prereq MINGW
> -+then
> -+ test_repo_info_path 'hooks with core.hooksPath=/dev/null' 'hooks' \
> -+ '/dev/null' \
> -+ 'git config core.hooksPath /dev/null'
> -+fi
> ++test_expect_success 'hooks with core.hooksPath=/dev/null' '
> ++ test_when_finished "rm -rf repo" &&
> ++ git init repo &&
> ++ (
> ++ mkdir -p repo/sub &&
> ++ cd repo/sub &&
> ++ cat >>../.git/config <<-\EOF &&
> ++ [core]
> ++ hooksPath = /dev/null
> ++ EOF
> ++ echo "path.hooks.absolute=/dev/null" >expect.abs &&
> ++ echo "path.hooks.relative=/dev/null" >expect.rel &&
> ++ git repo info path.hooks.absolute >actual.abs &&
> ++ git repo info path.hooks.relative >actual.rel &&
> ++ test_cmp expect.abs actual.abs &&
> ++ test_cmp expect.rel actual.rel
> ++ )
> ++'
> +
> test_expect_success 'path.superproject-root absolute and relative' '
> test_when_finished "rm -rf sub super" &&
> 4: d0c186f150 ! 5: 486836ae52 repo: add path.index with absolute and relative suffixes
> @@ Commit message
> > ## Documentation/git-repo.adoc ##
> @@ Documentation/git-repo.adoc: values that they return:
> - The path to the repository's hooks directory relative to the current
> - working directory. Respects the `core.hooksPath` configuration.
> + working directory. Respects the `core.hooksPath` configuration. If
> + `core.hooksPath` is set to `/dev/null`, that value is returned unchanged.
> > +`path.index.absolute`::
> + The canonical absolute path to the repository's current index file.
> @@ builtin/repo.c: static const struct repo_info_field repo_info_field[] = {
> { "path.toplevel.absolute", get_path_toplevel_absolute },
> > ## t/t1900-repo-info.sh ##
> -@@ t/t1900-repo-info.sh: then
> - 'git config core.hooksPath /dev/null'
> - fi
> +@@ t/t1900-repo-info.sh: test_expect_success 'hooks with core.hooksPath=/dev/null' '
> + )
> + '
> > +test_repo_info_path 'index standard' 'index' '.git/index'
> +
> 6: ef69d4aa8c ! 6: 91a8dc3ab1 repo: add path.git-prefix
> @@ builtin/repo.c: static const struct repo_info_field repo_info_field[] = {
> + { "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 },
> + { "path.hooks.absolute", get_path_hooks_absolute },
> > ## t/t1900-repo-info.sh ##
> @@ t/t1900-repo-info.sh: test_repo_info_path 'commondir with only GIT_DIR' 'commondir' \
> 7: 3e61728dba ! 7: 84a9fb4060 repo: add path.cdup
> @@ builtin/repo.c: static int get_object_format(struct repository *repo, struct str
> + if (!is_inside_work_tree(repo)) {
> + const char *worktree = repo_get_work_tree(repo);
> +
> -+ if (worktree) {
> ++ if (worktree)
> + strbuf_addstr(buf, worktree);
> -+ }
> ++ return 0;
> + }
> +
> + while (pfx) {
> @@ t/t1900-repo-info.sh: test_repo_info_path 'commondir with only GIT_DIR' 'commond
> +test_expect_success 'path.cdup cwd outside the working tree' '
> + test_when_finished "rm -rf repo" &&
> + mkdir -p repo/tmp/x &&
> -+ cd repo &&
> -+ git init test &&
> + (
> -+ echo path.cdup=$(pwd)/tmp/x >./test/expect &&
> ++ cd repo &&
> ++ git init test &&
> ++ echo "path.cdup=$(pwd)/tmp/x" >test/expect &&
> + cd test &&
> + GIT_WORK_TREE=../tmp/x &&
> + export GIT_WORK_TREE &&