format-patch documentation: Remove diff options that are not useful
To simplify reading the documentation for format-patch, remove the description of common diff options that are not useful for the purpose of the command (i.e. "Prepare patches for e-mail submission"). Specifically, this removes the description of the following options: --raw -z --color --no-color --color-words --diff-filter -S --pickaxe-all --pickaxe-regex -R --relative --exit-code --quiet Signed-off-by: Björn Gustavsson <bgustavsson@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Björn Gustavsson committed
Nov 7, 2009 at 10:52 UTC
d4cb003fffe2af3b868f57d75a352714e7ab03ac
1 file changed
+12
-2
Documentation/diff-options.txt
+12
-2
@@ -32,9 +32,11 @@ ifndef::git-format-patch[]
32
Implies "-p".
33
endif::git-format-patch[]
34
35
+ifndef::git-format-patch[]
36
--raw::
37
Generate the raw format.
38
{git-diff-core? This is the default.}
39
+endif::git-format-patch[]
40
41
ifndef::git-format-patch[]
42
--patch-with-raw::
@@ -81,19 +83,18 @@ ifndef::git-format-patch[]
83
Synonym for "-p --stat".
84
endif::git-format-patch[]
85
86
+ifndef::git-format-patch[]
87
-z::
88
NUL-line termination on output. This affects the --raw
89
output field terminator. Also output from commands such
90
as "git-log" will be delimited with NUL between commits.
91
89
-ifndef::git-format-patch[]
92
--name-only::
93
Show only names of changed files.
94
95
--name-status::
96
Show only names and status of changed files. See the description
97
of the `--diff-filter` option on what the status letters mean.
96
-endif::git-format-patch[]
98
99
--color::
100
Show colored diff.
@@ -118,6 +119,7 @@ The regex can also be set via a diff driver or configuration option, see
119
linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
120
overrides any diff driver or configuration setting. Diff drivers
121
override configuration settings.
122
+endif::git-format-patch[]
123
124
--no-renames::
125
Turn off rename detection, even when the configuration
@@ -157,6 +159,7 @@ endif::git-format-patch[]
159
-C::
160
Detect copies as well as renames. See also `--find-copies-harder`.
161
162
+ifndef::git-format-patch[]
163
--diff-filter=[ACDMRTUXB*]::
164
Select only files that are Added (`A`), Copied (`C`),
165
Deleted (`D`), Modified (`M`), Renamed (`R`), have their
@@ -168,6 +171,7 @@ endif::git-format-patch[]
171
paths are selected if there is any file that matches
172
other criteria in the comparison; if there is no file
173
that matches other criteria, nothing is selected.
174
+endif::git-format-patch[]
175
176
--find-copies-harder::
177
For performance reasons, by default, `-C` option finds copies only
@@ -185,6 +189,7 @@ endif::git-format-patch[]
189
the number of rename/copy targets exceeds the specified
190
number.
191
192
+ifndef::git-format-patch[]
193
-S<string>::
194
Look for differences that introduce or remove an instance of
195
<string>. Note that this is different than the string simply
@@ -199,11 +204,13 @@ endif::git-format-patch[]
204
--pickaxe-regex::
205
Make the <string> not a plain string but an extended POSIX
206
regex to match.
207
+endif::git-format-patch[]
208
209
-O<orderfile>::
210
Output the patch in the order specified in the
211
<orderfile>, which has one shell glob pattern per line.
212
213
+ifndef::git-format-patch[]
214
-R::
215
Swap two inputs; that is, show differences from index or
216
on-disk file to tree contents.
@@ -215,6 +222,7 @@ endif::git-format-patch[]
222
not in a subdirectory (e.g. in a bare repository), you
223
can name which subdirectory to make the output relative
224
to by giving a <path> as an argument.
225
+endif::git-format-patch[]
226
227
-a::
228
--text::
@@ -239,6 +247,7 @@ endif::git-format-patch[]
247
Show the context between diff hunks, up to the specified number
248
of lines, thereby fusing hunks that are close to each other.
249
250
+ifndef::git-format-patch[]
251
--exit-code::
252
Make the program exit with codes similar to diff(1).
253
That is, it exits with 1 if there were differences and
@@ -246,6 +255,7 @@ endif::git-format-patch[]
255
256
--quiet::
257
Disable all output of the program. Implies --exit-code.
258
+endif::git-format-patch[]
259
260
--ext-diff::
261
Allow an external diff helper to be executed. If you set an