{"thread":{"id":"58001","subject":"[PATCH] config: correct log.showRoot description","startedAt":"2022-06-14T16:15:46Z","lastAt":"2022-06-15T01:50:41Z","messageCount":2,"participants":["Michael J Gruber","Taylor Blau"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"457201","messageId":"b7aa801c3995fffdce37d90adba9253485b616e3.1655223201.git.git@grubix.eu","threadId":"58001","inReplyTo":null,"subject":"[PATCH] config: correct log.showRoot description","fromName":"Michael J Gruber","fromEmail":"git@grubix.eu","sentAt":"2022-06-14T16:14:22Z","receivedAt":"2022-06-14T16:15:46Z","isPatch":true,"sender":{"key":"git@grubix.eu","avatar":"https://avatars.githubusercontent.com/u/233215?v=4"},"body":"The current description is misleading because it fits a \"default false\"\nsetting whereas the default is \"true\" (as mentioned).\n\nInstead, craft the wording in `config/log.txt` analogous to the one in\n`git-log.txt`.\n\nNote that the wording is not exactly the same, e.g. because\n`config/log.txt` wants to link to man pages and man pages want to refer\nto command options. Otherwise, includes would be the easy route to\nconsistency here.\n\nSigned-off-by: Michael J Gruber <git@grubix.eu>\n---\n Documentation/config/log.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/config/log.txt b/Documentation/config/log.txt\nindex 456eb07800..b210f24cca 100644\n--- a/Documentation/config/log.txt\n+++ b/Documentation/config/log.txt\n@@ -40,10 +40,10 @@ log.graphColors::\n \thistory lines in `git log --graph`.\n \n log.showRoot::\n-\tIf true, the initial commit will be shown as a big creation event.\n-\tThis is equivalent to a diff against an empty tree.\n-\tTools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which\n-\tnormally hide the root commit will now show it. True by default.\n+\tIf `false`, tools like linkgit:git-log[1] or linkgit:git-whatchanged[1]\n+\twill not treat the initial commit as a big creation event.  Any root\n+\tcommits in `git log -p` output would be shown without a diff attached.\n+\tThe default is `true`.\n \n log.showSignature::\n \tIf true, makes linkgit:git-log[1], linkgit:git-show[1], and\n-- \n2.37.0.rc0.107.g7a7be657e7\n\n"},{"id":"457238","messageId":"Yqk66CTVbX22Xi+e@nand.local","threadId":"58001","inReplyTo":"b7aa801c3995fffdce37d90adba9253485b616e3.1655223201.git.git@grubix.eu","subject":"Re: [PATCH] config: correct log.showRoot description","fromName":"Taylor Blau","fromEmail":"me@ttaylorr.com","sentAt":"2022-06-15T01:50:32Z","receivedAt":"2022-06-15T01:50:41Z","isPatch":true,"sender":{"key":"me@ttaylorr.com","avatar":"https://avatars.githubusercontent.com/u/301000140?v=4"},"body":"On Tue, Jun 14, 2022 at 06:14:22PM +0200, Michael J Gruber wrote:\n> diff --git a/Documentation/config/log.txt b/Documentation/config/log.txt\n> index 456eb07800..b210f24cca 100644\n> --- a/Documentation/config/log.txt\n> +++ b/Documentation/config/log.txt\n> @@ -40,10 +40,10 @@ log.graphColors::\n>  \thistory lines in `git log --graph`.\n>\n>  log.showRoot::\n> -\tIf true, the initial commit will be shown as a big creation event.\n> -\tThis is equivalent to a diff against an empty tree.\n> -\tTools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which\n> -\tnormally hide the root commit will now show it. True by default.\n> +\tIf `false`, tools like linkgit:git-log[1] or linkgit:git-whatchanged[1]\n> +\twill not treat the initial commit as a big creation event.  Any root\n> +\tcommits in `git log -p` output would be shown without a diff attached.\n> +\tThe default is `true`.\n\nThis looks good to me. An alternative approach which would work to would\nbe to replace \"If `true`\" with \"When `true`\". I have a vague preference\ntowards the latter, since it explains what log.showRoot does, rather\nthan what it does not do.\n\nBut this works just as well, and I think that I'm splitting hairs\nanyways ;).\n\nThanks,\nTaylor\n"}]}