summaryrefslogtreecommitdiffstats
path: root/git-format-patch.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2009-11-21 17:37:37 +0000
committerJunio C Hamano <junio@hera.kernel.org>2009-11-21 17:37:37 +0000
commit3b70d3c788363466e56886d9fc5d316659cda627 (patch)
tree93140aff56d58afe94727490c401e1cbe78f2748 /git-format-patch.html
parenta5574469119a1d5e9f98cc629e1959eca9719ba9 (diff)
downloadgit-htmldocs-3b70d3c788363466e56886d9fc5d316659cda627.tar.gz
Autogenerated HTML docs for v1.6.5.3-298-g39add
Diffstat (limited to 'git-format-patch.html')
-rw-r--r--git-format-patch.html277
1 files changed, 40 insertions, 237 deletions
diff --git a/git-format-patch.html b/git-format-patch.html
index 4d5c9178d..c63f10c13 100644
--- a/git-format-patch.html
+++ b/git-format-patch.html
@@ -360,24 +360,24 @@ Generic &lt;revision range&gt; expression (see "SPECIFYING
</ol></div>
<div class="para"><p>The first rule takes precedence in the case of a single &lt;commit&gt;. To
apply the second rule, i.e., format everything since the beginning of
-history up until &lt;commit&gt;, use the <em>--root</em> option: "git format-patch
---root &lt;commit&gt;". If you want to format only &lt;commit&gt; itself, you
-can do this with "git format-patch -1 &lt;commit&gt;".</p></div>
+history up until &lt;commit&gt;, use the <em>--root</em> option: <tt>git format-patch
+--root &lt;commit&gt;</tt>. If you want to format only &lt;commit&gt; itself, you
+can do this with <tt>git format-patch -1 &lt;commit&gt;</tt>.</p></div>
<div class="para"><p>By default, each output file is numbered sequentially from 1, and uses the
first line of the commit message (massaged for pathname safety) as
-the filename. With the --numbered-files option, the output file names
+the filename. With the <tt>--numbered-files</tt> option, the output file names
will only be numbers, without the first line of the commit appended.
The names of the output files are printed to standard
-output, unless the --stdout option is specified.</p></div>
-<div class="para"><p>If -o is specified, output files are created in &lt;dir&gt;. Otherwise
+output, unless the <tt>--stdout</tt> option is specified.</p></div>
+<div class="para"><p>If <tt>-o</tt> is specified, output files are created in &lt;dir&gt;. Otherwise
they are created in the current working directory.</p></div>
<div class="para"><p>By default, the subject of a single patch is "[PATCH] First Line" and
the subject when multiple patches are output is "[PATCH n/m] First
-Line". To force 1/1 to be added for a single patch, use -n. To omit
-patch numbers from the subject, use -N</p></div>
-<div class="para"><p>If given --thread, <em>git-format-patch</em> will generate In-Reply-To and
-References headers to make the second and subsequent patch mails appear
-as replies to the first mail; this also generates a Message-Id header to
+Line". To force 1/1 to be added for a single patch, use <tt>-n</tt>. To omit
+patch numbers from the subject, use <tt>-N</tt>.</p></div>
+<div class="para"><p>If given <tt>--thread</tt>, <tt>git-format-patch</tt> will generate <tt>In-Reply-To</tt> and
+<tt>References</tt> headers to make the second and subsequent patch mails appear
+as replies to the first mail; this also generates a <tt>Message-Id</tt> header to
reference.</p></div>
</div>
<h2 id="_options">OPTIONS</h2>
@@ -386,9 +386,12 @@ reference.</p></div>
<dt>
-p
</dt>
+<dt>
+--no-stat
+</dt>
<dd>
<p>
- Generate patches without diffstat.
+ Generate plain patches without any diffstats.
</p>
</dd>
<dt>
@@ -400,24 +403,7 @@ reference.</p></div>
<dd>
<p>
Generate diffs with &lt;n&gt; lines of context instead of
- the usual three. Implies "-p".
-</p>
-</dd>
-<dt>
---raw
-</dt>
-<dd>
-<p>
- Generate the raw format.
-
-</p>
-</dd>
-<dt>
---patch-with-raw
-</dt>
-<dd>
-<p>
- Synonym for "-p --raw".
+ the usual three.
</p>
</dd>
<dt>
@@ -434,7 +420,7 @@ reference.</p></div>
<dd>
<p>
Generate a diffstat. You can override the default
- output width for 80-column terminal by "--stat=width".
+ output width for 80-column terminal by <tt>--stat=width</tt>.
The width of the filename part can be controlled by
giving another width to it separated by a comma.
</p>
@@ -444,7 +430,7 @@ reference.</p></div>
</dt>
<dd>
<p>
- Similar to --stat, but shows number of added and
+ Similar to <tt>--stat</tt>, but shows number of added and
deleted lines in decimal notation and pathname without
abbreviation, to make it more machine friendly. For
binary files, outputs two <tt>-</tt> instead of saying
@@ -456,7 +442,7 @@ reference.</p></div>
</dt>
<dd>
<p>
- Output only the last line of the --stat format containing total
+ Output only the last line of the <tt>--stat</tt> format containing total
number of modified files, as well as number of added and deleted
lines.
</p>
@@ -469,8 +455,8 @@ reference.</p></div>
Output the distribution of relative amount of changes (number of lines added or
removed) for each sub-directory. Directories with changes below
a cut-off percent (3% by default) are not shown. The cut-off percent
- can be set with "--dirstat=limit". Changes in a child directory is not
- counted for the parent directory, unless "--cumulative" is used.
+ can be set with <tt>--dirstat=limit</tt>. Changes in a child directory is not
+ counted for the parent directory, unless <tt>--cumulative</tt> is used.
</p>
</dd>
<dt>
@@ -478,7 +464,7 @@ reference.</p></div>
</dt>
<dd>
<p>
- Same as --dirstat, but counts changed files instead of lines.
+ Same as <tt>--dirstat</tt>, but counts changed files instead of lines.
</p>
</dd>
<dt>
@@ -491,91 +477,6 @@ reference.</p></div>
</p>
</dd>
<dt>
---patch-with-stat
-</dt>
-<dd>
-<p>
- Synonym for "-p --stat".
- This is the default.
-</p>
-</dd>
-<dt>
--z
-</dt>
-<dd>
-<p>
- NUL-line termination on output. This affects the --raw
- output field terminator. Also output from commands such
- as "git-log" will be delimited with NUL between commits.
-</p>
-</dd>
-<dt>
---name-only
-</dt>
-<dd>
-<p>
- Show only names of changed files.
-</p>
-</dd>
-<dt>
---name-status
-</dt>
-<dd>
-<p>
- Show only names and status of changed files. See the description
- of the <tt>--diff-filter</tt> option on what the status letters mean.
-</p>
-</dd>
-<dt>
---submodule[=&lt;format&gt;]
-</dt>
-<dd>
-<p>
- Chose the output format for submodule differences. &lt;format&gt; can be one of
- <em>short</em> and <em>log</em>. <em>short</em> just shows pairs of commit names, this format
- is used when this option is not given. <em>log</em> is the default value for this
- option and lists the commits in that commit range like the <em>summary</em>
- option of <a href="git-submodule.html">git-submodule(1)</a> does.
-</p>
-</dd>
-<dt>
---color
-</dt>
-<dd>
-<p>
- Show colored diff.
-</p>
-</dd>
-<dt>
---no-color
-</dt>
-<dd>
-<p>
- Turn off colored diff, even when the configuration file
- gives the default to color output.
-</p>
-</dd>
-<dt>
---color-words[=&lt;regex&gt;]
-</dt>
-<dd>
-<p>
- Show colored word diff, i.e., color words which have changed.
- By default, words are separated by whitespace.
-</p>
-<div class="para"><p>When a &lt;regex&gt; is specified, every non-overlapping match of the
-&lt;regex&gt; is considered a word. Anything between these matches is
-considered whitespace and ignored(!) for the purposes of finding
-differences. You may want to append <tt>|[^[:space:]]</tt> to your regular
-expression to make sure that it matches all non-whitespace characters.
-A match that contains a newline is silently truncated(!) at the
-newline.</p></div>
-<div class="para"><p>The regex can also be set via a diff driver or configuration option, see
-<a href="gitattributes.html">gitattributes(1)</a> or <a href="git-config.html">git-config(1)</a>. Giving it explicitly
-overrides any diff driver or configuration setting. Diff drivers
-override configuration settings.</p></div>
-</dd>
-<dt>
--no-renames
</dt>
<dd>
@@ -585,17 +486,6 @@ override configuration settings.</p></div>
</p>
</dd>
<dt>
---check
-</dt>
-<dd>
-<p>
- Warn if changes introduce trailing whitespace
- or an indent that uses a space before a tab. Exits with
- non-zero status if problems are found. Not compatible with
- --exit-code.
-</p>
-</dd>
-<dt>
--full-index
</dt>
<dd>
@@ -610,8 +500,8 @@ override configuration settings.</p></div>
</dt>
<dd>
<p>
- In addition to --full-index, output "binary diff" that
- can be applied with "git apply".
+ In addition to <tt>--full-index</tt>, output a binary diff that
+ can be applied with <tt>git-apply</tt>.
</p>
</dd>
<dt>
@@ -622,9 +512,9 @@ override configuration settings.</p></div>
Instead of showing the full 40-byte hexadecimal object
name in diff-raw format output and diff-tree header
lines, show only a partial prefix. This is
- independent of --full-index option above, which controls
+ independent of the <tt>--full-index</tt> option above, which controls
the diff-patch output format. Non default number of
- digits can be specified with --abbrev=&lt;n&gt;.
+ digits can be specified with <tt>--abbrev=&lt;n&gt;</tt>.
</p>
</dd>
<dt>
@@ -652,23 +542,6 @@ override configuration settings.</p></div>
</p>
</dd>
<dt>
---diff-filter=[ACDMRTUXB*]
-</dt>
-<dd>
-<p>
- Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>),
- Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their
- type (i.e. regular file, symlink, submodule, &#8230;) changed (<tt>T</tt>),
- are Unmerged (<tt>U</tt>), are
- Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>).
- Any combination of the filter characters may be used.
- When <tt>*</tt> (All-or-none) is added to the combination, all
- paths are selected if there is any file that matches
- other criteria in the comparison; if there is no file
- that matches other criteria, nothing is selected.
-</p>
-</dd>
-<dt>
--find-copies-harder
</dt>
<dd>
@@ -687,7 +560,7 @@ override configuration settings.</p></div>
</dt>
<dd>
<p>
- -M and -C options require O(n^2) processing time where n
+ The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n
is the number of potential rename/copy targets. This
option prevents rename/copy detection from running if
the number of rename/copy targets exceeds the specified
@@ -695,36 +568,6 @@ override configuration settings.</p></div>
</p>
</dd>
<dt>
--S&lt;string&gt;
-</dt>
-<dd>
-<p>
- Look for differences that introduce or remove an instance of
- &lt;string&gt;. Note that this is different than the string simply
- appearing in diff output; see the <em>pickaxe</em> entry in
- <a href="gitdiffcore.html">gitdiffcore(7)</a> for more details.
-</p>
-</dd>
-<dt>
---pickaxe-all
-</dt>
-<dd>
-<p>
- When -S finds a change, show all the changes in that
- changeset, not just the files that contain the change
- in &lt;string&gt;.
-</p>
-</dd>
-<dt>
---pickaxe-regex
-</dt>
-<dd>
-<p>
- Make the &lt;string&gt; not a plain string but an extended POSIX
- regex to match.
-</p>
-</dd>
-<dt>
-O&lt;orderfile&gt;
</dt>
<dd>
@@ -734,28 +577,6 @@ override configuration settings.</p></div>
</p>
</dd>
<dt>
--R
-</dt>
-<dd>
-<p>
- Swap two inputs; that is, show differences from index or
- on-disk file to tree contents.
-</p>
-</dd>
-<dt>
---relative[=&lt;path&gt;]
-</dt>
-<dd>
-<p>
- When run from a subdirectory of the project, it can be
- told to exclude changes outside the directory and show
- pathnames relative to it with this option. When you are
- not in a subdirectory (e.g. in a bare repository), you
- can name which subdirectory to make the output relative
- to by giving a &lt;path&gt; as an argument.
-</p>
-</dd>
-<dt>
-a
</dt>
<dt>
@@ -810,24 +631,6 @@ override configuration settings.</p></div>
</p>
</dd>
<dt>
---exit-code
-</dt>
-<dd>
-<p>
- Make the program exit with codes similar to diff(1).
- That is, it exits with 1 if there were differences and
- 0 means no differences.
-</p>
-</dd>
-<dt>
---quiet
-</dt>
-<dd>
-<p>
- Disable all output of the program. Implies --exit-code.
-</p>
-</dd>
-<dt>
--ext-diff
</dt>
<dd>
@@ -980,7 +783,7 @@ override configuration settings.</p></div>
<p>
Create multipart/mixed attachment, the first part of
which is the commit message and the patch itself in the
- second part, with "Content-Disposition: attachment".
+ second part, with <tt>Content-Disposition: attachment</tt>.
</p>
</dd>
<dt>
@@ -999,7 +802,7 @@ override configuration settings.</p></div>
<p>
Create multipart/mixed attachment, the first part of
which is the commit message and the patch itself in the
- second part, with "Content-Disposition: inline".
+ second part, with <tt>Content-Disposition: inline</tt>.
</p>
</dd>
<dt>
@@ -1010,9 +813,9 @@ override configuration settings.</p></div>
</dt>
<dd>
<p>
- Controls addition of In-Reply-To and References headers to
+ Controls addition of <tt>In-Reply-To</tt> and <tt>References</tt> headers to
make the second and subsequent mails appear as replies to the
- first. Also controls generation of the Message-Id header to
+ first. Also controls generation of the <tt>Message-Id</tt> header to
reference.
</p>
<div class="para"><p>The optional &lt;style&gt; argument can be either <tt>shallow</tt> or <tt>deep</tt>.
@@ -1020,19 +823,19 @@ override configuration settings.</p></div>
series, where the head is chosen from the cover letter, the
<tt>--in-reply-to</tt>, and the first patch mail, in this order. <em>deep</em>
threading makes every mail a reply to the previous one.</p></div>
-<div class="para"><p>The default is --no-thread, unless the <em>format.thread</em> configuration
-is set. If --thread is specified without a style, it defaults to the
+<div class="para"><p>The default is <tt>--no-thread</tt>, unless the <em>format.thread</em> configuration
+is set. If <tt>--thread</tt> is specified without a style, it defaults to the
style specified by <em>format.thread</em> if any, or else <tt>shallow</tt>.</p></div>
<div class="para"><p>Beware that the default for <em>git send-email</em> is to thread emails
-itself. If you want <em>git format-patch</em> to take care of hreading, you
-will want to ensure that threading is disabled for <em>git send-email</em>.</p></div>
+itself. If you want <tt>git format-patch</tt> to take care of threading, you
+will want to ensure that threading is disabled for <tt>git send-email</tt>.</p></div>
</dd>
<dt>
--in-reply-to=Message-Id
</dt>
<dd>
<p>
- Make the first mail (or all the mails with --no-thread) appear as a
+ Make the first mail (or all the mails with <tt>--no-thread</tt>) appear as a
reply to the given Message-Id, which avoids breaking threads to
provide a new patch series.
</p>
@@ -1057,7 +860,7 @@ will want to ensure that threading is disabled for <em>git send-email</em>.</p><
Instead of the standard <em>[PATCH]</em> prefix in the subject
line, instead use <em>[&lt;Subject-Prefix&gt;]</em>. This
allows for useful naming of a patch series, and can be
- combined with the --numbered option.
+ combined with the <tt>--numbered</tt> option.
</p>
</dd>
<dt>
@@ -1065,7 +868,7 @@ will want to ensure that threading is disabled for <em>git send-email</em>.</p><
</dt>
<dd>
<p>
- Add a "Cc:" header to the email headers. This is in addition
+ Add a <tt>Cc:</tt> header to the email headers. This is in addition
to any configured headers, and may be used multiple times.
</p>
</dd>
@@ -1076,7 +879,7 @@ will want to ensure that threading is disabled for <em>git send-email</em>.</p><
<p>
Add an arbitrary header to the email headers. This is in addition
to any configured headers, and may be used multiple times.
- For example, --add-header="Organization: git-foo"
+ For example, <tt>--add-header="Organization: git-foo"</tt>
</p>
</dd>
<dt>
@@ -1223,7 +1026,7 @@ as e-mailable patches:
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2009-11-15 09:57:08 UTC
+Last updated 2009-11-21 17:36:56 UTC
</div>
</div>
</body>