Fix the inconsistency in the description of the namespace option's parameter #1669
Conversation
Welcome to GitGitGadgetHi @ttdly, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests. Please make sure that your Pull Request has a good description, as it will be used as cover letter. You can CC potential reviewers by adding a footer to the PR description with the following syntax: 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 [email protected], 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, |
|
There are issues in commit 39cf63f: |
ttdly
changed the title
|
/allow |
|
User ttdly is now allowed to use GitGitGadget. |
|
/submit |
|
There are issues in commit 39cf63f: |
Signed-off-by: 秃头灯笼鱼 <[email protected]>
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
Signed-off-by: 秃头灯笼鱼 <[email protected]>
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
![gitgitgadget-git[bot]](https://avatars.githubusercontent.com/in/46807?s=60&v=4){kind=small}
| @@ -12,7 +12,7 @@ SYNOPSIS | |||
| 'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>] | |||
There was a problem hiding this comment.
On the Git mailing list, Martin Ågren wrote (reply to this):
On Thu, 11 Apr 2024 at 10:20, 秃头灯笼鱼 via GitGitGadget
<[email protected]> wrote:
>
> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
> <[email protected]>
>
> Signed-off-by: 秃头灯笼鱼 <[email protected]>
> - [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
> + [--git-dir=<path>] [--work-tree=<path>] [--namespace=<path>]
This makes it consistent with the instance later in the document, where
it already says "--namespace=<path>". Ok.
However, this is documented as "equivalent to setting the GIT_NAMESPACE
environment variable". And gitnamespaces(7) says
"GIT_NAMESPACE=<namespace>", so that is still inconsistent. I also see
this:
Note that namespaces which include a / will expand to a hierarchy of
namespaces; for example, GIT_NAMESPACE=foo/bar will store refs under
refs/namespaces/foo/refs/namespaces/bar/
So foo/bar isn't a file path. gitnamespaces(7) uses "path", "namespace"
and "namespace path" sort of interchangeably. Even so, I think it could
be a good idea to avoid "path" since it could give the wrong kind of
ideas.
I wonder if this patch should instead change both --namespace=<name> and
--namespace=<path> to --namespace=<namespace> and give some motivation
such as "Make the placeholder consistent with the gitnamespaces
document." What do you think?
MartinThere was a problem hiding this comment.
On the Git mailing list, Junio C Hamano wrote (reply to this):
Martin Ågren <[email protected]> writes:
> I wonder if this patch should instead change both --namespace=<name> and
> --namespace=<path> to --namespace=<namespace> and give some motivation
> such as "Make the placeholder consistent with the gitnamespaces
> document." What do you think?
Sounds sensible to me.
There was a problem hiding this comment.
That makes sense. I think what you said is very reasonable, and I hadn’t considered it thoroughly.
I've recently been working on the Chinese translation of the gitmanpages, and when I came across this inconsistency, I discussed it with the maintainers of the git-manpages-l10n repository. Clearly, neither of us had considered the description in gitnamespaces(7).
Thank you for your reply. If possible, could you please correct the description in git.txt? I am not very familiar with the process of submitting patches.
Yu Jian
There was a problem hiding this comment.
On the Git mailing list, ttdlyu wrote (reply to this):
That makes sense. I think what you said is very reasonable, and I hadn’t considered it thoroughly.
I've recently been working on the Chinese translation of the gitmanpages, and when I came across this inconsistency, I discussed it with the maintainers of the git-manpages-l10n repository. Clearly, neither of us had considered the description in gitnamespaces(7).
And thank you for your reply. If possible, could you please correct the description in git.txt? I am not very familiar with the process of submitting patches.
Yu Jian
(I'm not sure if you've seen the message on GitHub, so I'm sending you an email specifically. I apologize if I'm bothering you.)
At 2024-04-11 18:39:59, "Martin Ågren" <[email protected]> wrote:
>On Thu, 11 Apr 2024 at 10:20, 秃头灯笼鱼 via GitGitGadget
><[email protected]> wrote:
>>
>> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
>> <[email protected]>
>>
>> Signed-off-by: 秃头灯笼鱼 <[email protected]>
>
>> - [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
>> + [--git-dir=<path>] [--work-tree=<path>] [--namespace=<path>]
>
>This makes it consistent with the instance later in the document, where
>it already says "--namespace=<path>". Ok.
>
>However, this is documented as "equivalent to setting the GIT_NAMESPACE
>environment variable". And gitnamespaces(7) says
>"GIT_NAMESPACE=<namespace>", so that is still inconsistent. I also see
>this:
>
> Note that namespaces which include a / will expand to a hierarchy of
> namespaces; for example, GIT_NAMESPACE=foo/bar will store refs under
> refs/namespaces/foo/refs/namespaces/bar/
>
>So foo/bar isn't a file path. gitnamespaces(7) uses "path", "namespace"
>and "namespace path" sort of interchangeably. Even so, I think it could
>be a good idea to avoid "path" since it could give the wrong kind of
>ideas.
>
>I wonder if this patch should instead change both --namespace=<name> and
>--namespace=<path> to --namespace=<namespace> and give some motivation
>such as "Make the placeholder consistent with the gitnamespaces
>document." What do you think?
>
>Martin
|
User |
| @@ -342,7 +342,7 @@ Repository, command and file interfaces | |||
| --------------------------------------- | |||
There was a problem hiding this comment.
On the Git mailing list, Junio C Hamano wrote (reply to this):
"秃头灯笼鱼 via GitGitGadget" <[email protected]> writes:
> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
> <[email protected]>
>
> Signed-off-by: 秃头灯笼鱼 <[email protected]>
Have you followed Documentation/SubmittingPatches document,
especially the part marked with [[real-name]]?
Just double checking.There was a problem hiding this comment.
Sorry, I didn’t notice this document before. I will take a careful look at it later.
There was a problem hiding this comment.
Sorry, I didn’t notice this document before. I will take a careful look at it later.
Please reply on the list, otherwise Junio won't see your reply. (Follow the "reply to this" link in this comment to find out more.)
There was a problem hiding this comment.
Sorry, I didn’t notice this document before. I will take a careful look at it later.
Please reply on the list, otherwise Junio won't see your reply. (Follow the "reply to this" link in this comment to find out more.)
Thank you for the reminder. I'm having issues with my email account today and am unable to log in using a third-party client. I will try to reply to this message tomorrow.
There was a problem hiding this comment.
If you have a way to import mbox files into your email account, that's another option. For example, appending /raw to https://lore.kernel.org/git/[email protected]/ (like so) will give you that mbox file with all the information your mail program should require to reply.
There was a problem hiding this comment.
Thank you for your reply. I have replied to that message via Thunderbird, and I hope Junio can receive it.
There was a problem hiding this comment.
I do not yet see it here: https://lore.kernel.org/git/[email protected]/. Sometimes mails get delayed, but it could also be the very, very common issue that the Git mailing list silently drops HTML mails! So unless you have configured your Thunderbird to send plain-text-only mails, it might have fallen prey to this issue. Git has a section on configuring Thunderbird that might, or might not, be totally outdated.
There was a problem hiding this comment.
On the Git mailing list, ttdlyu wrote (reply to this):
Sorry, to be honest, I haven’t read this document carefully before, I
will find time to read it carefully.
I sent several emails previously using Thunderbird, and I'm not sure if you have received them.
However, I didn't see the emails I sent at
https://lore.kernel.org/git/af548abd00485e161c2e409b0b9fa80a3a061cc8.1712822221.git.gitgitgadget@gmail.com/.
Now I have switched to a different email client, and I hope you will receive this email.
在 2024-04-12 02:11:11，"Junio C Hamano" <[email protected]> 写道：
>"秃头灯笼鱼 via GitGitGadget" <[email protected]> writes:
>
>> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
>> <[email protected]>
>>
>> Signed-off-by: 秃头灯笼鱼 <[email protected]>
>
>Have you followed Documentation/SubmittingPatches document,
>especially the part marked with [[real-name]]?
>
>Just double checking.There was a problem hiding this comment.
I do not yet see it here: https://lore.kernel.org/git/[email protected]/. Sometimes mails get delayed, but it could also be the very, very common issue that the Git mailing list silently drops HTML mails! So unless you have configured your Thunderbird to send plain-text-only mails, it might have fallen prey to this issue. Git has a section on configuring Thunderbird that might, or might not, be totally outdated.
It seems I've succeeded. Do I need to reply to Martin Ågren via email again?
There was a problem hiding this comment.
On the Git mailing list, Junio C Hamano wrote (reply to this):
ttdlyu <[email protected]> writes:
> Sorry, to be honest, I haven’t read this document carefully before, I
> will find time to read it carefully.
Thanks.
Since the parameter of the
--namespaceoption can contain path separators\and can be correctly parsed, I believe that--namespace=<name>in the SYNOPSIS section should be changed to--namespace=<path>to match the description in the OPTIONS section.cc: Martin Ågren [email protected]