{"thread":{"id":"55350","subject":"[PATCH] Fix a typo in git-maintenance documentation","startedAt":"2021-03-19T10:18:08Z","lastAt":"2021-03-20T01:56:39Z","messageCount":5,"participants":["Nils Leif Fischer via GitGitGadget","Junio C Hamano","Derrick Stolee"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"419689","messageId":"pull.984.git.git.1616149021392.gitgitgadget@gmail.com","threadId":"55350","inReplyTo":null,"subject":"[PATCH] Fix a typo in git-maintenance documentation","fromName":"Nils Leif Fischer via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2021-03-19T10:17:01Z","receivedAt":"2021-03-19T10:18:08Z","isPatch":true,"sender":{"key":"name:Nils Leif Fischer","avatar":null},"body":"From: Nils Leif Fischer \n\nSigned-off-by: Nils Leif Fischer \n---\n Fix typo in git-maintenance documentation\n \n Just a small typo.\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-984%2Fnilsleiffischer%2Fnilsleiffischer-patch-1-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-984/nilsleiffischer/nilsleiffischer-patch-1-v1\nPull-Request: https://github.com/git/git/pull/984\n\n Documentation/git-maintenance.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt\nindex 80ddd33ceba0..8023504dc65d 100644\n--- a/Documentation/git-maintenance.txt\n+++ b/Documentation/git-maintenance.txt\n@@ -106,7 +106,7 @@ any object transfer.\n \n gc::\n \tClean up unnecessary files and optimize the local repository. \"GC\"\n-\tstands for \"garbage collection,\" but this task performs many\n+\tstands for \"garbage collection\", but this task performs many\n \tsmaller tasks. This task can be expensive for large repositories,\n \tas it repacks all Git objects into a single pack-file. It can also\n \tbe disruptive in some situations, as it deletes stale data. See\n\nbase-commit: a5828ae6b52137b913b978e16cd2334482eb4c1f\n-- \ngitgitgadget\n"},{"id":"419723","messageId":"xmqqv99nm3jy.fsf@gitster.g","threadId":"55350","inReplyTo":"pull.984.git.git.1616149021392.gitgitgadget@gmail.com","subject":"Re: [PATCH] Fix a typo in git-maintenance documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-03-19T17:55:13Z","receivedAt":"2021-03-19T17:55:59Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Nils Leif Fischer via GitGitGadget\" \nwrites:\n\n> From: Nils Leif Fischer \n>\n> Signed-off-by: Nils Leif Fischer \n> ---\n> Fix typo in git-maintenance documentation\n> \n> Just a small typo.\n\nThis is from the very beginning at 2057d750 (maintenance: create\nbasic maintenance runner, 2020-09-17), I think.\n\n> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-984%2Fnilsleiffischer%2Fnilsleiffischer-patch-1-v1\n> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-984/nilsleiffischer/nilsleiffischer-patch-1-v1\n> Pull-Request: https://github.com/git/git/pull/984\n>\n> Documentation/git-maintenance.txt | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n>\n> diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt\n> index 80ddd33ceba0..8023504dc65d 100644\n> --- a/Documentation/git-maintenance.txt\n> +++ b/Documentation/git-maintenance.txt\n> @@ -106,7 +106,7 @@ any object transfer.\n> \n> gc::\n> \tClean up unnecessary files and optimize the local repository. \"GC\"\n> -\tstands for \"garbage collection,\" but this task performs many\n> +\tstands for \"garbage collection\", but this task performs many\n\nIsn't this merely an American style vs British style issue?\n\n\n> \tsmaller tasks. This task can be expensive for large repositories,\n> \tas it repacks all Git objects into a single pack-file. It can also\n> \tbe disruptive in some situations, as it deletes stale data. See\n>\n> base-commit: a5828ae6b52137b913b978e16cd2334482eb4c1f\n\n\ncf.\n\nhttps://www.grammarly.com/blog/quotation-marks\nhttps://www.thepunctuationguide.com/british-versus-american-style.html\nhttps://owl.purdue.edu/owl/general_writing/punctuation/quotation_marks/more_quotation_mark_rules.html\n"},{"id":"419727","messageId":"8a73d5c2-831c-8e9e-5f21-2f8ef24dfa42@gmail.com","threadId":"55350","inReplyTo":"xmqqv99nm3jy.fsf@gitster.g","subject":"Re: [PATCH] Fix a typo in git-maintenance documentation","fromName":"Derrick Stolee","fromEmail":"stolee@gmail.com","sentAt":"2021-03-19T18:37:38Z","receivedAt":"2021-03-19T18:38:23Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"On 3/19/2021 1:55 PM, Junio C Hamano wrote:\n> \"Nils Leif Fischer via GitGitGadget\" \n>> gc::\n>> \tClean up unnecessary files and optimize the local repository. \"GC\"\n>> -\tstands for \"garbage collection,\" but this task performs many\n>> +\tstands for \"garbage collection\", but this task performs many\n> \n> Isn't this merely an American style vs British style issue?\n\nYes, I believe so.\n\n> https://www.grammarly.com/blog/quotation-marks\n> https://www.thepunctuationguide.com/british-versus-american-style.html\n> https://owl.purdue.edu/owl/general_writing/punctuation/quotation_marks/more_quotation_mark_rules.html\n\nSpecifically, this quote from your first link:\n\n Commas and periods always go inside the quotation marks in\n American English; dashes, colons, and semicolons almost always\n go outside the quotation marks; question marks and exclamation\n marks sometimes go inside, sometimes stay outside.\n\nThe only time I break this is when the exact string matters,\nsuch as referencing an exact command with options. In those\ncases, I try to restructure the sentence to avoid having a\ncomma or period outside of the quote.\n\nThanks,\n-Stolee\n"},{"id":"419733","messageId":"xmqqa6qynbfm.fsf@gitster.g","threadId":"55350","inReplyTo":"xmqqv99nm3jy.fsf@gitster.g","subject":"Re: [PATCH] Fix a typo in git-maintenance documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-03-19T20:19:41Z","receivedAt":"2021-03-19T20:20:19Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Junio C Hamano writes:\n\n>> gc::\n>> \tClean up unnecessary files and optimize the local repository. \"GC\"\n>> -\tstands for \"garbage collection,\" but this task performs many\n>> +\tstands for \"garbage collection\", but this task performs many\n>\n> Isn't this merely an American style vs British style issue?\n\nHaving said that, I think a lot of existing documentation (and my\ngut feeling says \"majority of\", but I cannot claim anything like\nthat without actually counting [*1*]) we have tend to stick to the\n\"punctuation outside\" British style [*2*].\n\nIf somebody (not me, and probably not Derrick) is willing to do the\ncounting and tree-wide style fixes, I am OK if we add some new text\nto Documentation/CodingGuidelines to declare which style we stick\nto, and enforce consistency throughout the documentation set.\n\n\n[Footnote]\n\n*1* A quick count:\n\n $ git grep -e ',\" ' Documentation/\n\n gives just a single hit. On the other hand, '\", ' hits too many,\n but many are sentences like \n\n \"git clone -q\", \"git fetch -q\", and the like are quiet.\n\n which is not quite fair.\n\n Don't try to do that for the comma replaced with period; you'd be\n buried by \"word...\" and the like.\n\n\n*2* After all, that is more \"logical\", for us CS types---opening and\n closing quotes pair with each other, and the punctuation that\n appears near the quoted portion is part of the larger sentence\n structure.\n"},{"id":"419760","messageId":"d27633aa-8e68-36e9-ddd3-0d05d74a780c@gmail.com","threadId":"55350","inReplyTo":"xmqqa6qynbfm.fsf@gitster.g","subject":"Re: [PATCH] Fix a typo in git-maintenance documentation","fromName":"Derrick Stolee","fromEmail":"stolee@gmail.com","sentAt":"2021-03-20T01:55:56Z","receivedAt":"2021-03-20T01:56:39Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"On 3/19/2021 4:19 PM, Junio C Hamano wrote:\n> Junio C Hamano writes:\n> \n>>> gc::\n>>> \tClean up unnecessary files and optimize the local repository. \"GC\"\n>>> -\tstands for \"garbage collection,\" but this task performs many\n>>> +\tstands for \"garbage collection\", but this task performs many\n>>\n>> Isn't this merely an American style vs British style issue?\n> \n> Having said that, I think a lot of existing documentation (and my\n> gut feeling says \"majority of\", but I cannot claim anything like\n> that without actually counting [*1*]) we have tend to stick to the\n> \"punctuation outside\" British style [*2*].\n> \n> If somebody (not me, and probably not Derrick) is willing to do the\n> counting and tree-wide style fixes, I am OK if we add some new text\n> to Documentation/CodingGuidelines to declare which style we stick\n> to, and enforce consistency throughout the documentation set.\n\nI'm not lining up to volunteer for this effort, but if it is truly\nthe typical case in the Git documentation, I would agree to a change\nto the coding guidelines and this specific change.\n \n> [Footnote]\n> \n> *1* A quick count:\n> \n> $ git grep -e ',\" ' Documentation/\n> \n> gives just a single hit. On the other hand, '\", ' hits too many,\n> but many are sentences like \n> \n> \"git clone -q\", \"git fetch -q\", and the like are quiet.\n> \n> which is not quite fair.\n\nRight. I would use this order in these cases.\n\n> *2* After all, that is more \"logical\", for us CS types---opening and\n> closing quotes pair with each other, and the punctuation that\n> appears near the quoted portion is part of the larger sentence\n> structure.\n \nI'm willing to concede that using \", universally avoids needing\na special rule, especially because phrases like\n\n\tIf you run \"git commit\", then X happens.\n\nis obviously the right thing to do.\n\nI can't speak for contributors whose first language isn't English,\nbut I can imagine that removing the difference between these cases\nwould make it just a tiny bit easier to contribute.\n\nI can break my own habits. The only thing I ask is to make it\nofficially part of the guidelines.\n\nThanks,\n-Stolee\n"}]}