{"thread":{"id":"60881","subject":"[PATCH] doc: git.txt-Fix inconsistency param description","startedAt":"2024-02-09T11:51:10Z","lastAt":"2024-04-16T06:02:28Z","messageCount":10,"participants":["秃头灯笼鱼 via GitGitGadget","Martin Ågren","Junio C Hamano","ttdlyu"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"488287","messageId":"pull.1669.git.git.1707479467028.gitgitgadget@gmail.com","threadId":"60881","inReplyTo":null,"subject":"[PATCH] doc: git.txt-Fix inconsistency param description","fromName":"秃头灯笼鱼 via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-02-09T11:51:06Z","receivedAt":"2024-02-09T11:51:10Z","isPatch":true,"sender":{"key":"name:秃头灯笼鱼","avatar":null},"body":"From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n \n\nSigned-off-by: 秃头灯笼鱼 \n---\n Fix the inconsistency in the description of the namespace option's\n parameter\n \n Since the parameter of the --namespace option can contain path\n separators \\ and can be correctly parsed, I believe that\n --namespace= in the SYNOPSIS section should be changed to\n --namespace= to match the description in the OPTIONS section.\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1669%2Fttdly%2Fdoc%2Fgit.txt-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1669/ttdly/doc/git.txt-v1\nPull-Request: https://github.com/git/git/pull/1669\n\n Documentation/git.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 0d25224c969..eee277495bd 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n 'git' [-v | --version] [-h | --help] [-C ] [-c =]\n [--exec-path[=]] [--html-path] [--man-path] [--info-path]\n [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]\n- [--git-dir=] [--work-tree=] [--namespace=]\n+ [--git-dir=] [--work-tree=] [--namespace=]\n [--config-env==] []\n \n DESCRIPTION\n\nbase-commit: 5216f8f5c4089ec29ce49afa147434c23e0f0163\n-- \ngitgitgadget\n"},{"id":"492757","messageId":"pull.1669.v2.git.git.1712822221.gitgitgadget@gmail.com","threadId":"60881","inReplyTo":"pull.1669.git.git.1707479467028.gitgitgadget@gmail.com","subject":"[PATCH v2 0/2] Fix the inconsistency in the description of the namespace option's parameter","fromName":"秃头灯笼鱼 via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-04-11T07:56:59Z","receivedAt":"2024-04-11T07:57:05Z","isPatch":true,"sender":{"key":"name:秃头灯笼鱼","avatar":null},"body":"Since the parameter of the --namespace option can contain path separators \\\nand can be correctly parsed, I believe that --namespace= in the\nSYNOPSIS section should be changed to --namespace= to match the\ndescription in the OPTIONS section.\n\n秃头灯笼鱼 (2):\n doc: git.txt-Fix inconsistency param description\n doc: git.txt-Change \"--user-formats\" to \"--user-interfaces\"\n\n Documentation/git.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\n\nbase-commit: 5216f8f5c4089ec29ce49afa147434c23e0f0163\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1669%2Fttdly%2Fdoc%2Fgit.txt-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1669/ttdly/doc/git.txt-v2\nPull-Request: https://github.com/git/git/pull/1669\n\nRange-diff vs v1:\n\n 1: 28a5625f32c = 1: 28a5625f32c doc: git.txt-Fix inconsistency param description\n -: ----------- > 2: af548abd004 doc: git.txt-Change \"--user-formats\" to \"--user-interfaces\"\n\n-- \ngitgitgadget\n"},{"id":"492758","messageId":"28a5625f32cca6ef134a385fe9ba66962c40100f.1712822221.git.gitgitgadget@gmail.com","threadId":"60881","inReplyTo":"pull.1669.v2.git.git.1712822221.gitgitgadget@gmail.com","subject":"[PATCH v2 1/2] doc: git.txt-Fix inconsistency param description","fromName":"秃头灯笼鱼 via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-04-11T07:57:00Z","receivedAt":"2024-04-11T07:57:05Z","isPatch":true,"sender":{"key":"name:秃头灯笼鱼","avatar":null},"body":"From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n \n\nSigned-off-by: 秃头灯笼鱼 \n---\n Documentation/git.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 0d25224c969..eee277495bd 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -12,7 +12,7 @@ SYNOPSIS\n 'git' [-v | --version] [-h | --help] [-C ] [-c =]\n [--exec-path[=]] [--html-path] [--man-path] [--info-path]\n [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]\n- [--git-dir=] [--work-tree=] [--namespace=]\n+ [--git-dir=] [--work-tree=] [--namespace=]\n [--config-env==] []\n \n DESCRIPTION\n-- \ngitgitgadget\n\n"},{"id":"492759","messageId":"af548abd00485e161c2e409b0b9fa80a3a061cc8.1712822221.git.gitgitgadget@gmail.com","threadId":"60881","inReplyTo":"pull.1669.v2.git.git.1712822221.gitgitgadget@gmail.com","subject":"[PATCH v2 2/2] doc: git.txt-Change \"--user-formats\" to \"--user-interfaces\"","fromName":"秃头灯笼鱼 via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-04-11T07:57:01Z","receivedAt":"2024-04-11T07:57:07Z","isPatch":true,"sender":{"key":"name:秃头灯笼鱼","avatar":null},"body":"From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n \n\nSigned-off-by: 秃头灯笼鱼 \n---\n Documentation/git.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex eee277495bd..2bd4b9f06ca 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -342,7 +342,7 @@ Repository, command and file interfaces\n ---------------------------------------\n \n This documentation discusses repository and command interfaces which\n-users are expected to interact with directly. See `--user-formats` in\n+users are expected to interact with directly. See `--user-interfaces` in\n linkgit:git-help[1] for more details on the criteria.\n \n include::cmds-userinterfaces.txt[]\n-- \ngitgitgadget\n"},{"id":"492781","messageId":"CAN0heSpvKFKVnyve0wvcVJ3gvm5H8OggVTKpz2Se4je3iRHwCw@mail.gmail.com","threadId":"60881","inReplyTo":"28a5625f32cca6ef134a385fe9ba66962c40100f.1712822221.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description","fromName":"Martin Ågren","fromEmail":"martin.agren@gmail.com","sentAt":"2024-04-11T10:39:59Z","receivedAt":"2024-04-11T10:40:11Z","isPatch":true,"sender":{"key":"martin.agren@gmail.com","avatar":null},"body":"On Thu, 11 Apr 2024 at 10:20, 秃头灯笼鱼 via GitGitGadget\n wrote:\n>\n> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n> \n>\n> Signed-off-by: 秃头灯笼鱼 \n\n> - [--git-dir=] [--work-tree=] [--namespace=]\n> + [--git-dir=] [--work-tree=] [--namespace=]\n\nThis makes it consistent with the instance later in the document, where\nit already says \"--namespace=\". Ok.\n\nHowever, this is documented as \"equivalent to setting the GIT_NAMESPACE\nenvironment variable\". And gitnamespaces(7) says\n\"GIT_NAMESPACE=\", so that is still inconsistent. I also see\nthis:\n\n Note that namespaces which include a / will expand to a hierarchy of\n namespaces; for example, GIT_NAMESPACE=foo/bar will store refs under\n refs/namespaces/foo/refs/namespaces/bar/\n\nSo foo/bar isn't a file path. gitnamespaces(7) uses \"path\", \"namespace\"\nand \"namespace path\" sort of interchangeably. Even so, I think it could\nbe a good idea to avoid \"path\" since it could give the wrong kind of\nideas.\n\nI wonder if this patch should instead change both --namespace= and\n--namespace= to --namespace= and give some motivation\nsuch as \"Make the placeholder consistent with the gitnamespaces\ndocument.\" What do you think?\n\nMartin\n"},{"id":"492789","messageId":"xmqqttk7u5yr.fsf@gitster.g","threadId":"60881","inReplyTo":"CAN0heSpvKFKVnyve0wvcVJ3gvm5H8OggVTKpz2Se4je3iRHwCw@mail.gmail.com","subject":"Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-04-11T18:09:16Z","receivedAt":"2024-04-11T18:09:25Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Martin Ågren writes:\n\n> I wonder if this patch should instead change both --namespace= and\n> --namespace= to --namespace= and give some motivation\n> such as \"Make the placeholder consistent with the gitnamespaces\n> document.\" What do you think?\n\nSounds sensible to me.\n\n"},{"id":"492790","messageId":"xmqqpluvu5vk.fsf@gitster.g","threadId":"60881","inReplyTo":"af548abd00485e161c2e409b0b9fa80a3a061cc8.1712822221.git.gitgitgadget@gmail.com","subject":"Re: [PATCH v2 2/2] doc: git.txt-Change \"--user-formats\" to \"--user-interfaces\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-04-11T18:11:11Z","receivedAt":"2024-04-11T18:11:13Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"秃头灯笼鱼 via GitGitGadget\" writes:\n\n> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n> \n>\n> Signed-off-by: 秃头灯笼鱼 \n\nHave you followed Documentation/SubmittingPatches document,\nespecially the part marked with [[real-name]]?\n\nJust double checking.\n"},{"id":"492919","messageId":"1bd1d875.c81.18eda82e0cb.Coremail.ttdlyu@163.com","threadId":"60881","inReplyTo":"xmqqpluvu5vk.fsf@gitster.g","subject":"Re:Re: [PATCH v2 2/2] doc: git.txt-Change \"--user-formats\" to \"--user-interfaces\"","fromName":"ttdlyu","fromEmail":"ttdlyu@163.com","sentAt":"2024-04-14T02:49:54Z","receivedAt":"2024-04-14T02:50:22Z","isPatch":true,"sender":{"key":"ttdlyu@163.com","avatar":null},"body":"Sorry, to be honest, I haven’t read this document carefully before, I \nwill find time to read it carefully.\n\nI sent several emails previously using Thunderbird, and I'm not sure if you have received them. \nHowever, I didn't see the emails I sent at \nhttps://lore.kernel.org/git/af548abd00485e161c2e409b0b9fa80a3a061cc8.1712822221.git.gitgitgadget@gmail.com/. \nNow I have switched to a different email client, and I hope you will receive this email.\n\n在 2024-04-12 02:11:11，\"Junio C Hamano\" 写道：\n>\"秃头灯笼鱼 via GitGitGadget\" writes:\n>\n>> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n>> \n>>\n>> Signed-off-by: 秃头灯笼鱼 \n>\n>Have you followed Documentation/SubmittingPatches document,\n>especially the part marked with [[real-name]]?\n>\n>Just double checking.\n"},{"id":"492952","messageId":"xmqqh6g2pn5f.fsf@gitster.g","threadId":"60881","inReplyTo":"1bd1d875.c81.18eda82e0cb.Coremail.ttdlyu@163.com","subject":"Re: [PATCH v2 2/2] doc: git.txt-Change \"--user-formats\" to \"--user-interfaces\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-04-15T17:10:36Z","receivedAt":"2024-04-15T17:13:08Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"ttdlyu writes:\n\n> Sorry, to be honest, I haven’t read this document carefully before, I \n> will find time to read it carefully.\n\nThanks.\n"},{"id":"492985","messageId":"2ee4f6e3.78c1.18ee57fda14.Coremail.ttdlyu@163.com","threadId":"60881","inReplyTo":"CAN0heSpvKFKVnyve0wvcVJ3gvm5H8OggVTKpz2Se4je3iRHwCw@mail.gmail.com","subject":"Re:Re: [PATCH v2 1/2] doc: git.txt-Fix inconsistency param description","fromName":"ttdlyu","fromEmail":"ttdlyu@163.com","sentAt":"2024-04-16T06:02:25Z","receivedAt":"2024-04-16T06:02:28Z","isPatch":true,"sender":{"key":"ttdlyu@163.com","avatar":null},"body":"\nThat makes sense. I think what you said is very reasonable, and I hadn’t considered it thoroughly.\n\n\nI'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).\n\n\nAnd 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.\n\n\nYu Jian\n\n(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.)\n\nAt 2024-04-11 18:39:59, \"Martin Ågren\" wrote:\n>On Thu, 11 Apr 2024 at 10:20, 秃头灯笼鱼 via GitGitGadget\n> wrote:\n>>\n>> From: =?UTF-8?q?=E7=A7=83=E5=A4=B4=E7=81=AF=E7=AC=BC=E9=B1=BC?=\n>> \n>>\n>> Signed-off-by: 秃头灯笼鱼 \n>\n>> - [--git-dir=] [--work-tree=] [--namespace=]\n>> + [--git-dir=] [--work-tree=] [--namespace=]\n>\n>This makes it consistent with the instance later in the document, where\n>it already says \"--namespace=\". Ok.\n>\n>However, this is documented as \"equivalent to setting the GIT_NAMESPACE\n>environment variable\". And gitnamespaces(7) says\n>\"GIT_NAMESPACE=\", so that is still inconsistent. I also see\n>this:\n>\n> Note that namespaces which include a / will expand to a hierarchy of\n> namespaces; for example, GIT_NAMESPACE=foo/bar will store refs under\n> refs/namespaces/foo/refs/namespaces/bar/\n>\n>So foo/bar isn't a file path. gitnamespaces(7) uses \"path\", \"namespace\"\n>and \"namespace path\" sort of interchangeably. Even so, I think it could\n>be a good idea to avoid \"path\" since it could give the wrong kind of\n>ideas.\n>\n>I wonder if this patch should instead change both --namespace= and\n>--namespace= to --namespace= and give some motivation\n>such as \"Make the placeholder consistent with the gitnamespaces\n>document.\" What do you think?\n>\n>Martin\n"}]}