git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc: camelCase the config variables to improve readability
Date: Wed, 20 Sep 2017 13:33:02 +0530	[thread overview]
Message-ID: <63517904-6e14-6e12-31dd-ad91b2a70004@gmail.com> (raw)
In-Reply-To: <20170919202201.GD75068@aiede.mtv.corp.google.com>

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@gmail.com>

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

  reply	other threads:[~2017-09-20  8:03 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-19 12:46 [PATCH] doc: camelCase the config variables to improve readability Kaartic Sivaraam
2017-09-19 20:22 ` Jonathan Nieder
2017-09-20  8:03   ` Kaartic Sivaraam [this message]
2017-09-23  4:56   ` [PATCH v2] " Kaartic Sivaraam
2017-09-24  0:28     ` Junio C Hamano
2017-09-24  5:21       ` Kaartic Sivaraam
2017-09-25  8:27       ` [PATCH v3] " Kaartic Sivaraam

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=63517904-6e14-6e12-31dd-ad91b2a70004@gmail.com \
    --to=kaarticsivaraam91196@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).