From: Junio C Hamano <gitster@pobox.com>
To: Andreas Heiduk <asheiduk@gmail.com>
Cc: Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH 2/6] doc: align 'diff --no-index' in text with synopsis
Date: Wed, 11 Apr 2018 06:22:29 +0900 [thread overview]
Message-ID: <xmqq7epe3gfe.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <20180410183224.10780-3-asheiduk@gmail.com> (Andreas Heiduk's message of "Tue, 10 Apr 2018 20:32:20 +0200")
Andreas Heiduk <asheiduk@gmail.com> writes:
>
> -'git diff' --no-index [--options] [--] [<path>...]::
> +'git diff' [--options] [--no-index] [--] <path> <path>::
>
> This form is to compare the given two paths on the
> filesystem. You can omit the `--no-index` option when
It definitely is a good change to show two (and only two) <path> on
the command line as non-optional arguments.
I however find the change to mark that -"-no-index" is optional is
inviting more confusion in the form presented in this patch. It is
optional under specific conditions, and that is not conveyed with
these two path arguments named very genericly (as opposed to making
it clear that they are paths that are not managed by Git) on the
example command line.
I have a suspicion that it would be safer to have the description
say under what condition "--no-index" becomes optional (which our
text already does), without marking it as if it is always optional
like this patch does (i.e. do not lose [] around it from this line).
I dunno.
next prev parent reply other threads:[~2018-04-10 21:22 UTC|newest]
Thread overview: 56+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-04-10 18:32 [PATCH 0/6] Some doc-fixes Andreas Heiduk
2018-04-10 18:32 ` [PATCH 1/6] doc: fix formatting inconsistency in githooks.txt Andreas Heiduk
2018-04-10 19:13 ` Martin Ågren
2018-04-10 20:04 ` Andreas Heiduk
2018-04-10 20:44 ` Martin Ågren
2018-04-10 21:23 ` Junio C Hamano
2018-04-11 21:05 ` Andreas Heiduk
2018-04-11 21:08 ` fixup! " Andreas Heiduk
2018-04-11 21:08 ` Andreas Heiduk
2018-04-12 19:36 ` Martin Ågren
2018-04-27 16:21 ` Andreas Heiduk
2018-04-10 18:32 ` [PATCH 2/6] doc: align 'diff --no-index' in text with synopsis Andreas Heiduk
2018-04-10 19:14 ` Martin Ågren
2018-04-10 19:14 ` Martin Ågren
2018-04-10 19:32 ` Andreas Heiduk
2018-04-10 21:22 ` Junio C Hamano [this message]
2018-04-11 21:21 ` fixup! " Andreas Heiduk
2018-04-10 18:32 ` [PATCH 3/6] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-04-10 18:32 ` [PATCH 4/6] doc: added '-d' and '-q' for 'git push' Andreas Heiduk
2018-04-10 19:17 ` Martin Ågren
2018-04-10 19:38 ` Andreas Heiduk
2018-04-10 20:05 ` Martin Ågren
2018-04-10 20:05 ` Martin Ågren
2018-04-10 18:39 ` [PATCH 5/6] git-svn: commit-diff does not support --add-author-from Andreas Heiduk
2018-04-17 6:18 ` Eric Wong
2018-04-27 16:31 ` Andreas Heiduk
2018-04-10 18:39 ` [PATCH 6/6] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-04-10 21:25 ` Junio C Hamano
2018-04-27 17:04 ` [PATCH v2 0/6] Some doc-fixes Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 0/7] " Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 1/7] doc: improve formatting in githooks.txt Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 2/7] doc: align 'diff --no-index' in text and synopsis Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 3/7] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 4/7] doc: add '-d' and '-o' for 'git push' Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 5/7] git-svn: remove ''--add-author-from' for 'commit-diff' Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 6/7] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-05-03 18:48 ` [PATCH v3 7/7] doc: normalize [--options] to [options] in git-diff Andreas Heiduk
2018-05-04 18:47 ` [PATCH v3 0/7] Some doc-fixes Martin Ågren
2018-04-27 17:04 ` [PATCH v2 1/6] doc: improve formatting in githooks.txt Andreas Heiduk
2018-04-27 18:46 ` Martin Ågren
2018-04-27 17:04 ` [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis Andreas Heiduk
2018-04-27 17:18 ` Martin Ågren
2018-04-27 18:28 ` Andreas Heiduk
2018-04-27 18:45 ` Martin Ågren
2018-04-27 19:08 ` Andreas Heiduk
2018-04-27 17:33 ` Eric Sunshine
2018-04-27 18:40 ` Andreas Heiduk
2018-04-27 18:43 ` Martin Ågren
2018-04-27 19:12 ` Eric Sunshine
2018-04-27 17:04 ` [PATCH v2 3/6] doc: clarify ignore rules for git ls-files Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 4/6] doc: add '-d' and '-o' for 'git push' Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 5/6] git-svn: remove ''--add-author-from' for 'commit-diff' Andreas Heiduk
2018-04-27 17:04 ` [PATCH v2 6/6] doc: add note about shell quoting to revision.txt Andreas Heiduk
2018-04-27 17:36 ` Eric Sunshine
2018-04-27 18:42 ` Andreas Heiduk
2018-04-27 19:23 ` [PATCH v2 7/6] doc: normalize [--options] to [options] in git-diff Andreas Heiduk
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq7epe3gfe.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=asheiduk@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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).