From: "Štěpán Němec" <stepan.nemec@gmail.com>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com
Subject: Re: [PATCH 2/6] Fix odd markup in --diff-filter documentation
Date: Fri, 08 Oct 2010 20:40:32 +0200 [thread overview]
Message-ID: <877hhsttnj.fsf@gmail.com> (raw)
In-Reply-To: <20101008180327.GA13910@burratino> (Jonathan Nieder's message of "Fri, 8 Oct 2010 13:03:27 -0500")
Jonathan Nieder <jrnieder@gmail.com> writes:
> Štěpán Němec wrote:
>> Jonathan Nieder <jrnieder@gmail.com> writes:
>
>>> Strictly speaking, --diff-filter= (with empty argument) is allowed, too,
>>> but I don't know if it's worth fitting that in.
>>
>> If it provides some kind of useful behaviour (I don't know and you
>> didn't clarify that either), then it should be documented I guess?
>
> Just a special case of the usual behavior: it selects the empty set of
> files. Doesn't sound useful to me, but maybe someone writing a
> front-end would want to be reassured that --diff-filter will still
> work if the user unchecks all the boxes.
>
> Of course, one can also just try it...
>
> If you can find a way to format it nicely (using brackets?), then I
> think it should be part of the documented syntax, yes.
Well, in that case simply replacing parens with brackets would do, i.e.
--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]
instead of
--diff-filter=((A|C|D|M|R|T|U|X|B)...[*])
That would mean the following instead of the original [2/6]:
--- 8< ---
Subject: Fix odd markup in --diff-filter documentation
Instead of using the regex-like bracket expression, use grouping to make
it more consistent with other similar places. The brackets now have the
same meaning as in other documentation (i.e., the argument is optional).
Signed-off-by: Štěpán Němec <stepnem@gmail.com>
Mentored-by: Jonathan Nieder <jrnieder@gmail.com>
---
Documentation/diff-options.txt | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index cbf3c92..e954af0 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -248,13 +248,13 @@ endif::git-log[]
If `n` is specified, it has the same meaning as for `-M<n>`.
ifndef::git-format-patch[]
---diff-filter=[ACDMRTUXB*]::
+--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
Select only files that are Added (`A`), Copied (`C`),
Deleted (`D`), Modified (`M`), Renamed (`R`), have their
type (i.e. regular file, symlink, submodule, ...) changed (`T`),
are Unmerged (`U`), are
Unknown (`X`), or have had their pairing Broken (`B`).
- Any combination of the filter characters may be used.
+ Any combination of the filter characters (including none) can be used.
When `*` (All-or-none) is added to the combination, all
paths are selected if there is any file that matches
other criteria in the comparison; if there is no file
--
next prev parent reply other threads:[~2010-10-08 18:41 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-10-08 0:52 [PATCH/RFC] Unify argument and option notation in the docs Štěpán Němec
2010-10-08 7:43 ` Jonathan Nieder
2010-10-08 11:13 ` Štěpán Němec
2010-10-08 17:31 ` [PATCH 0/6] " Štěpán Němec
2010-10-08 17:44 ` Jonathan Nieder
2010-10-08 19:43 ` Junio C Hamano
2010-10-08 20:15 ` Štěpán Němec
2010-10-21 22:21 ` Jonathan Nieder
2010-10-24 15:51 ` [PATCH] CodingGuidelines: Add a section on writing documentation Štěpán Němec
2010-10-29 2:56 ` Mark Lodato
2010-10-29 11:54 ` Štěpán Němec
2010-10-29 17:14 ` Sverre Rabbelier
2010-11-01 17:00 ` Štěpán Němec
2010-11-04 17:12 ` [PATCH v2] " Štěpán Němec
2010-11-04 17:18 ` [PATCH] diff,difftool: Don't use the {0,2} notation in usage strings Štěpán Němec
2010-11-04 17:22 ` Sverre Rabbelier
2010-11-04 17:49 ` Jeff King
2010-11-04 18:02 ` Jonathan Nieder
2010-11-04 18:13 ` Jeff King
2010-11-04 18:38 ` Jonathan Nieder
2010-11-04 18:55 ` Jeff King
2010-11-04 20:26 ` Štěpán Němec
2010-11-04 20:43 ` Jeff King
2010-11-04 21:17 ` [PATCH] docs: clarify git diff modes of operation Jeff King
2010-11-04 21:50 ` Jonathan Nieder
2010-11-05 1:57 ` Mark Lodato
2010-11-04 21:51 ` Štěpán Němec
2010-11-04 21:30 ` [PATCH] diff,difftool: Don't use the {0,2} notation in usage strings Štěpán Němec
2010-10-08 17:31 ` [PATCH 1/6] Use angles for placeholders consistently Štěpán Němec
2010-10-08 17:31 ` [PATCH 2/6] Fix odd markup in --diff-filter documentation Štěpán Němec
2010-10-08 17:39 ` Jonathan Nieder
2010-10-08 17:57 ` Štěpán Němec
2010-10-08 18:03 ` Jonathan Nieder
2010-10-08 18:40 ` Štěpán Němec [this message]
2010-10-08 18:53 ` Jonathan Nieder
2010-10-08 17:31 ` [PATCH 3/6] Use parentheses and `...' where appropriate Štěpán Němec
2010-10-08 17:31 ` [PATCH 4/6] Remove stray quotes in --pretty and --format documentation Štěpán Němec
2010-10-08 17:31 ` [PATCH 5/6] Put a space between `<' and argument in pack-objects usage string Štěpán Němec
2010-10-08 17:31 ` [PATCH 6/6] Fix {update,checkout}-index usage strings Štěpán Němec
2010-10-08 16:45 ` [PATCH 0/2] pack-objects: use ALLOC_GROW in place of manual growth Jonathan Nieder
2010-10-08 16:46 ` [PATCH 1/2] Documentation: No argument of ALLOC_GROW should have side-effects Jonathan Nieder
2010-10-08 16:47 ` [PATCH 2/2] pack-objects: use ALLOC_GROW Jonathan Nieder
2010-10-08 17:02 ` [PATCH 3/2] Allow side-effects in second argument to ALLOC_GROW Jonathan Nieder
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=877hhsttnj.fsf@gmail.com \
--to=stepan.nemec@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.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).