Documentation/git-cvsserver: Fix typo
[git] / Documentation / diff-options.txt
1 // Please don't remove this comment as asciidoc behaves badly when
2 // the first non-empty line is ifdef/ifndef. The symptom is that
3 // without this comment the <git-diff-core> attribute conditionally
4 // defined below ends up being defined unconditionally.
5 // Last checked with asciidoc 7.0.2.
6
7 ifndef::git-format-patch[]
8 ifndef::git-diff[]
9 ifndef::git-log[]
10 :git-diff-core: 1
11 endif::git-log[]
12 endif::git-diff[]
13 endif::git-format-patch[]
14
15 ifdef::git-format-patch[]
16 -p::
17         Generate patches without diffstat.
18 endif::git-format-patch[]
19
20 ifndef::git-format-patch[]
21 -p::
22         Generate patch (see section on generating patches).
23         {git-diff? This is the default.}
24 endif::git-format-patch[]
25
26 -u::
27         Synonym for "-p".
28
29 -U<n>::
30         Shorthand for "--unified=<n>".
31
32 --unified=<n>::
33         Generate diffs with <n> lines of context instead of
34         the usual three. Implies "-p".
35
36 --raw::
37         Generate the raw format.
38         {git-diff-core? This is the default.}
39
40 --patch-with-raw::
41         Synonym for "-p --raw".
42
43 --stat[=width[,name-width]]::
44         Generate a diffstat.  You can override the default
45         output width for 80-column terminal by "--stat=width".
46         The width of the filename part can be controlled by
47         giving another width to it separated by a comma.
48
49 --numstat::
50         Similar to \--stat, but shows number of added and
51         deleted lines in decimal notation and pathname without
52         abbreviation, to make it more machine friendly.  For
53         binary files, outputs two `-` instead of saying
54         `0 0`.
55
56 --shortstat::
57         Output only the last line of the --stat format containing total
58         number of modified files, as well as number of added and deleted
59         lines.
60
61 --summary::
62         Output a condensed summary of extended header information
63         such as creations, renames and mode changes.
64
65 --patch-with-stat::
66         Synonym for "-p --stat".
67         {git-format-patch? This is the default.}
68
69 -z::
70         NUL-line termination on output.  This affects the --raw
71         output field terminator.  Also output from commands such
72         as "git-log" will be delimited with NUL between commits.
73
74 --name-only::
75         Show only names of changed files.
76
77 --name-status::
78         Show only names and status of changed files.
79
80 --color::
81         Show colored diff.
82
83 --no-color::
84         Turn off colored diff, even when the configuration file
85         gives the default to color output.
86
87 --color-words::
88         Show colored word diff, i.e. color words which have changed.
89
90 --no-renames::
91         Turn off rename detection, even when the configuration
92         file gives the default to do so.
93
94 --check::
95         Warn if changes introduce trailing whitespace
96         or an indent that uses a space before a tab. Exits with
97         non-zero status if problems are found. Not compatible with
98         --exit-code.
99
100 --full-index::
101         Instead of the first handful characters, show full
102         object name of pre- and post-image blob on the "index"
103         line when generating a patch format output.
104
105 --binary::
106         In addition to --full-index, output "binary diff" that
107         can be applied with "git apply".
108
109 --abbrev[=<n>]::
110         Instead of showing the full 40-byte hexadecimal object
111         name in diff-raw format output and diff-tree header
112         lines, show only handful hexdigits prefix.  This is
113         independent of --full-index option above, which controls
114         the diff-patch output format.  Non default number of
115         digits can be specified with --abbrev=<n>.
116
117 -B::
118         Break complete rewrite changes into pairs of delete and create.
119
120 -M::
121         Detect renames.
122
123 -C::
124         Detect copies as well as renames.  See also `--find-copies-harder`.
125
126 --diff-filter=[ACDMRTUXB*]::
127         Select only files that are Added (`A`), Copied (`C`),
128         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
129         type (mode) changed (`T`), are Unmerged (`U`), are
130         Unknown (`X`), or have had their pairing Broken (`B`).
131         Any combination of the filter characters may be used.
132         When `*` (All-or-none) is added to the combination, all
133         paths are selected if there is any file that matches
134         other criteria in the comparison; if there is no file
135         that matches other criteria, nothing is selected.
136
137 --find-copies-harder::
138         For performance reasons, by default, `-C` option finds copies only
139         if the original file of the copy was modified in the same
140         changeset.  This flag makes the command
141         inspect unmodified files as candidates for the source of
142         copy.  This is a very expensive operation for large
143         projects, so use it with caution.  Giving more than one
144         `-C` option has the same effect.
145
146 -l<num>::
147         -M and -C options require O(n^2) processing time where n
148         is the number of potential rename/copy targets.  This
149         option prevents rename/copy detection from running if
150         the number of rename/copy targets exceeds the specified
151         number.
152
153 -S<string>::
154         Look for differences that contain the change in <string>.
155
156 --pickaxe-all::
157         When -S finds a change, show all the changes in that
158         changeset, not just the files that contain the change
159         in <string>.
160
161 --pickaxe-regex::
162         Make the <string> not a plain string but an extended POSIX
163         regex to match.
164
165 -O<orderfile>::
166         Output the patch in the order specified in the
167         <orderfile>, which has one shell glob pattern per line.
168
169 -R::
170         Swap two inputs; that is, show differences from index or
171         on-disk file to tree contents.
172
173 --text::
174         Treat all files as text.
175
176 -a::
177         Shorthand for "--text".
178
179 --ignore-space-at-eol::
180         Ignore changes in whitespace at EOL.
181
182 --ignore-space-change::
183         Ignore changes in amount of whitespace.  This ignores whitespace
184         at line end, and considers all other sequences of one or
185         more whitespace characters to be equivalent.
186
187 -b::
188         Shorthand for "--ignore-space-change".
189
190 --ignore-all-space::
191         Ignore whitespace when comparing lines.  This ignores
192         differences even if one line has whitespace where the other
193         line has none.
194
195 -w::
196         Shorthand for "--ignore-all-space".
197
198 --exit-code::
199         Make the program exit with codes similar to diff(1).
200         That is, it exits with 1 if there were differences and
201         0 means no differences.
202
203 --quiet::
204         Disable all output of the program. Implies --exit-code.
205
206 --ext-diff::
207         Allow an external diff helper to be executed. If you set an
208         external diff driver with linkgit:gitattributes[5], you need
209         to use this option with linkgit:git-log[1] and friends.
210
211 --no-ext-diff::
212         Disallow external diff drivers.
213
214 --src-prefix=<prefix>::
215         Show the given source prefix instead of "a/".
216
217 --dst-prefix=<prefix>::
218         Show the given destination prefix instead of "b/".
219
220 --no-prefix::
221         Do not show any source or destination prefix.
222
223 For more detailed explanation on these common options, see also
224 link:diffcore.html[diffcore documentation].