Re: Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 19, 2014, 21:40 UTC
Message-ID: <xmqqk32qrhs1.fsf@gitster.dls.corp.google.com>
In-Reply-To: <546BD367.40301@inventati.org>

Slavomir Vlcek <svlc@inventati.org> writes:

Show 6 quoted lines

> I solved this by adding an extra (second) synopsis line
> so it looks just like the 'usage_msg' in 'builtin/stripspace.c'.
>
> But perhaps it would be wiser to have something like
> "git stripspace [[-s | --strip-comments] | [-c | --comment-lines]] < input"
> instead (and perhaps ordered alphabetically).

That might be more "manly" but much less friendly to humans compared to what your patch gives us.

These two modes are really about two different operations (the latter is not "strip" at all, but is about adding spaces, to which "comments" are often equated to), and two-line synopsis shows more prominently that they are distinct, which I think is the right thing to do.

Show 12 quoted lines

> diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt
> index c87bfcb..6c6e989 100644
> --- a/Documentation/git-stripspace.txt
> +++ b/Documentation/git-stripspace.txt
> @@ -10,6 +10,7 @@ SYNOPSIS
>  --------
>  [verse]
>  'git stripspace' [-s | --strip-comments] < input
> +'git stripspace' [-c | --comment-lines] < input
>  
>  DESCRIPTION
>  -----------