@matheusbsbs / matheus-bagliano / commits / f5e6b89b3a
Fork 0

Update git-diff documentation

Porcelain documentation should talk in terms of end-user workflow, not in terms of implementation details. Do not suggest update-index, but git-add instead. Explain differences among 0-, 1- and 2-tree cases not as differences of number of trees given to the command, but say why user would want to give these number of trees to the command in what situation. Signed-off-by: Junio C Hamano <junkio@cox.net>

Junio C Hamano committed Dec 14, 2006 at 00:03 UTC f5e6b89b3a4420481a6ecdc05df325cb6d69d114
1 file changed +35 -17
Documentation/git-diff.txt
+35 -17
@@ -14,30 +14,48 @@ DESCRIPTION
14 -----------
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.
17 -The combination of what is compared with what is determined by
18 -the number of trees given to the command.
17
20 -* When no <tree-ish> is given, the working tree and the index
21 - file are compared, using `git-diff-files`.
18 +'git-diff' [--options] [--] [<path>...]::
19
23 -* When one <tree-ish> is given, the working tree and the named
24 - tree are compared, using `git-diff-index`. The option
25 - `--cached` can be given to compare the index file and
26 - the named tree.
20 + This form is to view the changes you made relative to
21 + the index (staging area for the next commit). In other
22 + words, the differences are what you _could_ tell git to
23 + further add to the index but you still haven't. You can
24 + stage these changes by using gitlink:git-add[1].
25 +
26 +'git-diff' [--options] --cached [<commit>] [--] [<path>...]::
27 +
28 + This form is to view the changes you staged for the next
29 + commit relative to the named <tree-ish>. Typically you
30 + would want comparison with the latest commit, so if you
31 + do not give <commit>, it defaults to HEAD.
32 +
33 +'git-diff' [--options] <commit> -- [<path>...]::
34 +
35 + This form is to view the changes you have in your
36 + working tree relative to the named <commit>. You can
37 + use HEAD to compare it with the latest commit, or a
38 + branch name to compare with the tip of a different
39 + branch.
40 +
41 +'git-diff' [--options] <commit> <commit> -- [<path>...]::
42 +
43 + This form is to view the changes between two <commit>,
44 + for example, tips of two branches.
45 +
46 +Just in case if you are doing something exotic, it should be
47 +noted that all of the <commit> in the above description can be
48 +any <tree-ish>.
49
28 -* When two <tree-ish>s are given, these two trees are compared
29 - using `git-diff-tree`.
50
51 OPTIONS
52 -------
33 ---diff-options::
34 - '--diff-options' are passed to the `git-diff-files`,
35 - `git-diff-index`, and `git-diff-tree` commands. See the
36 - documentation for these commands for description.
53 +include::diff-options.txt[]
54
55 <path>...::
39 - The <path> arguments are also passed to `git-diff-\*`
40 - commands.
56 + The <paths> parameters, when given, are used to limit
57 + the diff to the named paths (you can give directory
58 + names and get diff for all files under them).
59
60
61 EXAMPLES
@@ -51,7 +69,7 @@ $ git diff --cached <2>
69 $ git diff HEAD <3>
70 ------------
71 +
54 -<1> changes in the working tree since your last git-update-index.
72 +<1> changes in the working tree not yet staged for the next commit.
73 <2> changes between the index and your last commit; what you
74 would be committing if you run "git commit" without "-a" option.
75 <3> changes in the working tree since your last commit; what you