{"thread":{"id":"46786","subject":"[PATCH] doc: camelCase the config variables to improve readability","startedAt":"2017-09-19T12:46:57Z","lastAt":"2017-09-25T08:28:05Z","messageCount":7,"participants":["Kaartic Sivaraam","Jonathan Nieder","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"328382","messageId":"0102015e9a2d3eb6-bee76ba8-4298-47d2-8822-d513bc33bd71-000000@eu-west-1.amazonses.com","threadId":"46786","inReplyTo":null,"subject":"[PATCH] doc: camelCase the config variables to improve readability","fromName":"Kaartic Sivaraam","fromEmail":"kaarticsivaraam91196@gmail.com","sentAt":"2017-09-19T12:46:50Z","receivedAt":"2017-09-19T12:46:57Z","isPatch":true,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"The config variable used weren't readable as they were in the\ncrude form of how git stores/uses it's config variables.\n\nImprove it's readability by replacing them with camelCased versions\nof config variables as it doesn't have any impact on it's usage.\n\nSigned-off-by: Kaartic Sivaraam \n---\n Documentation/git-branch.txt | 4 ++--\n Documentation/git-tag.txt | 2 +-\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt\nindex e292737b9c5ab..58f1e5c9c74e1 100644\n--- a/Documentation/git-branch.txt\n+++ b/Documentation/git-branch.txt\n@@ -92,10 +92,10 @@ OPTIONS\n \tall changes made to the branch ref, enabling use of date\n \tbased sha1 expressions such as \"@\\{yesterday}\".\n \tNote that in non-bare repositories, reflogs are usually\n-\tenabled by default by the `core.logallrefupdates` config option.\n+\tenabled by default by the `core.logAllRefUpdates` config option.\n \tThe negated form `--no-create-reflog` only overrides an earlier\n \t`--create-reflog`, but currently does not negate the setting of\n-\t`core.logallrefupdates`.\n+\t`core.logAllRefUpdates`.\n \n -f::\n --force::\ndiff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt\nindex 543fb425ee7c1..95e9f391d88fc 100644\n--- a/Documentation/git-tag.txt\n+++ b/Documentation/git-tag.txt\n@@ -174,7 +174,7 @@ This option is only applicable when listing tags without annotation lines.\n \t`core.logAllRefUpdates` in linkgit:git-config[1].\n \tThe negated form `--no-create-reflog` only overrides an earlier\n \t`--create-reflog`, but currently does not negate the setting of\n-\t`core.logallrefupdates`.\n+\t`core.logAllRefUpdates`.\n \n ::\n \tThe name of the tag to create, delete, or describe.\n\n--\nhttps://github.com/git/git/pull/407\n"},{"id":"328419","messageId":"20170919202201.GD75068@aiede.mtv.corp.google.com","threadId":"46786","inReplyTo":"0102015e9a2d3eb6-bee76ba8-4298-47d2-8822-d513bc33bd71-000000@eu-west-1.amazonses.com","subject":"Re: [PATCH] doc: camelCase the config variables to improve readability","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2017-09-19T20:22:01Z","receivedAt":"2017-09-19T20:22:09Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi,\n\nKaartic Sivaraam wrote:\n\n> The config variable used weren't readable as they were in the\n> crude form of how git stores/uses it's config variables.\n\nnit: Git's commit messages describe the current behavior of Git in the\npresent tense. Something like:\n\n\tThese manpages' references to config variables are hard to read because\n\tthey use all-lowercase names, without indicating where each word ends\n\tand begins in the configuration variable names.\n\n\tImprove readability by using camelCase instead. Git treats these names\n\tcase-insensitively so this does not affect functionality.\n\n> Improve it's readability by replacing them with camelCased versions\n> of config variables as it doesn't have any impact on it's usage.\n\nnit: s/it's/its/ (in both places)\n\n> Signed-off-by: Kaartic Sivaraam \n> ---\n> Documentation/git-branch.txt | 4 ++--\n> Documentation/git-tag.txt | 2 +-\n> 2 files changed, 3 insertions(+), 3 deletions(-)\n\nThis also is just more consistent with the rest of the docs.\n\nFWIW, with or without the commit message tweaks mentioned above,\nReviewed-by: Jonathan Nieder \n\nThanks for your attention to detail.\n"},{"id":"328457","messageId":"63517904-6e14-6e12-31dd-ad91b2a70004@gmail.com","threadId":"46786","inReplyTo":"20170919202201.GD75068@aiede.mtv.corp.google.com","subject":"Re: [PATCH] doc: camelCase the config variables to improve readability","fromName":"Kaartic Sivaraam","fromEmail":"kaarticsivaraam91196@gmail.com","sentAt":"2017-09-20T08:03:02Z","receivedAt":"2017-09-20T08:03:19Z","isPatch":true,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"On Wednesday 20 September 2017 01:52 AM, Jonathan Nieder wrote:\n> nit: Git's commit messages describe the current behavior of Git in the\n> present tense. Something like:\n\nThanks for the clarification. I was once searching \nDocumentation/SubmittingPatches\nto see if there is any guideline about the tense to use. Unfortunately, \nthis seems to\nbe an undocumented guideline. Fixed it.\n\nMy little nit: I don't think this is really the a \"current behaviour of \n*Git*\". It's just\na document, you see ;-)\n\n> \tThese manpages' references to config variables are hard to read because\n> \tthey use all-lowercase names, without indicating where each word ends\n> \tand begins in the configuration variable names.\n>\n> \tImprove readability by using camelCase instead. Git treats these names\n> \tcase-insensitively so this does not affect functionality.\n\nThanks for providing the solution, also. Used it with a little tweak.\n\n> This also is just more consistent with the rest of the docs.\n\nYes.\n\n> FWIW, with or without the commit message tweaks mentioned above,\n> Reviewed-by: Jonathan Nieder \n\nThanks.\n\n\n> Thanks for your attention to detail.\n\nYou're welcome. Just for the note, I sent this because I had a hard time \nfinding\nthe words that made up those config variable names when reading that part of\nthe 'git branch' documentation. I thought I could help a little in \nimproving it.\n\n---\nKaartic\n"},{"id":"328716","messageId":"20170923045617.3782-1-kaarticsivaraam91196@gmail.com","threadId":"46786","inReplyTo":"20170919202201.GD75068@aiede.mtv.corp.google.com","subject":"[PATCH v2] doc: camelCase the config variables to improve readability","fromName":"Kaartic Sivaraam","fromEmail":"kaarticsivaraam91196@gmail.com","sentAt":"2017-09-23T04:56:17Z","receivedAt":"2017-09-23T05:00:40Z","isPatch":true,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"A few configuration variable names of Git are composite words. References\nto such variables in manpages are hard to read because they use all-lowercase\nnames, without indicating where each word ends and begins.\n\nImprove its readability by using camelCase instead. Git treats these\nnames case-insensitively so this does not affect functionality. This\nalso ensures consistency with other parts of the docs that use camelCase\nfo refer to configuration variable names.\n\nSigned-off-by: Kaartic Sivaraam \nReviewed-by: Jonathan Nieder \n---\n Triple checked the 'In-reply-to' Mail-Id this time ;-)\n\n Documentation/git-branch.txt | 4 ++--\n Documentation/git-tag.txt | 2 +-\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt\nindex e292737b9..58f1e5c9c 100644\n--- a/Documentation/git-branch.txt\n+++ b/Documentation/git-branch.txt\n@@ -92,10 +92,10 @@ OPTIONS\n \tall changes made to the branch ref, enabling use of date\n \tbased sha1 expressions such as \"@\\{yesterday}\".\n \tNote that in non-bare repositories, reflogs are usually\n-\tenabled by default by the `core.logallrefupdates` config option.\n+\tenabled by default by the `core.logAllRefUpdates` config option.\n \tThe negated form `--no-create-reflog` only overrides an earlier\n \t`--create-reflog`, but currently does not negate the setting of\n-\t`core.logallrefupdates`.\n+\t`core.logAllRefUpdates`.\n \n -f::\n --force::\ndiff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt\nindex 543fb425e..95e9f391d 100644\n--- a/Documentation/git-tag.txt\n+++ b/Documentation/git-tag.txt\n@@ -174,7 +174,7 @@ This option is only applicable when listing tags without annotation lines.\n \t`core.logAllRefUpdates` in linkgit:git-config[1].\n \tThe negated form `--no-create-reflog` only overrides an earlier\n \t`--create-reflog`, but currently does not negate the setting of\n-\t`core.logallrefupdates`.\n+\t`core.logAllRefUpdates`.\n \n ::\n \tThe name of the tag to create, delete, or describe.\n-- \n2.14.1.868.g66c78774b\n\n"},{"id":"328753","messageId":"xmqqmv5lhre2.fsf@gitster.mtv.corp.google.com","threadId":"46786","inReplyTo":"20170923045617.3782-1-kaarticsivaraam91196@gmail.com","subject":"Re: [PATCH v2] doc: camelCase the config variables to improve readability","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-09-24T00:28:05Z","receivedAt":"2017-09-24T00:28:13Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Kaartic Sivaraam writes:\n\n> A few configuration variable names of Git are composite words. References\n> to such variables in manpages are hard to read because they use all-lowercase\n> names, without indicating where each word ends and begins.\n>\n> Improve its readability by using camelCase instead. Git treats these\n> names case-insensitively so this does not affect functionality. This\n> also ensures consistency with other parts of the docs that use camelCase\n> fo refer to configuration variable names.\n\ns/fo/to/ (or s/fo/in order to/)? \n\nI think the one I have on 'pu' uses Jonathan's suggested rewrite of\nthe log message verbatim, and I suspect that it is already clear\nenough, even though I admit that I stuttered a bit while reading its\nfirst sentence.\n\nI'd avoid \"A few\" above, as it is my impression that we use\nmulti-word names quite a bit, not just a few.\n\nPerhaps\n\n\tReferences to multi-word configuration variable names in our\n\tdocumentation must consistently use camelCase to highlight\n\twhere the word boundaries are, even though these are treated\n\tcase insensitively.\n\n\tFix a few places that spell them in all lowercase, which\n\tmakes them harder to read.\n\nmay be a more succinct way to say the same thing. We state the rule\nupfront, explain what the rule is for, and tell the codebase to\napply the rule. That should cover everything your version and\nJonathan's version wanted to convey, I'd think.\n\n"},{"id":"328764","messageId":"1506230463.2425.2.camel@gmail.com","threadId":"46786","inReplyTo":"xmqqmv5lhre2.fsf@gitster.mtv.corp.google.com","subject":"Re: [PATCH v2] doc: camelCase the config variables to improve readability","fromName":"Kaartic Sivaraam","fromEmail":"kaarticsivaraam91196@gmail.com","sentAt":"2017-09-24T05:21:03Z","receivedAt":"2017-09-24T11:31:22Z","isPatch":true,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"On Sun, 2017-09-24 at 09:28 +0900, Junio C Hamano wrote:\n> Kaartic Sivaraam writes:\n> \n> > A few configuration variable names of Git are composite words. References\n> > to such variables in manpages are hard to read because they use all-lowercase\n> > names, without indicating where each word ends and begins.\n> > \n> > Improve its readability by using camelCase instead. Git treats these\n> > names case-insensitively so this does not affect functionality. This\n> > also ensures consistency with other parts of the docs that use camelCase\n> > fo refer to configuration variable names.\n> \n> s/fo/to/ (or s/fo/in order to/)? \n> \n\nYeah, a typo that I missed.\n\n> Perhaps\n> \n> \tReferences to multi-word configuration variable names in our\n> \tdocumentation must consistently use camelCase to highlight\n> \twhere the word boundaries are, even though these are treated\n> \tcase insensitively.\n> \n> \tFix a few places that spell them in all lowercase, which\n> \tmakes them harder to read.\n> \n> may be a more succinct way to say the same thing. We state the rule\n> upfront, explain what the rule is for, and tell the codebase to\n> apply the rule. That should cover everything your version and\n> Jonathan's version wanted to convey, I'd think.\n> \n\nMuch better, thanks. Will resend with this updated message.\n\n---\nKaartic\n"},{"id":"328824","messageId":"20170925082747.3171-1-kaarticsivaraam91196@gmail.com","threadId":"46786","inReplyTo":"xmqqmv5lhre2.fsf@gitster.mtv.corp.google.com","subject":"[PATCH v3] doc: camelCase the config variables to improve readability","fromName":"Kaartic Sivaraam","fromEmail":"kaartic.sivaraam@gmail.com","sentAt":"2017-09-25T08:27:47Z","receivedAt":"2017-09-25T08:28:05Z","isPatch":true,"sender":{"key":"kaartic.sivaraam@gmail.com","avatar":"https://avatars.githubusercontent.com/u/12448084?v=4"},"body":"References to multi-word configuration variable names in our\ndocumentation must consistently use camelCase to highlight\nwhere the word boundaries are, even though these are treated\ncase insensitively.\n\nFix a few places that spell them in all lowercase, which\nmakes them harder to read.\n\nSigned-off-by: Kaartic Sivaraam \nReviewed-by: Jonathan Nieder \n---\n\n Changes in v3:\n\n - Used the commit message as suggested by Junio\n\n Documentation/git-branch.txt | 4 ++--\n Documentation/git-tag.txt | 2 +-\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt\nindex e292737b9..58f1e5c9c 100644\n--- a/Documentation/git-branch.txt\n+++ b/Documentation/git-branch.txt\n@@ -92,10 +92,10 @@ OPTIONS\n \tall changes made to the branch ref, enabling use of date\n \tbased sha1 expressions such as \"@\\{yesterday}\".\n \tNote that in non-bare repositories, reflogs are usually\n-\tenabled by default by the `core.logallrefupdates` config option.\n+\tenabled by default by the `core.logAllRefUpdates` config option.\n \tThe negated form `--no-create-reflog` only overrides an earlier\n \t`--create-reflog`, but currently does not negate the setting of\n-\t`core.logallrefupdates`.\n+\t`core.logAllRefUpdates`.\n \n -f::\n --force::\ndiff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt\nindex 543fb425e..95e9f391d 100644\n--- a/Documentation/git-tag.txt\n+++ b/Documentation/git-tag.txt\n@@ -174,7 +174,7 @@ This option is only applicable when listing tags without annotation lines.\n \t`core.logAllRefUpdates` in linkgit:git-config[1].\n \tThe negated form `--no-create-reflog` only overrides an earlier\n \t`--create-reflog`, but currently does not negate the setting of\n-\t`core.logallrefupdates`.\n+\t`core.logAllRefUpdates`.\n \n ::\n \tThe name of the tag to create, delete, or describe.\n-- \n2.14.1.539.g78797280a.dirty\n\n"}]}