repo: add paths.git_dir to 'git repo info'#2242
repo: add paths.git_dir to 'git repo info'#2242jayesh0104 wants to merge 1 commit intogit:masterfrom
Conversation
Welcome to GitGitGadgetHi @jayesh0104, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests. Please make sure that either:
You can CC potential reviewers by adding a footer to the PR description with the following syntax: NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description, Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:
It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code. Contributing the patchesBefore you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form Both the person who commented An alternative is the channel Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment If you want to see what email(s) would be sent for a After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail). If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the curl -g --user "<EMailAddress>:<Password>" \
--url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txtTo iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description): To send a new iteration, just add another PR comment with the contents: Need help?New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join. You may also be able to find help in real time in the developer IRC channel, |
|
Invalid author email in e2accc1: "86013121+jayesh0104@users.noreply.github.com" |
|
Invalid author email in 6963ae0: "86013121+jayesh0104@users.noreply.github.com" |
|
Invalid author email in f07605e: "86013121+jayesh0104@users.noreply.github.com" |
|
There are issues in commit f80434e:
|
|
There is an issue in commit d373fd9:
|
|
There is an issue in commit c71df10:
|
leuasseurfarrelds247-arch
left a comment
There was a problem hiding this comment.
064fe7f3312418007dea2b49a19844a9ee378f49
|
/preview |
|
Error: User jayesh0104 is not yet permitted to use GitGitGadget |
Please read the instructions carefully. This Cc: list goes into the PR description, not just a random PR comment anywhere in the PR. |
Thanks for the clarification , got it. I’ve updated the PR description to include the Cc: list in the correct place instead of adding it as a separate comment. Please let me know if anything else needs adjustment. |
|
@jayesh0104 also, if you want to avoid being yelled at by the Git maintainer, you will want to reconsider those commit messages. Have a look around via You definitly will want to follow the guidance in https://github.blog/2022-06-30-write-better-commits-build-better-projects/ to improve it, in particular with a strong focus on this part:
|
|
Finally, the changes of those three commits seem to belong into a single commit. You will want to squash them into a single one as described here. |
Introduce a new repo info key `paths.git_dir` to expose the repository's gitdir path, equivalent to `git rev-parse --git-dir`. This improves consistency and allows tools to retrieve the gitdir path without invoking external commands. The implementation adds support in repo.c and integrates it into the repo info reporting mechanism. Documentation is updated to describe the new key, and tests are added to verify that the value matches the output of `git rev-parse --git-dir`. Signed-off-by: jayesh0104 <jayeshdaga99@gmail.com>
Thanks for pointing this out, I understand the issue now. I’ll rework the commit messages to follow Git’s conventions, including adding proper structure and the required Signed-off-by: trailer. I’ll also review git log examples and update the messages to clearly explain both the what and the why, as suggested. I’ll push an updated version shortly. |
|
/allow |
|
Error: User jayesh0104 is not yet permitted to use GitGitGadget |
|
/submit |
|
User jayesh0104 is now allowed to use GitGitGadget. WARNING: jayesh0104 has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use. |
|
Submitted as pull.2242.git.git.1773766519857.gitgitgadget@gmail.com To fetch this version into To fetch this version to local tag |
|
@jayesh0104 you will want to learn some patience, otherwise this will not be the best of experiences you'll get in your life. If you |
|
Karthik Nayak wrote on the Git mailing list (how to reply to this email): "Jayesh Daga via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: jayesh0104 <jayeshdaga99@gmail.com>
>
> Introduce a new repo info key `paths.git_dir` to expose the
> repository's gitdir path, equivalent to `git rev-parse --git-dir`.
>
> This improves consistency and allows tools to retrieve the gitdir
> path without invoking external commands.
>
> The implementation adds support in repo.c and integrates it into
> the repo info reporting mechanism. Documentation is updated to
> describe the new key, and tests are added to verify that the value
> matches the output of `git rev-parse --git-dir`.
>
Hello Jayesh,
Seeing from the people CC'd I'm assuming that you're interested in
applying for the GSoC.
As such, we encourage GSoC contributors to work on micro-projects as
listed on our GSoC website and also to read the guidelines we've laid
out [1] [2].
I would also mention that we do not recommend getting started on a
project, unless you're selected.
Now specifically for this project, there is still no decision made about
using relative paths vs absolute paths, I've highlighted this in one of
the candidates proposals [3]. I would suggest getting involved in that
discussion and coming to a conclusion before starting work on it.
[1]: https://git.github.io/General-Microproject-Information/
[2]: https://git.github.io/General-Application-Information/
[3]: https://lore.kernel.org/git/CAOLa=ZTtNSZ904v0-SN16jAis7gK4=MVj1g_5CGdbmaBopeZkg@mail.gmail.com/#t
Regards,
Karthik
[snip] |
|
Tian Yuchen wrote on the Git mailing list (how to reply to this email): Hi Jayesh,
On 3/18/26 00:55, Jayesh Daga via GitGitGadget wrote:
> From: jayesh0104 <jayeshdaga99@gmail.com>
> > Introduce a new repo info key `paths.git_dir` to expose the
> repository's gitdir path, equivalent to `git rev-parse --git-dir`.
Here you promise in the commit message that paths.git_dir and git rev-parse --git-dir are equivalent...
> > This improves consistency and allows tools to retrieve the gitdir
> path without invoking external commands.
> > The implementation adds support in repo.c and integrates it into
> the repo info reporting mechanism. Documentation is updated to
> describe the new key, and tests are added to verify that the value
> matches the output of `git rev-parse --git-dir`.
> > Signed-off-by: jayesh0104 <jayeshdaga99@gmail.com>
> ---
> repo: add paths.git_dir to 'git repo info'
> > Teach git repo info a new key, paths.git_dir, which reports the
> repository’s gitdir path (equivalent to git rev-parse --git-dir).
> > Documentation and tests are included.
> > Tests:
> > * make test T=t1900-repo-info.sh
> > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2242%2Fjayesh0104%2Fmaster-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2242/jayesh0104/master-v1
> Pull-Request: https://github.com/git/git/pull/2242
> > Documentation/git-repo.adoc | 5 +++++
> builtin/repo.c | 7 +++++++
> t/t1900-repo-info.sh | 10 ++++++++++
> 3 files changed, 22 insertions(+)
> > diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
> index 42262c1983..d17d911ec6 100644
> --- a/Documentation/git-repo.adoc
> +++ b/Documentation/git-repo.adoc
> @@ -95,6 +95,11 @@ In order to obtain a set of values from `git repo info`, you should provide
> the keys that identify them. Here's a list of the available keys and the
> values that they return:
> > +`paths.git_dir`::
> + The path to the Git directory for the repository (equivalent to
> + `git rev-parse --git-dir`).
> +
> +
> `layout.bare`::
> `true` if this is a bare repository, otherwise `false`.
> > diff --git a/builtin/repo.c b/builtin/repo.c
> index 55f9b9095c..3067107cad 100644
> --- a/builtin/repo.c
> +++ b/builtin/repo.c
> @@ -66,11 +66,18 @@ static int get_references_format(struct repository *repo, struct strbuf *buf)
> return 0;
> }
> ...
> +static int get_paths_git_dir(struct repository *repo, struct strbuf *buf)
> +{
> + strbuf_addstr(buf, repo_get_git_dir(repo));
> + return 0;
> +}
> +
...But your implementation here doesn't quite feel right. Check the git-rev-parse documentation: the output of the --git-dir argument is context-aware and depends on your current directory.
If you are in the root directory of the repository, it gives '.git'; And if you are in some subdirectory of the repository , it gives '/home/user/.../repo-root/.../.git'. I don't think simply calling 'repo_get_git_dir(repo)' will achieve this functionality.
> /* repo_info_field keys must be in lexicographical order */
> static const struct repo_info_field repo_info_field[] = {
> { "layout.bare", get_layout_bare },
> { "layout.shallow", get_layout_shallow },
> { "object.format", get_object_format },
> + { "paths.git_dir", get_paths_git_dir },
> { "references.format", get_references_format },
> };
> > diff --git a/t/t1900-repo-info.sh b/t/t1900-repo-info.sh
> index a9eb07abe8..63be0849c4 100755
> --- a/t/t1900-repo-info.sh
> +++ b/t/t1900-repo-info.sh
> @@ -149,4 +149,14 @@ test_expect_success 'git repo info --keys uses lines as its default output forma
> test_cmp expect actual
> '
> ...
> +test_expect_success 'paths.git_dir matches rev-parse --git-dir' '
> + git init repo &&
> + (
> + cd repo &&
> + git repo info paths.git_dir >actual &&
> + echo "paths.git_dir=$(git rev-parse --git-dir)" >expect &&
> + test_cmp expect actual
> + )
> +'
> +
> test_done
And you’ve only provided tests for the root directory here, which I don’t think is sufficient. That said, considering that you’ve likely misunderstood how to use the --git-dir parameter, this is understandable.
Next time you create a similar patch, I think you should take a close look at the documentation and source code first, and try using the existing commands a few times on your own to understand how they work, right? ;)
Regards,
Yuchen |
|
User |
|
Karthik Nayak wrote on the Git mailing list (how to reply to this email): "Jayesh Daga via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: jayesh0104 <jayeshdaga99@gmail.com>
>
> Introduce a new repo info key `paths.git_dir` to expose the
> repository's gitdir path, equivalent to `git rev-parse --git-dir`.
>
> This improves consistency and allows tools to retrieve the gitdir
> path without invoking external commands.
>
> The implementation adds support in repo.c and integrates it into
> the repo info reporting mechanism. Documentation is updated to
> describe the new key, and tests are added to verify that the value
> matches the output of `git rev-parse --git-dir`.
>
Hello Jayesh,
Seeing from the people CC'd I'm assuming that you're interested in
applying for the GSoC.
As such, we encourage GSoC contributors to work on micro-projects as
listed on our GSoC website and also to read the guidelines we've laid
out [1] [2].
I would also mention that we do not recommend getting started on a
project, unless you're selected.
Now specifically for this project, there is still no decision made about
using relative paths vs absolute paths, I've highlighted this in one of
the candidates proposals [3]. I would suggest getting involved in that
discussion and coming to a conclusion before starting work on it.
[1]: https://git.github.io/General-Microproject-Information/
[2]: https://git.github.io/General-Application-Information/
[3]: https://lore.kernel.org/git/CAOLa=ZTtNSZ904v0-SN16jAis7gK4=MVj1g_5CGdbmaBopeZkg@mail.gmail.com/#t
Regards,
Karthik
[snip] |
|
Tian Yuchen wrote on the Git mailing list (how to reply to this email): Hi Jayesh,
On 3/18/26 00:55, Jayesh Daga via GitGitGadget wrote:
> From: jayesh0104 <jayeshdaga99@gmail.com>
> > Introduce a new repo info key `paths.git_dir` to expose the
> repository's gitdir path, equivalent to `git rev-parse --git-dir`.
Here you promise in the commit message that paths.git_dir and git rev-parse --git-dir are equivalent...
> > This improves consistency and allows tools to retrieve the gitdir
> path without invoking external commands.
> > The implementation adds support in repo.c and integrates it into
> the repo info reporting mechanism. Documentation is updated to
> describe the new key, and tests are added to verify that the value
> matches the output of `git rev-parse --git-dir`.
> > Signed-off-by: jayesh0104 <jayeshdaga99@gmail.com>
> ---
> repo: add paths.git_dir to 'git repo info'
> > Teach git repo info a new key, paths.git_dir, which reports the
> repository’s gitdir path (equivalent to git rev-parse --git-dir).
> > Documentation and tests are included.
> > Tests:
> > * make test T=t1900-repo-info.sh
> > Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2242%2Fjayesh0104%2Fmaster-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2242/jayesh0104/master-v1
> Pull-Request: https://github.com/git/git/pull/2242
> > Documentation/git-repo.adoc | 5 +++++
> builtin/repo.c | 7 +++++++
> t/t1900-repo-info.sh | 10 ++++++++++
> 3 files changed, 22 insertions(+)
> > diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
> index 42262c1983..d17d911ec6 100644
> --- a/Documentation/git-repo.adoc
> +++ b/Documentation/git-repo.adoc
> @@ -95,6 +95,11 @@ In order to obtain a set of values from `git repo info`, you should provide
> the keys that identify them. Here's a list of the available keys and the
> values that they return:
> > +`paths.git_dir`::
> + The path to the Git directory for the repository (equivalent to
> + `git rev-parse --git-dir`).
> +
> +
> `layout.bare`::
> `true` if this is a bare repository, otherwise `false`.
> > diff --git a/builtin/repo.c b/builtin/repo.c
> index 55f9b9095c..3067107cad 100644
> --- a/builtin/repo.c
> +++ b/builtin/repo.c
> @@ -66,11 +66,18 @@ static int get_references_format(struct repository *repo, struct strbuf *buf)
> return 0;
> }
> ...
> +static int get_paths_git_dir(struct repository *repo, struct strbuf *buf)
> +{
> + strbuf_addstr(buf, repo_get_git_dir(repo));
> + return 0;
> +}
> +
...But your implementation here doesn't quite feel right. Check the git-rev-parse documentation: the output of the --git-dir argument is context-aware and depends on your current directory.
If you are in the root directory of the repository, it gives '.git'; And if you are in some subdirectory of the repository , it gives '/home/user/.../repo-root/.../.git'. I don't think simply calling 'repo_get_git_dir(repo)' will achieve this functionality.
> /* repo_info_field keys must be in lexicographical order */
> static const struct repo_info_field repo_info_field[] = {
> { "layout.bare", get_layout_bare },
> { "layout.shallow", get_layout_shallow },
> { "object.format", get_object_format },
> + { "paths.git_dir", get_paths_git_dir },
> { "references.format", get_references_format },
> };
> > diff --git a/t/t1900-repo-info.sh b/t/t1900-repo-info.sh
> index a9eb07abe8..63be0849c4 100755
> --- a/t/t1900-repo-info.sh
> +++ b/t/t1900-repo-info.sh
> @@ -149,4 +149,14 @@ test_expect_success 'git repo info --keys uses lines as its default output forma
> test_cmp expect actual
> '
> ...
> +test_expect_success 'paths.git_dir matches rev-parse --git-dir' '
> + git init repo &&
> + (
> + cd repo &&
> + git repo info paths.git_dir >actual &&
> + echo "paths.git_dir=$(git rev-parse --git-dir)" >expect &&
> + test_cmp expect actual
> + )
> +'
> +
> test_done
And you’ve only provided tests for the root directory here, which I don’t think is sufficient. That said, considering that you’ve likely misunderstood how to use the --git-dir parameter, this is understandable.
Next time you create a similar patch, I think you should take a close look at the documentation and source code first, and try using the existing commands a few times on your own to understand how they work, right? ;)
Regards,
Yuchen |
Teach
git repo infoa new key,paths.git_dir, which reports the repository’s gitdir path (equivalent togit rev-parse --git-dir).Documentation and tests are included.
Tests:
cc: Karthik Nayak karthik.188@gmail.com
cc: Justin Tobler jltobler@gmail.com
cc: Ayush Chandekar ayu.chandekar@gmail.com
cc: Siddharth Asthana siddharthasthana31@gmail.com
cc: Tian Yuchen a3205153416@gmail.com