]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: align 'diff --no-index' in text and synopsis
authorAndreas Heiduk <asheiduk@gmail.com>
Thu, 3 May 2018 18:48:25 +0000 (20:48 +0200)
committerJunio C Hamano <gitster@pobox.com>
Sun, 6 May 2018 09:38:43 +0000 (18:38 +0900)
Make the two '<path>' parameters in DESCRIPTION mandatory and
move the `--options` part to the same place where the other
variants show them. And finally make `--no-index` in SYNOPSIS
as mandatory as in DESCRIPTION.

Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
Reviewed-by: Martin Ă…gren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-diff.txt

index b0c1bb95c83b8e8e6cf6fa863e74108e3e5fc35f..6593b5829920d1f321d023ec1c12c959c3ba5952 100644 (file)
@@ -13,7 +13,7 @@ SYNOPSIS
 'git diff' [options] --cached [<commit>] [--] [<path>...]
 'git diff' [options] <commit> <commit> [--] [<path>...]
 'git diff' [options] <blob> <blob>
-'git diff' [options] [--no-index] [--] <path> <path>
+'git diff' [options] --no-index [--] <path> <path>
 
 DESCRIPTION
 -----------
@@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk.
        further add to the index but you still haven't.  You can
        stage these changes by using linkgit:git-add[1].
 
-'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