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

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 20, 2024, 00:52 UTC
Message-ID: <xmqqv86kx8h0.fsf@gitster.g>
In-Reply-To: <b0577267402f6177d8ba5646e12d7691437e6e8f.1708060779.git.dsimic@manjaro.org>

Dragan Simic <dsimic@manjaro.org> writes:

> Correct a few random "sendemail.*" configuration parameter names in the
> documentation that, for some reason, didn't use camel case format.

Thanks.

> There's only one "Fixes" tag, while there should actually be a whole bunch
> of them to cover all the patches that introduced the configuration parameter
> names fixed by this patch.  I think we're fine with just one.

I suspect that we are even better off without any. The only reason to have them is if we plan to cherry-pick this patch down to a separate maintenance track that the "culprit" was cherry-picked or merged to, but we typically do not do so, and if we want to do so, we'd need a much better coverage.

Anyway, checking the output of

    $ git grep -n -e '^[a-z]*\.[a-z]*[A-Z][A-Z][a-zA-Z]*::' Documentation/config/

and comparing it with the output of

    $ git grep -n -e '^[a-z]*\.[a-z]*[A-Z][a-zA-Z]*::' Documentation/config/

I think we should spell "SSL" (which is an acronym) full in capital, and possibly do the same for "CC", too.

All the other updates in this patch looked sensible, but I wasn't being particularly careful, so an extra set or two of eyes are certainly appreciated in case I missed any.

Thanks.