* [PATCH] doc: git.txt-Fix inconsistency param description
@ 2024-02-09 11:51 秃头灯笼鱼 via GitGitGadget
2024-04-11 7:56 ` [PATCH v2 0/2] Fix the inconsistency in the description of the namespace option's parameter 秃头灯笼鱼 via GitGitGadget
0 siblings, 1 reply; 10+ messages in thread
From: 秃头灯笼鱼 via GitGitGadget @ 2024-02-09 11:51 UTC (permalink / raw)
To: git
Cc: 秃头灯笼鱼,
秃头灯笼鱼
From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
<ttdlyu@163.com>
Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
---
Fix the inconsistency in the description of the namespace option's
parameter
Since the parameter of the --namespace option 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.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1669%2Fttdly%2Fdoc%2Fgit.txt-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1669/ttdly/doc/git.txt-v1
Pull-Request: https://github.com/git/git/pull/1669
Documentation/git.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 0d25224c969..eee277495bd 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -12,7 +12,7 @@ SYNOPSIS
'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
[-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
- [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
+ [--git-dir=<path>] [--work-tree=<path>] [--namespace=<path>]
[--config-env=<name>=<envvar>] <command> [<args>]
DESCRIPTION
base-commit: 5216f8f5c4089ec29ce49afa147434c23e0f0163
--
gitgitgadget
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v2 0/2] Fix the inconsistency in the description of the namespace option's parameter
2024-02-09 11:51 [PATCH] doc: git.txt-Fix inconsistency param description 秃头灯笼鱼 via GitGitGadget
@ 2024-04-11 7:56 ` 秃头灯笼鱼 via GitGitGadget
2024-04-11 7:57 ` [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description 秃头灯笼鱼 via GitGitGadget
2024-04-11 7:57 ` [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces" 秃头灯笼鱼 via GitGitGadget
0 siblings, 2 replies; 10+ messages in thread
From: 秃头灯笼鱼 via GitGitGadget @ 2024-04-11 7:56 UTC (permalink / raw)
To: git; +Cc: 秃头灯笼鱼
Since the parameter of the --namespace option 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.
秃头灯笼鱼 (2):
doc: git.txt-Fix inconsistency param description
doc: git.txt-Change "--user-formats" to "--user-interfaces"
Documentation/git.txt | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
base-commit: 5216f8f5c4089ec29ce49afa147434c23e0f0163
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1669%2Fttdly%2Fdoc%2Fgit.txt-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1669/ttdly/doc/git.txt-v2
Pull-Request: https://github.com/git/git/pull/1669
Range-diff vs v1:
1: 28a5625f32c = 1: 28a5625f32c doc: git.txt-Fix inconsistency param description
-: ----------- > 2: af548abd004 doc: git.txt-Change "--user-formats" to "--user-interfaces"
--
gitgitgadget
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description
2024-04-11 7:56 ` [PATCH v2 0/2] Fix the inconsistency in the description of the namespace option's parameter 秃头灯笼鱼 via GitGitGadget
@ 2024-04-11 7:57 ` 秃头灯笼鱼 via GitGitGadget
2024-04-11 10:39 ` Martin Ågren
2024-04-11 7:57 ` [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces" 秃头灯笼鱼 via GitGitGadget
1 sibling, 1 reply; 10+ messages in thread
From: 秃头灯笼鱼 via GitGitGadget @ 2024-04-11 7:57 UTC (permalink / raw)
To: git
Cc: 秃头灯笼鱼,
秃头灯笼鱼
From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
<ttdlyu@163.com>
Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
---
Documentation/git.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 0d25224c969..eee277495bd 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -12,7 +12,7 @@ SYNOPSIS
'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
[-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
- [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
+ [--git-dir=<path>] [--work-tree=<path>] [--namespace=<path>]
[--config-env=<name>=<envvar>] <command> [<args>]
DESCRIPTION
--
gitgitgadget
^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces"
2024-04-11 7:56 ` [PATCH v2 0/2] Fix the inconsistency in the description of the namespace option's parameter 秃头灯笼鱼 via GitGitGadget
2024-04-11 7:57 ` [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description 秃头灯笼鱼 via GitGitGadget
@ 2024-04-11 7:57 ` 秃头灯笼鱼 via GitGitGadget
2024-04-11 18:11 ` Junio C Hamano
1 sibling, 1 reply; 10+ messages in thread
From: 秃头灯笼鱼 via GitGitGadget @ 2024-04-11 7:57 UTC (permalink / raw)
To: git
Cc: 秃头灯笼鱼,
秃头灯笼鱼
From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
<ttdlyu@163.com>
Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
---
Documentation/git.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git.txt b/Documentation/git.txt
index eee277495bd..2bd4b9f06ca 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -342,7 +342,7 @@ Repository, command and file interfaces
---------------------------------------
This documentation discusses repository and command interfaces which
-users are expected to interact with directly. See `--user-formats` in
+users are expected to interact with directly. See `--user-interfaces` in
linkgit:git-help[1] for more details on the criteria.
include::cmds-userinterfaces.txt[]
--
gitgitgadget
^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description
2024-04-11 7:57 ` [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description 秃头灯笼鱼 via GitGitGadget
@ 2024-04-11 10:39 ` Martin Ågren
2024-04-11 18:09 ` Junio C Hamano
2024-04-16 6:02 ` ttdlyu
0 siblings, 2 replies; 10+ messages in thread
From: Martin Ågren @ 2024-04-11 10:39 UTC (permalink / raw)
To: 秃头灯笼鱼 via GitGitGadget
Cc: git, 秃头灯笼鱼
On Thu, 11 Apr 2024 at 10:20, 秃头灯笼鱼 via GitGitGadget
<gitgitgadget@gmail.com> wrote:
>
> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
> <ttdlyu@163.com>
>
> Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
> - [--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
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description
2024-04-11 10:39 ` Martin Ågren
@ 2024-04-11 18:09 ` Junio C Hamano
2024-04-16 6:02 ` ttdlyu
1 sibling, 0 replies; 10+ messages in thread
From: Junio C Hamano @ 2024-04-11 18:09 UTC (permalink / raw)
To: Martin Ågren
Cc: 秃头灯笼鱼 via GitGitGadget, git,
秃头灯笼鱼
Martin Ågren <martin.agren@gmail.com> 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.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces"
2024-04-11 7:57 ` [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces" 秃头灯笼鱼 via GitGitGadget
@ 2024-04-11 18:11 ` Junio C Hamano
2024-04-14 2:49 ` ttdlyu
0 siblings, 1 reply; 10+ messages in thread
From: Junio C Hamano @ 2024-04-11 18:11 UTC (permalink / raw)
To: 秃头灯笼鱼 via GitGitGadget
Cc: git, 秃头灯笼鱼
"秃头灯笼鱼 via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
> <ttdlyu@163.com>
>
> Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
Have you followed Documentation/SubmittingPatches document,
especially the part marked with [[real-name]]?
Just double checking.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re:Re: [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces"
2024-04-11 18:11 ` Junio C Hamano
@ 2024-04-14 2:49 ` ttdlyu
2024-04-15 17:10 ` Junio C Hamano
0 siblings, 1 reply; 10+ messages in thread
From: ttdlyu @ 2024-04-14 2:49 UTC (permalink / raw)
To: Junio C Hamano
Cc: 秃头灯笼鱼 via GitGitGadget, git
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" <gitster@pobox.com> 写道:
>"秃头灯笼鱼 via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
>> <ttdlyu@163.com>
>>
>> Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
>
>Have you followed Documentation/SubmittingPatches document,
>especially the part marked with [[real-name]]?
>
>Just double checking.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces"
2024-04-14 2:49 ` ttdlyu
@ 2024-04-15 17:10 ` Junio C Hamano
0 siblings, 0 replies; 10+ messages in thread
From: Junio C Hamano @ 2024-04-15 17:10 UTC (permalink / raw)
To: ttdlyu; +Cc: 秃头灯笼鱼 via GitGitGadget, git
ttdlyu <ttdlyu@163.com> writes:
> Sorry, to be honest, I haven’t read this document carefully before, I
> will find time to read it carefully.
Thanks.
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re:Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description
2024-04-11 10:39 ` Martin Ågren
2024-04-11 18:09 ` Junio C Hamano
@ 2024-04-16 6:02 ` ttdlyu
1 sibling, 0 replies; 10+ messages in thread
From: ttdlyu @ 2024-04-16 6:02 UTC (permalink / raw)
To: Martin Ågren
Cc: 秃头灯笼鱼 via GitGitGadget, git
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" <martin.agren@gmail.com> wrote:
>On Thu, 11 Apr 2024 at 10:20, 秃头灯笼鱼 via GitGitGadget
><gitgitgadget@gmail.com> wrote:
>>
>> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=
>> <ttdlyu@163.com>
>>
>> Signed-off-by: 秃头灯笼鱼 <ttdlyu@163.com>
>
>> - [--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
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2024-04-16 6:02 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-09 11:51 [PATCH] doc: git.txt-Fix inconsistency param description 秃头灯笼鱼 via GitGitGadget
2024-04-11 7:56 ` [PATCH v2 0/2] Fix the inconsistency in the description of the namespace option's parameter 秃头灯笼鱼 via GitGitGadget
2024-04-11 7:57 ` [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description 秃头灯笼鱼 via GitGitGadget
2024-04-11 10:39 ` Martin Ågren
2024-04-11 18:09 ` Junio C Hamano
2024-04-16 6:02 ` ttdlyu
2024-04-11 7:57 ` [PATCH v2 2/2] doc: git.txt-Change "--user-formats" to "--user-interfaces" 秃头灯笼鱼 via GitGitGadget
2024-04-11 18:11 ` Junio C Hamano
2024-04-14 2:49 ` ttdlyu
2024-04-15 17:10 ` Junio C Hamano
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).