Re: [PATCH 2/6] Fix odd markup in --diff-filter documentation

Jonathan Nieder [off-list ref] writes:

Štěpán Němec wrote:

quoted

--- 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=<spec>::

Maybe something like

--diff-filter=((A|C|D|M|R|T|U|X|B)...[*])

to keep the overview while following the conventions you've set out?

Looks good to me as well, thanks.

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?

Štěpán

Štěpán Němec wrote:

Jonathan Nieder [off-list ref] writes:

quoted

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.