Code

Document --left-right option to rev-list.
[git.git] / Documentation / git-diff.txt
index 127d68c9620971be2854d42b7d5fbd0a6c85b356..044cee9b425bedc7addd9a4418b553557902711b 100644 (file)
@@ -8,7 +8,7 @@ git-diff - Show changes between commits, commit and working tree, etc
 
 SYNOPSIS
 --------
-'git-diff' [ --diff-options ] <tree-ish>{0,2} [<path>...]
+'git-diff' [<common diff options>] <commit>{0,2} [--] [<path>...]
 
 DESCRIPTION
 -----------
@@ -23,14 +23,18 @@ tree and the index file, or the index file and the working tree.
        further add to the index but you still haven't.  You can
        stage these changes by using gitlink:git-add[1].
 
+       If exactly two paths are given, and at least one is untracked,
+       compare the two files / directories. This behavior can be
+       forced by --no-index.
+
 'git-diff' [--options] --cached [<commit>] [--] [<path>...]::
 
        This form is to view the changes you staged for the next
-       commit relative to the named <tree-ish>.  Typically you
+       commit relative to the named <commit>.  Typically you
        would want comparison with the latest commit, so if you
        do not give <commit>, it defaults to HEAD.
 
-'git-diff' [--options] <commit> -- [<path>...]::
+'git-diff' [--options] <commit> [--] [<path>...]::
 
        This form is to view the changes you have in your
        working tree relative to the named <commit>.  You can
@@ -38,7 +42,7 @@ tree and the index file, or the index file and the working tree.
        branch name to compare with the tip of a different
        branch.
 
-'git-diff' [--options] <commit> <commit> -- [<path>...]::
+'git-diff' [--options] <commit> <commit> [--] [<path>...]::
 
        This form is to view the changes between two <commit>,
        for example, tips of two branches.
@@ -47,6 +51,9 @@ Just in case if you are doing something exotic, it should be
 noted that all of the <commit> in the above description can be
 any <tree-ish>.
 
+For a more complete list of ways to spell <commit>, see
+"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
+
 
 OPTIONS
 -------