git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Slavomir Vlcek <svlc@inventati.org>
To: git@vger.kernel.org
Cc: conrad.irwin@gmail.com, Junio C Hamano <gitster@pobox.com>
Subject: Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis
Date: Wed, 19 Nov 2014 00:16:55 +0100	[thread overview]
Message-ID: <546BD367.40301@inventati.org> (raw)

Add synopsis with the '--comment-lines' option.

Signed-off-by: Slavomir Vlcek <svlc@inventati.org>
---

Hi,
there were no mention of '--comment-lines' in the synopsis.

('--comment-lines' and '--strip-comments' options
are mutually exclusive).

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).
This approach can be seen e.g. in the git-add man page.

For the 'master'.


Also, have a few questions about stripspace generally:
a) Should 'git stripspace --comment-lines' really leave the trailing
whitespace alone (example: ' hello  '->'# hello  ')?
b) In the documentation there is:
"-s, --strip-comments
           Skip and remove all lines starting with comment character (default #)."

part. This "default" word somehow suggests some new command option that would
allow to change the comment character. Would you accept a patch implementing
this or such functionality is not desired.

Thank you.


 Documentation/git-stripspace.txt | 1 +
 1 file changed, 1 insertion(+)

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
 -----------
-- 
2.0.1

             reply	other threads:[~2014-11-18 23:13 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-18 23:16 Slavomir Vlcek [this message]
2014-11-18 23:29 ` Subject: [PATCH/RFC] Documentation/git-stripspace: Update synopsis Slavomir Vlcek
2014-11-19 21:40 ` Junio C Hamano

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=546BD367.40301@inventati.org \
    --to=svlc@inventati.org \
    --cc=conrad.irwin@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).