{"thread":{"id":"46906","subject":"[PATCH] Documentation/git-config.txt: reword missleading sentence","startedAt":"2017-10-05T08:17:44Z","lastAt":"2017-10-19T04:58:53Z","messageCount":11,"participants":["PAYRE NATHAN p1508475","Junio C Hamano","Nathan PAYRE","second.payre@gmail.com","Moy Matthieu","Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"329727","messageId":"20171005081733.18529-1-nathan.payre@etu.univ-lyon1.fr","threadId":"46906","inReplyTo":null,"subject":"[PATCH] Documentation/git-config.txt: reword missleading sentence","fromName":"PAYRE NATHAN p1508475","fromEmail":"second.payre@gmail.com","sentAt":"2017-10-05T08:17:33Z","receivedAt":"2017-10-05T08:17:44Z","isPatch":true,"sender":{"key":"second.payre@gmail.com","avatar":null},"body":"Change the word \"bla\" to \"section.variable\" to make it clear that it's a placeholder for a variable name.\n\nSee discussion at: https://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n\nNoticed-by: rpjday@crashcourse.ca\n---\n Documentation/git-config.txt | 4 ++--\n 1 file changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 83f86b923..f9808d7ad 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -177,8 +177,8 @@ See also <>.\n \t'git-config' will expand leading '{tilde}' to the value of\n \t'$HOME', and '{tilde}user' to the home directory for the\n \tspecified user. This option has no effect when setting the\n-\tvalue (but you can use 'git config bla {tilde}/' from the\n-\tcommand line to let your shell do the expansion).\n+\tvalue (but you can use 'git config section.variable {tilde}/'\n+\tfrom the command line to let your shell do the expansion).\n \n -z::\n --null::\n-- \n2.14.2\n\n"},{"id":"329744","messageId":"CAPc5daVKM9PXYfKb3zMmCH3F8DeGcLHNtTCLDxMogOTH8uxWzg@mail.gmail.com","threadId":"46906","inReplyTo":"20171005081733.18529-1-nathan.payre@etu.univ-lyon1.fr","subject":"Re: [PATCH] Documentation/git-config.txt: reword missleading sentence","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-10-05T10:13:29Z","receivedAt":"2017-10-05T10:13:57Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"On Thu, Oct 5, 2017 at 5:17 PM, PAYRE NATHAN p1508475\n wrote:\n> Change the word \"bla\" to \"section.variable\" to make it clear that it's a placeholder for a variable name.\n\nPlease make sure that your log message shows without wrapping and is a\nconfortable read on a 80-column terminal by wrapping long lines.\n\n>\n> See discussion at: https://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n\nI do not think it matters that much in this particular case, but please\nmake it a habit to assume that time of people who run \"git log\" to\nfind out why the change was done is 100x more valuable than the\ntime you need to leave a good summary of the discussion in the\nlog message. A URL at the end _in addition to_ a summary in your\nwords is OK; just a URL without any effort to summarize why you\ndid this change is not.\n\nI often find myself understanding the issues a lot better _only_\nafter I try to summarize the argument for a change in the log\nmessage--it forces me to _think_. And (this probably does not\napply to this patch, as it is not a code change) it often results\nin a better code. First I come up with a solution, write a quick\npatch, try to explain the approach in the log message and then\nrealize there is a better solution _only_ after doing so. It is a\ngood habit to get into to try explaining the thought process in\nthe log message.\n\n> Noticed-by: rpjday@crashcourse.ca\n> ---\n\nHere, after \"Reported-by:\" before the three-dash line, we need\nyour \"Signed-off-by:\" line. See Documentation/SubmittingPatches\nfor details. The name and address should match what appears\non the \"From:\" field from your e-mail.\n\nAh, one more thing. Do you want to be known as somebody\nwith ALL CAPS first and last name, with student number? ;-)\nIf it is cumbersome to convince your MUA to use your real\nname spelled in normal way on the \"From:\" header, you could\nstart the body of your message with\n\n From: Payre Nathan \n\nfollowed by an empty line, followed by the body of the log\nmessage.\n\n\n> Documentation/git-config.txt | 4 ++--\n> 1 file changed, 2 insertions(+), 2 deletions(-)\n>\n> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\n> index 83f86b923..f9808d7ad 100644\n> --- a/Documentation/git-config.txt\n> +++ b/Documentation/git-config.txt\n> @@ -177,8 +177,8 @@ See also <>.\n> 'git-config' will expand leading '{tilde}' to the value of\n> '$HOME', and '{tilde}user' to the home directory for the\n> specified user. This option has no effect when setting the\n> - value (but you can use 'git config bla {tilde}/' from the\n> - command line to let your shell do the expansion).\n> + value (but you can use 'git config section.variable {tilde}/'\n> + from the command line to let your shell do the expansion).\n>\n\nThe new text proposed by the patch looks good.\n\nNote that I am not in front of a real computer, and I cannot\nverify if there is a whitespace breakage in the patch to make\nit unusable. I am guessing this one is OK (it seems there\nis only one SP followed by HT on the context lines).\n\nThanks, and welcome to Git development community.\n"},{"id":"330094","messageId":"CAGb4CBUaQJOskTiXm0w+3V7E8kkaA5EiG1w0s39WDCVH-5AVoA@mail.gmail.com","threadId":"46906","inReplyTo":"CAPc5daVKM9PXYfKb3zMmCH3F8DeGcLHNtTCLDxMogOTH8uxWzg@mail.gmail.com","subject":"Re: [PATCH] Documentation/git-config.txt: reword missleading sentence","fromName":"Nathan PAYRE","fromEmail":"second.payre@gmail.com","sentAt":"2017-10-10T08:19:59Z","receivedAt":"2017-10-10T08:20:06Z","isPatch":true,"sender":{"key":"second.payre@gmail.com","avatar":null},"body":"Hi,\n\nThanks you for the this complete answer,\nwe take note of your comments.\n\nWe would like to reword something else in the same line\nand we don't know what is the best way to do that properly.\nShould we do a [PATCH v2] or revert the last commit and\ncommit a new one?\n\n2017-10-05 12:13 GMT+02:00 Junio C Hamano :\n> On Thu, Oct 5, 2017 at 5:17 PM, PAYRE NATHAN p1508475\n> wrote:\n>> Change the word \"bla\" to \"section.variable\" to make it clear that it's a placeholder for a variable name.\n>\n> Please make sure that your log message shows without wrapping and is a\n> confortable read on a 80-column terminal by wrapping long lines.\n>\n>>\n>> See discussion at: https://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n>\n> I do not think it matters that much in this particular case, but please\n> make it a habit to assume that time of people who run \"git log\" to\n> find out why the change was done is 100x more valuable than the\n> time you need to leave a good summary of the discussion in the\n> log message. A URL at the end _in addition to_ a summary in your\n> words is OK; just a URL without any effort to summarize why you\n> did this change is not.\n>\n> I often find myself understanding the issues a lot better _only_\n> after I try to summarize the argument for a change in the log\n> message--it forces me to _think_. And (this probably does not\n> apply to this patch, as it is not a code change) it often results\n> in a better code. First I come up with a solution, write a quick\n> patch, try to explain the approach in the log message and then\n> realize there is a better solution _only_ after doing so. It is a\n> good habit to get into to try explaining the thought process in\n> the log message.\n>\n>> Noticed-by: rpjday@crashcourse.ca\n>> ---\n>\n> Here, after \"Reported-by:\" before the three-dash line, we need\n> your \"Signed-off-by:\" line. See Documentation/SubmittingPatches\n> for details. The name and address should match what appears\n> on the \"From:\" field from your e-mail.\n>\n> Ah, one more thing. Do you want to be known as somebody\n> with ALL CAPS first and last name, with student number? ;-)\n> If it is cumbersome to convince your MUA to use your real\n> name spelled in normal way on the \"From:\" header, you could\n> start the body of your message with\n>\n> From: Payre Nathan \n>\n> followed by an empty line, followed by the body of the log\n> message.\n>\n>\n>> Documentation/git-config.txt | 4 ++--\n>> 1 file changed, 2 insertions(+), 2 deletions(-)\n>>\n>> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\n>> index 83f86b923..f9808d7ad 100644\n>> --- a/Documentation/git-config.txt\n>> +++ b/Documentation/git-config.txt\n>> @@ -177,8 +177,8 @@ See also <>.\n>> 'git-config' will expand leading '{tilde}' to the value of\n>> '$HOME', and '{tilde}user' to the home directory for the\n>> specified user. This option has no effect when setting the\n>> - value (but you can use 'git config bla {tilde}/' from the\n>> - command line to let your shell do the expansion).\n>> + value (but you can use 'git config section.variable {tilde}/'\n>> + from the command line to let your shell do the expansion).\n>>\n>\n> The new text proposed by the patch looks good.\n>\n> Note that I am not in front of a real computer, and I cannot\n> verify if there is a whitespace breakage in the patch to make\n> it unusable. I am guessing this one is OK (it seems there\n> is only one SP followed by HT on the context lines).\n>\n> Thanks, and welcome to Git development community.\n"},{"id":"330097","messageId":"xmqqtvz7pewn.fsf@gitster.mtv.corp.google.com","threadId":"46906","inReplyTo":"CAGb4CBUaQJOskTiXm0w+3V7E8kkaA5EiG1w0s39WDCVH-5AVoA@mail.gmail.com","subject":"Re: [PATCH] Documentation/git-config.txt: reword missleading sentence","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-10-10T08:48:08Z","receivedAt":"2017-10-10T08:48:21Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Nathan PAYRE writes:\n\n> Thanks you for the this complete answer,\n> we take note of your comments.\n>\n> We would like to reword something else in the same line\n> and we don't know what is the best way to do that properly.\n> Should we do a [PATCH v2] or revert the last commit and\n> commit a new one?\n\nI'd imagine that it is in the same spirit of the old one\n(i.e. \"let's make it less confusing\"), so let's have a single patch\nthat has both changes which is [PATCH v2].\n\nThanks.\n\n\n"},{"id":"330254","messageId":"20171012091727.30759-1-second.payre@gmail.com","threadId":"46906","inReplyTo":"xmqqtvz7pewn.fsf@gitster.mtv.corp.google.com","subject":"[PATCH v2] Documentation/git-config.txt: reword missleading sentence","fromName":"","fromEmail":"second.payre@gmail.com","sentAt":"2017-10-12T09:17:27Z","receivedAt":"2017-10-12T09:17:58Z","isPatch":true,"sender":{"key":"second.payre@gmail.com","avatar":null},"body":"From: PAYRE NATHAN p1508475 \n\nChange the word \"bla\" to \"section.variable\", \"bla\" is a placeholder\nfor a variable name and it wasn't clear for everyone.\nThis change clarify it.\n\nChange the appearance of 'git config section.variable {tilde}/' to\n`git config section.variable {tilde}/` to harmonize it with\nthe rest of the file, this is a command line then the \"`\" are\nnecessary.\n\nReplace \"git-config\" by \"git config\" because the command\nis not \"git-config\".\n\nSee discussion at:\nhttps://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n\nSigned-off-by: MOY Matthieu \nSigned-off-by: Daniel Bensoussan \nSigned-off-by: Timothee Albertin \nSigned-off-by: Nathan Payre \nNoticed-by: rpjday@crashcourse.ca\n---\n Documentation/git-config.txt | 6 +++---\n 1 file changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 83f86b923..2ab9e4c56 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -174,11 +174,11 @@ See also <>.\n \teither --bool or --int, as described above.\n \n --path::\n-\t'git-config' will expand leading '{tilde}' to the value of\n+\t'git config' will expand leading '{tilde}' to the value of\n \t'$HOME', and '{tilde}user' to the home directory for the\n \tspecified user. This option has no effect when setting the\n-\tvalue (but you can use 'git config bla {tilde}/' from the\n-\tcommand line to let your shell do the expansion).\n+\tvalue (but you can use `git config section.variable {tilde}/`\n+\tfrom the command line to let your shell do the expansion).\n \n -z::\n --null::\n-- \n2.14.2\n\n"},{"id":"330322","messageId":"xmqqa80vyjyf.fsf@gitster.mtv.corp.google.com","threadId":"46906","inReplyTo":"20171012091727.30759-1-second.payre@gmail.com","subject":"Re: [PATCH v2] Documentation/git-config.txt: reword missleading sentence","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-10-13T00:23:20Z","receivedAt":"2017-10-13T00:23:27Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"second.payre@gmail.com writes:\n\n> From: PAYRE NATHAN p1508475 \n\nShould I assume that the name/address on the last Signed-off-by: we\nsee below is what you want to be known as? As a part of school\nwork, I'd imagine that Matthieu wants your work to be associated\nwith the univ-lyon1.fr address, so perhaps you want to go the other\nway around? It's not my place to decide between the two, but it is\nunusual to see that the name/address of the author (which is the\nabove line) does not match what is on the Signed-off-by: line.\n\n> Change the word \"bla\" to \"section.variable\", \"bla\" is a placeholder\n> for a variable name and it wasn't clear for everyone.\n> This change clarify it.\n>\n> Change the appearance of 'git config section.variable {tilde}/' to\n> `git config section.variable {tilde}/` to harmonize it with\n> the rest of the file, this is a command line then the \"`\" are\n> necessary.\n>\n> Replace \"git-config\" by \"git config\" because the command\n> is not \"git-config\".\n>\n> See discussion at:\n> https://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n>\n> Signed-off-by: MOY Matthieu \n> Signed-off-by: Daniel Bensoussan \n> Signed-off-by: Timothee Albertin \n> Signed-off-by: Nathan Payre \n> Noticed-by: rpjday@crashcourse.ca\n> ---\n> Documentation/git-config.txt | 6 +++---\n> 1 file changed, 3 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\n> index 83f86b923..2ab9e4c56 100644\n> --- a/Documentation/git-config.txt\n> +++ b/Documentation/git-config.txt\n> @@ -174,11 +174,11 @@ See also <>.\n> \teither --bool or --int, as described above.\n> \n> --path::\n> -\t'git-config' will expand leading '{tilde}' to the value of\n> +\t'git config' will expand leading '{tilde}' to the value of\n> \t'$HOME', and '{tilde}user' to the home directory for the\n> \tspecified user. This option has no effect when setting the\n> -\tvalue (but you can use 'git config bla {tilde}/' from the\n> -\tcommand line to let your shell do the expansion).\n> +\tvalue (but you can use `git config section.variable {tilde}/`\n\nDoes this reference to {tilde} get expanded inside the `literal`\nmark-up? In the description for 'gitdir', we find this passage (in\nDocumentation/config.txt):\n\n * If the pattern starts with `~/`, `~` will be substituted with the\n content of the environment variable `HOME`.\n\nSo I'd expect `~` to be a safe way to get what you want, not `{tilde}`.\n\n> +\tfrom the command line to let your shell do the expansion).\n> \n> -z::\n> --null::\n"},{"id":"330339","messageId":"q7h9infjmos9.fsf@orange.lip.ens-lyon.fr","threadId":"46906","inReplyTo":"xmqqa80vyjyf.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH v2] Documentation/git-config.txt: reword missleading sentence","fromName":"Moy Matthieu","fromEmail":"matthieu.moy@univ-lyon1.fr","sentAt":"2017-10-13T08:32:06Z","receivedAt":"2017-10-13T08:32:17Z","isPatch":true,"sender":{"key":"matthieu.moy@univ-lyon1.fr","avatar":"https://gravatar.com/avatar/8ab83b763226bd297b59ddd1463a8bfc852924577191233f73a953b86888fe0c?d=mp&s=160"},"body":"Junio C Hamano writes:\n\n> second.payre@gmail.com writes:\n>\n>> From: PAYRE NATHAN p1508475 \n>\n> Should I assume that the name/address on the last Signed-off-by: we\n> see below is what you want to be known as? As a part of school\n> work, I'd imagine that Matthieu wants your work to be associated\n> with the univ-lyon1.fr address, so perhaps you want to go the other\n> way around?\n\nYes, I'd rather have contributions made with the identity\n@etu.univ-lyon1.fr, and use the same identity for Signed-off-by: and\nFrom:.\n\n>> --path::\n>> -\t'git-config' will expand leading '{tilde}' to the value of\n>> +\t'git config' will expand leading '{tilde}' to the value of\n>> \t'$HOME', and '{tilde}user' to the home directory for the\n\nDidn't notice yesterday, but you still have forward quotes here and\nbackquotes right below. If you are to fix this paragraph, better fix all\nissues at once.\n\n>> \tspecified user. This option has no effect when setting the\n>> -\tvalue (but you can use 'git config bla {tilde}/' from the\n>> -\tcommand line to let your shell do the expansion).\n>> +\tvalue (but you can use `git config section.variable {tilde}/`\n>\n> Does this reference to {tilde} get expanded inside the `literal`\n> mark-up? In the description for 'gitdir', we find this passage (in\n> Documentation/config.txt):\n>\n> * If the pattern starts with `~/`, `~` will be substituted with the\n> content of the environment variable `HOME`.\n>\n> So I'd expect `~` to be a safe way to get what you want, not `{tilde}`.\n\nIf I read correctly, the potential issue with ~ is that it's used for\nsubscript text (i.e. foo~bar~ in asciidoc is LaTeX's $foo_{bar}$). But ~\nwithin a literal string should be safe, and at least we use it in many\nplaces in our doc.\n\nCheers,\n\n-- \nMatthieu Moy\nhttps://matthieu-moy.fr/\n"},{"id":"330347","messageId":"xmqqvajjuudo.fsf@gitster.mtv.corp.google.com","threadId":"46906","inReplyTo":"q7h9infjmos9.fsf@orange.lip.ens-lyon.fr","subject":"Re: [PATCH v2] Documentation/git-config.txt: reword missleading sentence","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-10-13T12:04:03Z","receivedAt":"2017-10-13T12:04:12Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Moy Matthieu writes:\n\n>>> --path::\n>>> -\t'git-config' will expand leading '{tilde}' to the value of\n>>> +\t'git config' will expand leading '{tilde}' to the value of\n>>> \t'$HOME', and '{tilde}user' to the home directory for the\n>\n> Didn't notice yesterday, but you still have forward quotes here and\n> backquotes right below. If you are to fix this paragraph, better fix all\n> issues at once.\n\nWhen we say ~user in this sentence, unlike $HOME, it is not\nsomething the user would type literally; 'user' in that is a\nplaceholder to be replaced with a value appropriate in the real\nlife, e.g. ~moy. So '{tilde}user' may actually be OK, even though I\nagree that `$HOME` may be more correct.\n\n>>> \tspecified user. This option has no effect when setting the\n>>> -\tvalue (but you can use 'git config bla {tilde}/' from the\n>>> -\tcommand line to let your shell do the expansion).\n>>> +\tvalue (but you can use `git config section.variable {tilde}/`\n>>\n>> Does this reference to {tilde} get expanded inside the `literal`\n>> mark-up? ...\n>\n> If I read correctly, the potential issue with ~ is that it's used for\n> subscript text (i.e. foo~bar~ in asciidoc is LaTeX's $foo_{bar}$). But ~\n> within a literal string should be safe, and at least we use it in many\n> places in our doc.\n\nMy comment was not about \"safety\" but about correctness. At least\nfor me, `{tilde}user` does not expand to ~user, but instead spell\nout open-brace, tee, eye, ..., close-brace, followed by \"user\",\nwhich is not what we want.\n"},{"id":"330611","messageId":"20171018202716.13313-1-nathan.payre@etu.univ-lyon1.fr","threadId":"46906","inReplyTo":"xmqqvajjuudo.fsf@gitster.mtv.corp.google.com","subject":"[PATCH v3] Documentation/git-config.txt: reword missleading sentence","fromName":"PAYRE NATHAN p1508475","fromEmail":"second.payre@gmail.com","sentAt":"2017-10-18T20:27:16Z","receivedAt":"2017-10-18T20:27:30Z","isPatch":true,"sender":{"key":"second.payre@gmail.com","avatar":null},"body":"Change the word \"bla\" to \"section.variable\", \"bla\" is a placeholder\nfor a variable name and it wasn't clear for everyone. This change\nclarify it.\n\nChange the appearance of 'git config section.variable {tilde}/' to\n`git config section.variable ~/` to harmonize it with the rest of the\nfile, this is a command line then the \"`\" are necessary.\n\nReplace \"git-config\" by \"git config\" because the command is not\n\"git-config\".\n\nSee discussion at:\nhttps://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n\nSigned-off-by: MOY Matthieu \nSigned-off-by: Daniel Bensoussan \nSigned-off-by: Timothee Albertin \nSigned-off-by: Nathan Payre \nNoticed-by: rpjday@crashcourse.ca\n---\n\nChange since v2: use ~ within backquote instead of {tilde}.\nBackquoting of 'git config', '~', '$HOME' and '~user' for more\ncoherence.\n\nDocumentation/git-config.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 83f86b923..9b5c3a436 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -174,11 +174,11 @@ See also <>.\n \teither --bool or --int, as described above.\n \n --path::\n-\t'git-config' will expand leading '{tilde}' to the value of\n-\t'$HOME', and '{tilde}user' to the home directory for the\n+\t`git config` will expand leading `~` to the value of\n+\t`$HOME`, and `~user` to the home directory for the\n \tspecified user. This option has no effect when setting the\n-\tvalue (but you can use 'git config bla {tilde}/' from the\n-\tcommand line to let your shell do the expansion).\n+\tvalue (but you can use `git config section.variable ~/`\n+\tfrom the command line to let your shell do the expansion).\n \n -z::\n --null::\n-- \n2.14.2\n\n"},{"id":"330614","messageId":"20171018220530.h6dgneq2dvhmwfeu@aiede.mtv.corp.google.com","threadId":"46906","inReplyTo":"20171018202716.13313-1-nathan.payre@etu.univ-lyon1.fr","subject":"Re: [PATCH v3] Documentation/git-config.txt: reword missleading sentence","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2017-10-18T22:12:48Z","receivedAt":"2017-10-18T22:14:39Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi Nathan et al,\n\nPAYRE NATHAN p1508475 wrote:\n\n> From: PAYRE NATHAN p1508475 \n\nnit: this 'From' line doesn't match any of the authors with sign-offs\nbelow. I'm wondering if the authorship of the commit (from \"git\ncommit --author\" or git's \"user.name\" / \"user.email\" settings) made it\nthrough in the email.\n\nIf you pass --from='PAYRE NATHAN p1508475 ' to\n\"git format-patch\", then it will send email from that address and add\nan in-body \"From:\" line to the message it produces based on the author\nfield of the git commits. This can be useful for sending patches that\nsomeone else wrote. This way, the authorship of the commit gets\nthrough, to be used by \"git am\".\n\nSee https://public-inbox.org/git/20170922203017.53986-7-git@jeffhostetler.com/\nfor an example of how that works.\n\n> Subject: Documentation/git-config.txt: reword missleading sentence\n\nmore nits:\n\n- this subject line can use a more concise name for the subsystem,\n like \"config doc\"\n\n- there's one too many esses in missleading\n\n- more importantly, this is a good place to provide a summary of what\n change the patch makes, so people reading the shortlog in Git\n release announcements know what changed. Maybe something like\n \"use a clearer placeholder in example\"?\n\nThat would mean something like\n\n\tconfig doc: use a clearer placeholder in example\n\nOr, to capture the other changes being made at the same time:\n\n\tconfig doc: clarify \"git config --path\" example\n\nThanks for working on this.\n\n> Change the word \"bla\" to \"section.variable\", \"bla\" is a placeholder\n> for a variable name and it wasn't clear for everyone. This change\n> clarify it.\n\nThe \",\" should be a semicolon or period, since it separates two\nindependent clauses.\n\nI think the \"This change clarify it\" sentence can go away. The first\nsentence already explains that this is for clarity.\n\n> Change the appearance of 'git config section.variable {tilde}/' to\n> `git config section.variable ~/` to harmonize it with the rest of the\n> file, this is a command line then the \"`\" are necessary.\n\nI had to read this sentence a few times to understand it. Maybe:\n\n\tWhile we're here, also reformat this sample command line to use\n\tmonospace instead of italics, to better match the rest of the file.\n\n> Replace \"git-config\" by \"git config\" because the command is not\n> \"git-config\".\n\nMy first reaction to that is, \"But the manpage is git-config(1)!\"\nTo avoid that reaction, it can say\n\n\tUse a space instead of a dash in \"git config\", as is common in the\n\trest of Git's documentation.\n\nBy the way, should the initial `git config` be 'git config' (in\nitalics instead of monospace)? I don't see `git config` anywhere else\nin the file and there are a lot of instances of 'git config'.\n\n> See discussion at:\n> https://public-inbox.org/git/20171002061303.Horde.SL92grZCqTRV9oQkBFPELQ7@crashcourse.ca/\n\nThe commit message is meant to be (and is, I think!) self-contained, so\nthis link shouldn't be needed for people running into this change in\n\"git log\". I'd leave it out.\n\n> Signed-off-by: MOY Matthieu \n> Signed-off-by: Daniel Bensoussan \n> Signed-off-by: Timothee Albertin \n> Signed-off-by: Nathan Payre \n> Noticed-by: rpjday@crashcourse.ca\n\noptional:\n\nReported-by: Robert P. J. Day \n\nThis can go before the sign-offs to reflect the chronology.\n\n[...]\n> --- a/Documentation/git-config.txt\n> +++ b/Documentation/git-config.txt\n> @@ -174,11 +174,11 @@ See also <>.\n> \teither --bool or --int, as described above.\n> \n> --path::\n> -\t'git-config' will expand leading '{tilde}' to the value of\n> +\t`git config` will expand leading `~` to the value of\n\nnot about this patch: the article \"a\" is missing before \"leading `~`\":\n\n\t'git config' will expand a leading `~` to the value of ...\n\n> -\t'$HOME', and '{tilde}user' to the home directory for the\n> +\t`$HOME`, and `~user` to the home directory for the\n> \tspecified user. This option has no effect when setting the\n> -\tvalue (but you can use 'git config bla {tilde}/' from the\n> -\tcommand line to let your shell do the expansion).\n> +\tvalue (but you can use `git config section.variable ~/`\n> +\tfrom the command line to let your shell do the expansion).\n\nI like it.\n\nThanks and hope that helps,\nJonathan\n"},{"id":"330620","messageId":"xmqqa80nka2k.fsf@gitster.mtv.corp.google.com","threadId":"46906","inReplyTo":"20171018220530.h6dgneq2dvhmwfeu@aiede.mtv.corp.google.com","subject":"Re: [PATCH v3] Documentation/git-config.txt: reword missleading sentence","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-10-19T04:58:43Z","receivedAt":"2017-10-19T04:58:53Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder writes:\n\n> Or, to capture the other changes being made at the same time:\n>\n> \tconfig doc: clarify \"git config --path\" example\n>\n> Thanks for working on this.\n\nYup. I'll queue with the above subject; all the suggestions in your\nmessage were sensible, so I'll take them when I do so.\n\n> By the way, should the initial `git config` be 'git config' (in\n> italics instead of monospace)? I don't see `git config` anywhere else\n> in the file and there are a lot of instances of 'git config'.\n\nWe want to use monospace for something we expect users to type\nverbatim while following the description along, and highlight\nimportant terms that are being explained by typesetting in italics.\nThis one can go either way, so I'll keep it as posted.\n\nThanks.\n\n\n"}]}