Re: [PATCHv2 00/10] Cleaning up --help-all inconsistencies

[Michael J Gruber <git@drmicha.warpmail.net>]

Junio C Hamano venit, vidit, dixit 15.02.2011 20:02:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
>> v2 incorporates the changes as discussed so far.
> 
> Looked reasonable; thanks.
> 
>> It comes with three bonus patches which enforce the use of lowercase
>> <identifiers> (as per CodingGuidelines) in command messages (usage).
>>
>> Besides the guidelines, this is also the prevailing style in code.
> 
> Not that I am opposed to this change, but I don't see anything that says
> we want lower-case in CodingGuidelines. "Placeholders are enclosed in
> angle brackets." is the only thing it says as far as I can tell.

It's not expressed explicitly, but the examples there are all lowercase.
Your patch below makes it explicit.

Having a second look at documentation, there aren't many changes to do -
I would tend to leave things like <URL>, <FQDN>, possibly <UUID> (since
they are abbreviations) uppercase; unsure about <CVSROOT> (like the env
var). What do you think?

> So perhaps insert this before the last three patches.
> 
> -- >8 --
> Subject: CodingGuidelines: downcase placeholders in usage messages
> 
> We accumulated some inconsistencies without an explicit guidance to spell
> this out over time.
> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/CodingGuidelines |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
> 
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index ba2006d..fe1c1e5 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -152,7 +152,7 @@ Writing Documentation:
>   when writing or modifying command usage strings and synopsis sections
>   in the manual pages:
>  
> - Placeholders are enclosed in angle brackets:
> + Placeholders are spelled in lowercase and enclosed in angle brackets:
>     <file>
>     --sort=<key>
>     --abbrev[=<n>]