Re: [PATCH] doc: camelCase the config variables to improve readability

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wednesday 20 September 2017 01:52 AM, Jonathan Nieder wrote:
nit: Git's commit messages describe the current behavior of Git in the
present tense.  Something like:

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 ;-)

	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.

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

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

Yes.

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

Thanks.


Thanks for your attention to detail.

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



[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux