[PATCH] Update diff documentation.
[git.git] / Documentation / git-diff-stages.txt
1 git-diff-stages(1)
2 ==================
3 v0.1, June 2005
4
5 NAME
6 ----
7 git-diff-stages - Compares content and mode of blobs between stages in an unmerged index file.
8
9
10 SYNOPSIS
11 --------
12 'git-diff-stages' [-p] [-r] [-z] [-R] [-B] [-M] [-C] [--find-copies-harder] [-O<orderfile>] [-S<string>] [--pickaxe-all] <stage1> <stage2> [<path>...]
13
14 DESCRIPTION
15 -----------
16 Compares the content and mode of the blobs in two stages in an
17 unmerged index file.
18
19 OPTIONS
20 -------
21 <stage1>,<stage2>::
22         The stage number to be compared.
23
24 -p::
25         Generate patch (see section on generating patches)
26
27 -r::
28         This flag does not mean anything.  It is there only to match
29         "git-diff-tree".  Unlike "git-diff-tree", "git-diff-stages"
30         always looks at all the subdirectories.
31
32 -z::
33         \0 line termination on output
34
35 -B::
36         Break complete rewrite changes into pairs of delete and create.
37
38 -M::
39         Detect renames.
40
41 -C::
42         Detect copies as well as renames.
43
44 --find-copies-harder::
45         By default, -C option finds copies only if the original
46         file of the copy was modified in the same changeset for
47         performance reasons.  This flag makes the command
48         inspect unmodified files as candidates for the source of
49         copy.  This is a very expensive operation for large
50         projects, so use it with caution.
51
52 -S<string>::
53         Look for differences that contains the change in <string>.
54
55 --pickaxe-all::
56         When -S finds a change, show all the changes in that
57         changeset, not just the files that contains the change
58         in <string>.
59
60 -O<orderfile>::
61         Output the patch in the order specified in the
62         <orderfile>, which has one shell glob pattern per line.
63
64 -R::
65         Swap two inputs; that is, show differences from <stage2> to
66         <stage1>.
67
68 Output format
69 -------------
70 include::diff-format.txt[]
71
72
73 Author
74 ------
75 Written by Junio C Hamano <junkio@cox.net>
76
77 Documentation
78 --------------
79 Documentation by Junio C Hamano.
80
81 GIT
82 ---
83 Part of the link:git.html[git] suite