From: "Martin Ågren" <martin.agren@gmail.com>
To: "秃头灯笼鱼 via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, 秃头灯笼鱼 <ttdlyu@163.com>
Subject: Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description
Date: Thu, 11 Apr 2024 12:39:59 +0200 [thread overview]
Message-ID: <CAN0heSpvKFKVnyve0wvcVJ3gvm5H8OggVTKpz2Se4je3iRHwCw@mail.gmail.com> (raw)
In-Reply-To: <28a5625f32cca6ef134a385fe9ba66962c40100f.1712822221.git.gitgitgadget@gmail.com>
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
next prev parent reply other threads:[~2024-04-11 10:40 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAN0heSpvKFKVnyve0wvcVJ3gvm5H8OggVTKpz2Se4je3iRHwCw@mail.gmail.com \
--to=martin.agren@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=ttdlyu@163.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 read-only IMAP folder(s) and NNTP newsgroup(s).