]> git.ipfire.org Git - thirdparty/git.git/commit
git-diff.txt: don't mark required argument as optional
authorMartin Ågren <martin.agren@gmail.com>
Mon, 13 Jul 2020 19:10:08 +0000 (21:10 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 13 Jul 2020 19:47:36 +0000 (12:47 -0700)
commitbc5482e9db9bbecbfcd3a45793af78d7e0a6a638
tree2ca16c8159c2db0dccde6a2578d1ee165b3daa3e
parent5f46e610cb43496612d7ec030d142b6b8515399d
git-diff.txt: don't mark required argument as optional

Commit b7e10b2ca2 ("Documentation: usage for diff combined commits",
2020-06-12) modified the synopsis by adding an optional "[<commit>...]"
to

  'git diff' [<options>] <commit> <commit> [--] [<path>...]

to effectively add

  'git diff' [<options>] <commit> <commit>... <commit> [--] [<path>...]

as another valid invocation. Which makes sense.

Further down, in the description, it left the existing entry for

  'git diff' [<options>] <commit> <commit> [--] [<path>...]

intact and added a new entry on

  'git diff' [<options>] <commit> [<commit>...] <commit> [--] [<path>...]

where it says that "[t]his form is to view the results of a merge
commit" and details how "the first listed commit must be the merge
itself". But one possible instantiation of this form is `git diff
<commit> <commit>` for which the added text doesn't really apply.

Remove the brackets so that we lose this overlap between the two
descriptions. We can still use the more compact representation in the
synopsis.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-diff.txt