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>
maint
Björn Gustavsson 2009-11-07 10:52:29 +01:00 committed by Junio C Hamano
parent 02bc5b03f5
commit d4cb003fff
1 changed files with 12 additions and 2 deletions

View File

@ -32,9 +32,11 @@ ifndef::git-format-patch[]
Implies "-p". Implies "-p".
endif::git-format-patch[] endif::git-format-patch[]


ifndef::git-format-patch[]
--raw:: --raw::
Generate the raw format. Generate the raw format.
{git-diff-core? This is the default.} {git-diff-core? This is the default.}
endif::git-format-patch[]


ifndef::git-format-patch[] ifndef::git-format-patch[]
--patch-with-raw:: --patch-with-raw::
@ -81,19 +83,18 @@ ifndef::git-format-patch[]
Synonym for "-p --stat". Synonym for "-p --stat".
endif::git-format-patch[] endif::git-format-patch[]


ifndef::git-format-patch[]
-z:: -z::
NUL-line termination on output. This affects the --raw NUL-line termination on output. This affects the --raw
output field terminator. Also output from commands such output field terminator. Also output from commands such
as "git-log" will be delimited with NUL between commits. as "git-log" will be delimited with NUL between commits.


ifndef::git-format-patch[]
--name-only:: --name-only::
Show only names of changed files. Show only names of changed files.


--name-status:: --name-status::
Show only names and status of changed files. See the description Show only names and status of changed files. See the description
of the `--diff-filter` option on what the status letters mean. of the `--diff-filter` option on what the status letters mean.
endif::git-format-patch[]


--color:: --color::
Show colored diff. Show colored diff.
@ -118,6 +119,7 @@ The regex can also be set via a diff driver or configuration option, see
linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly
overrides any diff driver or configuration setting. Diff drivers overrides any diff driver or configuration setting. Diff drivers
override configuration settings. override configuration settings.
endif::git-format-patch[]


--no-renames:: --no-renames::
Turn off rename detection, even when the configuration Turn off rename detection, even when the configuration
@ -157,6 +159,7 @@ endif::git-format-patch[]
-C:: -C::
Detect copies as well as renames. See also `--find-copies-harder`. Detect copies as well as renames. See also `--find-copies-harder`.


ifndef::git-format-patch[]
--diff-filter=[ACDMRTUXB*]:: --diff-filter=[ACDMRTUXB*]::
Select only files that are Added (`A`), Copied (`C`), Select only files that are Added (`A`), Copied (`C`),
Deleted (`D`), Modified (`M`), Renamed (`R`), have their Deleted (`D`), Modified (`M`), Renamed (`R`), have their
@ -168,6 +171,7 @@ endif::git-format-patch[]
paths are selected if there is any file that matches paths are selected if there is any file that matches
other criteria in the comparison; if there is no file other criteria in the comparison; if there is no file
that matches other criteria, nothing is selected. that matches other criteria, nothing is selected.
endif::git-format-patch[]


--find-copies-harder:: --find-copies-harder::
For performance reasons, by default, `-C` option finds copies only For performance reasons, by default, `-C` option finds copies only
@ -185,6 +189,7 @@ endif::git-format-patch[]
the number of rename/copy targets exceeds the specified the number of rename/copy targets exceeds the specified
number. number.


ifndef::git-format-patch[]
-S<string>:: -S<string>::
Look for differences that introduce or remove an instance of Look for differences that introduce or remove an instance of
<string>. Note that this is different than the string simply <string>. Note that this is different than the string simply
@ -199,11 +204,13 @@ endif::git-format-patch[]
--pickaxe-regex:: --pickaxe-regex::
Make the <string> not a plain string but an extended POSIX Make the <string> not a plain string but an extended POSIX
regex to match. regex to match.
endif::git-format-patch[]


-O<orderfile>:: -O<orderfile>::
Output the patch in the order specified in the Output the patch in the order specified in the
<orderfile>, which has one shell glob pattern per line. <orderfile>, which has one shell glob pattern per line.


ifndef::git-format-patch[]
-R:: -R::
Swap two inputs; that is, show differences from index or Swap two inputs; that is, show differences from index or
on-disk file to tree contents. on-disk file to tree contents.
@ -215,6 +222,7 @@ endif::git-format-patch[]
not in a subdirectory (e.g. in a bare repository), you not in a subdirectory (e.g. in a bare repository), you
can name which subdirectory to make the output relative can name which subdirectory to make the output relative
to by giving a <path> as an argument. to by giving a <path> as an argument.
endif::git-format-patch[]


-a:: -a::
--text:: --text::
@ -239,6 +247,7 @@ endif::git-format-patch[]
Show the context between diff hunks, up to the specified number Show the context between diff hunks, up to the specified number
of lines, thereby fusing hunks that are close to each other. of lines, thereby fusing hunks that are close to each other.


ifndef::git-format-patch[]
--exit-code:: --exit-code::
Make the program exit with codes similar to diff(1). Make the program exit with codes similar to diff(1).
That is, it exits with 1 if there were differences and That is, it exits with 1 if there were differences and
@ -246,6 +255,7 @@ endif::git-format-patch[]


--quiet:: --quiet::
Disable all output of the program. Implies --exit-code. Disable all output of the program. Implies --exit-code.
endif::git-format-patch[]


--ext-diff:: --ext-diff::
Allow an external diff helper to be executed. If you set an Allow an external diff helper to be executed. If you set an