patchdoc: camelCase the config variables to improve readability

The config variable used weren't readable as they were in the crude form of how git stores/uses it's config variables.

Improve it's readability by replacing them with camelCased versions of config variables as it doesn't have any impact on it's usage.

Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
---
 Documentation/git-branch.txt | 4 ++--
 Documentation/git-tag.txt    | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

Hi,

Kaartic Sivaraam wrote:

nit: Git's commit messages describe the current behavior of Git in the present tense. Something like:

	These manpages' references to config variables are hard to read because
	they use all-lowercase names, without indicating where each word ends
	and begins in the configuration variable names.

	Improve readability by using camelCase instead.  Git treats these names
	case-insensitively so this does not affect functionality.

nit: s/it's/its/ (in both places)

This also is just more consistent with the rest of the docs.

FWIW, with or without the commit message tweaks mentioned above,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks for your attention to detail.

On Wednesday 20 September 2017 01:52 AM, Jonathan Nieder wrote:

Thanks for the clarification. I was once searching Documentation/SubmittingPatches to see if there is any guideline about the tense to use. Unfortunately, this seems to be an undocumented guideline. Fixed it.

My little nit: I don't think this is really the a "current behaviour of *Git*". It's just a document, you see ;-)

Thanks for providing the solution, also. Used it with a little tweak.

Yes.

Thanks.

You're welcome. Just for the note, I sent this because I had a hard time finding the words that made up those config variable names when reading that part of the 'git branch' documentation. I thought I could help a little in improving it.

--- Kaartic

A few configuration variable names of Git are composite words. References to such variables in manpages are hard to read because they use all-lowercase names, without indicating where each word ends and begins.

Improve its readability by using camelCase instead. Git treats these names case-insensitively so this does not affect functionality. This also ensures consistency with other parts of the docs that use camelCase fo refer to configuration variable names.

Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Triple checked the 'In-reply-to' Mail-Id this time ;-)

 Documentation/git-branch.txt | 4 ++--
 Documentation/git-tag.txt    | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:

s/fo/to/ (or s/fo/in order to/)?  

I think the one I have on 'pu' uses Jonathan's suggested rewrite of the log message verbatim, and I suspect that it is already clear enough, even though I admit that I stuttered a bit while reading its first sentence.

I'd avoid "A few" above, as it is my impression that we use multi-word names quite a bit, not just a few.

Perhaps

	References to multi-word configuration variable names in our
	documentation must consistently use camelCase to highlight
	where the word boundaries are, even though these are treated
	case insensitively.

	Fix a few places that spell them in all lowercase, which
	makes them harder to read.

may be a more succinct way to say the same thing. We state the rule upfront, explain what the rule is for, and tell the codebase to apply the rule. That should cover everything your version and Jonathan's version wanted to convey, I'd think.

On Sun, 2017-09-24 at 09:28 +0900, Junio C Hamano wrote:

Yeah, a typo that I missed.

Much better, thanks. Will resend with this updated message.

--- Kaartic

References to multi-word configuration variable names in our documentation must consistently use camelCase to highlight where the word boundaries are, even though these are treated case insensitively.

Fix a few places that spell them in all lowercase, which makes them harder to read.

Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
---

 Changes in v3:

    - Used the commit message as suggested by Junio

 Documentation/git-branch.txt | 4 ++--
 Documentation/git-tag.txt    | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)