Re: [PATCHv2 00/10] Cleaning up --help-all inconsistencies
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Feb 15, 2011, 19:02 UTC
- Message-ID
- <7v1v39p1cv.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <cover.1297774306.git.git@drmicha.warpmail.net>
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.
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>]