git-rev-list(1): group options; reformat; document more options
[gitweb.git] / Documentation / git-diff-files.txt
index ba257e8fb075df302f304912b0207f27c2a204bb..7248b35d952c3fe97496895059af35300694eb98 100644 (file)
@@ -1,56 +1,43 @@
 git-diff-files(1)
 =================
-v0.1, May 2005
 
 NAME
 ----
-git-diff-files - Compares files in the working tree and the cache
+git-diff-files - Compares files in the working tree and the index
 
 
 SYNOPSIS
 --------
-'git-diff-files' [-p] [-q] [-r] [-z] [-B] [-M] [-C] [-R] [-S<string>] [--pickaxe-all] [<pattern>...]
+'git-diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
 
 DESCRIPTION
 -----------
-Compares the files in the working tree and the cache.  When paths
+Compares the files in the working tree and the index.  When paths
 are specified, compares only those named paths.  Otherwise all
-entries in the cache are compared.  The output format is the
-same as "git-diff-cache" and "git-diff-tree".
+entries in the index are compared.  The output format is the
+same as "git-diff-index" and "git-diff-tree".
 
 OPTIONS
 -------
--p::
-       generate patch (see section on generating patches).
+include::diff-options.txt[]
+
+-1 -2 -3 or --base --ours --theirs, and -0::
+       Diff against the "base" version, "our branch" or "their
+       branch" respectively.  With these options, diffs for
+       merged entries are not shown.
++
+The default is to diff against our branch (-2) and the 
+cleanly resolved paths.  The option -0 can be given to
+omit diff output for unmerged entries and just show "Unmerged".
+
+-c,--cc::
+       This compares stage 2 (our branch), stage 3 (their
+       branch) and the working tree file and outputs a combined
+       diff, similar to the way 'diff-tree' shows a merge
+       commit with these flags.
 
 -q::
-       Remain silent even on nonexisting files
-
--R::
-       Output diff in reverse.
-
--B::
-       Break complete rewrite changes into pairs of delete and create.
-
--M::
-       Detect renames.
-
--C::
-       Detect copies as well as renames.
-
--S<string>::
-       Look for differences that contains the change in <string>.
-
---pickaxe-all::
-       When -S finds a change, show all the changes in that
-       changeset, not just the files that contains the change
-       in <string>.
-
--r::
-       This flag does not mean anything.  It is there only to match
-       git-diff-tree.  Unlike git-diff-tree, git-diff-files always looks
-       at all the subdirectories.
-
+       Remain silent even on nonexistent files
 
 Output format
 -------------
@@ -67,5 +54,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite