docs: clarify git diff modes of operation
It is an oversimplification to say that we can take "[<commit> [<commit>]]", as it really depends on what options have been given. Instead, let's list the major modes of operation separately, as we do in other manpages. This patch also adjusts the text immediately after the synopsis to match the lines given in the synopsis. For git-difftool, which has the same issue, let's refer the user to the git-diff manpage rather than spelling it all out again. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Nov 4, 2010 at 17:17 UTC
49bd56a5f7b09f89b59a6a77d331e8f85f6d7fde
2 files changed
+10
-4
Documentation/git-diff.txt
+8
-3
@@ -8,12 +8,17 @@ git-diff - Show changes between commits, commit and working tree, etc
8
9
SYNOPSIS
10
--------
11
-'git diff' [<common diff options>] [<commit> [<commit>]] [--] [<path>...]
11
+[verse]
12
+'git diff' [options] [<commit>] [--] [<path>...]
13
+'git diff' [options] --cached [<commit>] [--] [<path>...]
14
+'git diff' [options] <commit> <commit> [--] [<path>...]
15
+'git diff' [options] [--no-index] [--] <path> <path>
16
17
DESCRIPTION
18
-----------
15
-Show changes between two trees, a tree and the working tree, a
16
-tree and the index file, or the index file and the working tree.
19
+Show changes between the working tree and the index or a tree, changes
20
+between the index and a tree, changes between two trees, or changes
21
+between two files on disk.
22
23
'git diff' [--options] [--] [<path>...]::
24
Documentation/git-difftool.txt
+2
-1
@@ -13,7 +13,8 @@ DESCRIPTION
13
-----------
14
'git difftool' is a git command that allows you to compare and edit files
15
between revisions using common diff tools. 'git difftool' is a frontend
16
-to 'git diff' and accepts the same options and arguments.
16
+to 'git diff' and accepts the same options and arguments. See
17
+linkgit:git-diff[1].
18
19
OPTIONS
20
-------