git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
DSDragan Simic <dsimic@manjaro.org>
Date
Feb 20, 2024, 19:38 UTC
Message-ID
<db01d88aa08d33f366b836170e4eb605@manjaro.org>
In-Reply-To
<xmqq8r3foup4.fsf@gitster.g>
On 2024-02-20 19:29, Junio C Hamano wrote:
Show 17 quoted lines
> 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.

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.

Show 11 quoted lines
> 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.

Previous: Junio C HamanoNext: Chris Torek
Message 8 of 10 in “documentation: send-email: use camel case consistently”
  1. documentation: send-email: use camel case consistentlyDragan Simic, Feb 16, 2024
  2. Junio C HamanoFeb 20, 2024
  3. Dragan SimicFeb 20, 2024
  4. Junio C HamanoFeb 20, 2024
  5. Dragan SimicFeb 20, 2024
  6. Dragan SimicFeb 20, 2024
  7. Junio C HamanoFeb 20, 2024
  8. Dragan SimicFeb 20, 2024
  9. Chris TorekFeb 21, 2024
  10. Dragan SimicFeb 21, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.