From: Junio C Hamano <gitster@pobox•com>
To: Slavomir Vlcek <svlc@inventati•org>
Cc: git@vger•kernel.org, conrad.irwin@gmail•com
Subject: Re: Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis
Date: Wed, 19 Nov 2014 13:40:14 -0800 [thread overview]
Message-ID: <xmqqk32qrhs1.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <546BD367.40301@inventati.org> (Slavomir Vlcek's message of "Wed, 19 Nov 2014 00:16:55 +0100")
Slavomir Vlcek <svlc@inventati•org> writes:
> 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.
> 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
> -----------
prev parent reply other threads:[~2014-11-19 21:40 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-11-18 23:16 Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis Slavomir Vlcek
2014-11-18 23:29 ` Slavomir Vlcek
2014-11-19 21:40 ` Junio C Hamano [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqk32qrhs1.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=conrad.irwin@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=svlc@inventati$(echo .)org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox