git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Dragan Simic <dsimic@manjaro.org>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] documentation: send-email: use camel case consistently
Date: Tue, 20 Feb 2024 10:29:43 -0800	[thread overview]
Message-ID: <xmqq8r3foup4.fsf@gitster.g> (raw)
In-Reply-To: <a766ba7eb27f663eee34214714f6076d@manjaro.org> (Dragan Simic's message of "Tue, 20 Feb 2024 17:50:41 +0100")

Dragan Simic <dsimic@manjaro.org> writes:

> If you insist on using "CC", I'd be fine with that, but frankly, I think
> that would actually be confusing to the users.

I do not insist; my job is to just reject what is not correct.

In this particular case, I do not think Cc is outright wrong; it
is near the borderline, but I do not know which side of that line it
sits.

I gave you one possible rule to decide what to capitalize (namely,
acronyms are spelled in all caps and that is how we capitalize
http.proxySSLCert and imap.preformattedHTML) and if we adopt that
rule, then sendemail.supressCc would be incorrect, simply because
carbon-copy should be spelled CC.

You need to give an alternative criteria that is easy to understand
for future developers and follow, and explain your choice in the
proposed commit log message: "We spell acronyms in all caps like
HTML and SSL, but in the case of carbon-copy, we spell it as Cc
because ...".

You need to fill that "..." is in your proposed log message to
explain the choice you made in your patch text.  More importantly,
it is to help future developers so that they can easily follow the
same rule to spell the variable names they invented in a way
consistent with the rule you followed in this patch.

Thanks.

  reply	other threads:[~2024-02-20 18:29 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-16  5:19 [PATCH] documentation: send-email: use camel case consistently Dragan Simic
2024-02-20  0:52 ` Junio C Hamano
2024-02-20  6:41   ` Dragan Simic
2024-02-20 16:22     ` Junio C Hamano
2024-02-20 16:29       ` Dragan Simic
2024-02-20 16:50         ` Dragan Simic
2024-02-20 18:29           ` Junio C Hamano [this message]
2024-02-20 19:38             ` Dragan Simic
2024-02-21  0:43         ` Chris Torek
2024-02-21  7:50           ` Dragan Simic

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=xmqq8r3foup4.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=dsimic@manjaro.org \
    --cc=git@vger.kernel.org \
    /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).