From: Junio C Hamano <gitster@pobox.com>
To: Ramkumar Ramachandra <artagnon@gmail.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: Re* [PATCH 5/7] git-log.txt: rewrite note on why "--" may be required
Date: Mon, 29 Apr 2013 09:33:12 -0700 [thread overview]
Message-ID: <7va9ohl2k7.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: CALkWK0m2__SZmpyQqLjkJuMWtPuD4=Oo7QrYovq_Fw6fpHEXXQ@mail.gmail.com
Ramkumar Ramachandra <artagnon@gmail.com> writes:
> I agree that the "confusion" paragraph after [--] [<path>] can be
> improved, but putting [--] in a paragraph of its own sounds like an
> overkill. Apart from other things, it means that every single git
> command would need an identical [--] paragraph for consistency.
That is not a problem. We need to say what command line argument X
(e.g. <path>, but not limited to it) does in all pages for commands
that pay attention to X anyway.
A more important reason to have them as separate entries is to avoid
giving a wrong impression that "--" is somehow related to <path>,
which is where the mistake in the synopsis "[[--] <path>...]" that
started this thread comes from.
next prev parent reply other threads:[~2013-04-29 16:33 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-22 5:30 [PATCH v3 0/7] Documentation/shortlog improvements Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 1/7] git-shortlog.txt: remove (-h|--help) from OPTIONS Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 2/7] revisions.txt: clarify the .. and ... syntax Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 3/7] git-log.txt: order OPTIONS properly; move <since>..<until> Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 4/7] git-log.txt: generalize <since>..<until> Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 5/7] git-log.txt: rewrite note on why "--" may be required Ramkumar Ramachandra
2013-04-25 0:02 ` Re* " Junio C Hamano
2013-04-25 5:17 ` Ramkumar Ramachandra
2013-04-29 16:33 ` Junio C Hamano [this message]
2013-04-29 17:38 ` Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 6/7] git-shortlog.txt: make SYNOPSIS match log, update OPTIONS Ramkumar Ramachandra
2013-04-22 5:30 ` [PATCH 7/7] builtin/shortlog.c: make usage string consistent with log Ramkumar Ramachandra
2013-04-22 7:20 ` [PATCH 6.5/7] builtin/log.c: make usage string consistent with doc Ramkumar Ramachandra
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=7va9ohl2k7.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=artagnon@gmail.com \
--cc=git@vger.kernel.org \
/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).