Re: [PATCH] documentation: send-email: use camel case consistently

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

 



On 2024-02-20 19:29, Junio C Hamano wrote:
Dragan Simic <dsimic@xxxxxxxxxxx> 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.

Please, let me remind you that I already fully agreed with using
"SSL".  The same applies to "HTML", for example, but "Cc" should be
an exception to that rule, IMHO.

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.

Agreed, I'll provide a detailed rationale for using "Cc" vs. "SSL"
in the commit description for v3, with a few references.




[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