git-format-patch.html - external/gitster/git-htmldocs - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
 <meta name="generator" content="AsciiDoc 7.0.2" />
 <style type="text/css">
 /* Debug borders */
 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
 /*
  border: 1px solid red;
 */
 }

 body {
  margin: 1em 5% 1em 5%;
 }

 a { color: blue; }
 a:visited { color: fuchsia; }

 em {
  font-style: italic;
 }

 strong {
  font-weight: bold;
 }

 tt {
  color: navy;
 }

 h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  font-family: sans-serif;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
 }

 h1 {
  border-bottom: 2px solid silver;
 }
 h2 {
  border-bottom: 2px solid silver;
  padding-top: 0.5em;
 }

 div.sectionbody {
  font-family: serif;
  margin-left: 0;
 }

 hr {
  border: 1px solid silver;
 }

 p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
 }

 pre {
  padding: 0;
  margin: 0;
 }

 span#author {
  color: #527bbd;
  font-family: sans-serif;
  font-weight: bold;
  font-size: 1.2em;
 }
 span#email {
 }
 span#revision {
  font-family: sans-serif;
 }

 div#footer {
  font-family: sans-serif;
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
 }
 div#footer-text {
  float: left;
  padding-bottom: 0.5em;
 }
 div#footer-badges {
  float: right;
  padding-bottom: 0.5em;
 }

 div#preamble,
 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 div.admonitionblock {
  margin-right: 10%;
  margin-top: 1.5em;
  margin-bottom: 1.5em;
 }
 div.admonitionblock {
  margin-top: 2.5em;
  margin-bottom: 2.5em;
 }

 div.content { /* Block element content. */
  padding: 0;
 }

 /* Block element titles. */
 div.title, caption.title {
  font-family: sans-serif;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
 }
 div.title + * {
  margin-top: 0;
 }

 td div.title:first-child {
  margin-top: 0.0em;
 }
 div.content div.title:first-child {
  margin-top: 0.0em;
 }
 div.content + div.title {
  margin-top: 0.0em;
 }

 div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }

 div.listingblock > div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock > div.content {
  padding-left: 2.0em;
 }
 div.quoteblock .attribution {
  text-align: right;
 }

 div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
 }
 div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 2px solid silver;
 }

 div.exampleblock > div.content {
  border-left: 2px solid silver;
  padding: 0.5em;
 }

 div.verseblock div.content {
  white-space: pre;
 }

 div.imageblock div.content { padding-left: 0; }
 div.imageblock img { border: 1px solid silver; }
 span.image img { border-style: none; }

 dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: italic;
 }
 dd > *:first-child {
  margin-top: 0;
 }

 ul, ol {
  list-style-position: outside;
 }
 ol.olist2 {
  list-style-type: lower-alpha;
 }

 div.tableblock > table {
  border-color: #527bbd;
  border-width: 3px;
 }
 thead {
  font-family: sans-serif;
  font-weight: bold;
 }
 tfoot {
  font-weight: bold;
 }

 div.hlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
 }
 td.hlist1 {
  vertical-align: top;
  font-style: italic;
  padding-right: 0.8em;
 }
 td.hlist2 {
  vertical-align: top;
 }

 @media print {
  div#footer-badges { display: none; }
 }
 include::./stylesheets/xhtml11-manpage.css[]
 /* Workarounds for IE6's broken and incomplete CSS2. */

 div.sidebar-content {
  background: #ffffee;
  border: 1px solid silver;
  padding: 0.5em;
 }
 div.sidebar-title, div.image-title {
  font-family: sans-serif;
  font-weight: bold;
  margin-top: 0.0em;
  margin-bottom: 0.5em;
 }

 div.listingblock div.content {
  border: 1px solid silver;
  background: #f4f4f4;
  padding: 0.5em;
 }

 div.quoteblock-content {
  padding-left: 2.0em;
 }

 div.exampleblock-content {
  border-left: 2px solid silver;
  padding-left: 0.5em;
 }
 </style>
 <title>git-format-patch(1)</title>
 </head>
 <body>
 <div id="header">
 <h1>
 git-format-patch(1) Manual Page
 </h1>
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>git-format-patch -
  Prepare patches for e-mail submission
 </p>
 </div>
 </div>
 <h2>SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
 <div class="content"><em>git-format-patch</em> [-n | -k] [-o &lt;dir&gt; | --stdout] [--thread]
  [--attach[=&lt;boundary&gt;] | --inline[=&lt;boundary&gt;]]
  [-s | --signoff] [&lt;common diff options&gt;]
  [--start-number &lt;n&gt;] [--numbered-files]
  [--in-reply-to=Message-Id] [--suffix=.&lt;sfx&gt;]
  [--ignore-if-in-upstream]
  [--subject-prefix=Subject-Prefix]
  [ &lt;since&gt; | &lt;revision range&gt; ]</div></div>
 </div>
 <h2>DESCRIPTION</h2>
 <div class="sectionbody">
 <p>Prepare each commit with its patch in
 one file per commit, formatted to resemble UNIX mailbox format.
 The output of this command is convenient for e-mail submission or
 for use with <a href="git-am.html">git-am(1)</a>.</p>
 <p>There are two ways to specify which commits to operate on.</p>
 <ol>
 <li>
 <p>
 A single commit, &lt;since&gt;, specifies that the commits leading
  to the tip of the current branch that are not in the history
  that leads to the &lt;since&gt; to be output.
 </p>
 </li>
 <li>
 <p>
 Generic &lt;revision range&gt; expression (see "SPECIFYING
  REVISIONS" section in <a href="git-rev-parse.html">git-rev-parse(1)</a>) means the
  commits in the specified range.
 </p>
 </li>
 </ol>
 <p>A single commit, when interpreted as a &lt;revision range&gt;
 expression, means "everything that leads to that commit", but
 if you write <em>git format-patch &lt;commit&gt;</em>, the previous rule
 applies to that command line and you do not get "everything
 since the beginning of the time". If you want to format
 everything since project inception to one commit, say "git
 format-patch --root &lt;commit&gt;" to make it clear that it is the
 latter case.</p>
 <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
 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>
 <p>If -o is specified, output files are created in &lt;dir&gt;. Otherwise
 they are created in the current working directory.</p>
 <p>If -n is specified, instead of "[PATCH] Subject", the first line
 is formatted as "[PATCH n/m] Subject".</p>
 <p>If given --thread, git-format-patch 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
 reference.</p>
 </div>
 <h2>OPTIONS</h2>
 <div class="sectionbody">
 <dl>
 <dt>
 -p
 </dt>
 <dd>
 <p>
  Generate patch (see section on generating patches)
 </p>
 </dd>
 <dt>
 -u
 </dt>
 <dd>
 <p>
  Synonym for "-p".
 </p>
 </dd>
 <dt>
 -U&lt;n&gt;
 </dt>
 <dd>
 <p>
  Shorthand for "--unified=&lt;n&gt;".
 </p>
 </dd>
 <dt>
 --unified=&lt;n&gt;
 </dt>
 <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".
 </p>
 </dd>
 <dt>
 --stat[=width[,name-width]]
 </dt>
 <dd>
 <p>
  Generate a diffstat. You can override the default
  output width for 80-column terminal by "--stat=width".
  The width of the filename part can be controlled by
  giving another width to it separated by a comma.
 </p>
 </dd>
 <dt>
 --numstat
 </dt>
 <dd>
 <p>
  Similar to --stat, 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
  <tt>0 0</tt>.
 </p>
 </dd>
 <dt>
 --shortstat
 </dt>
 <dd>
 <p>
  Output only the last line of the --stat format containing total
  number of modified files, as well as number of added and deleted
  lines.
 </p>
 </dd>
 <dt>
 --summary
 </dt>
 <dd>
 <p>
  Output a condensed summary of extended header information
  such as creations, renames and mode changes.
 </p>
 </dd>
 <dt>
 --patch-with-stat
 </dt>
 <dd>
 <p>
  Synonym for "-p --stat".
 </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.
 </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
 </dt>
 <dd>
 <p>
  Show colored word diff, i.e. color words which have changed.
 </p>
 </dd>
 <dt>
 --no-renames
 </dt>
 <dd>
 <p>
  Turn off rename detection, even when the configuration
  file gives the default to do so.
 </p>
 </dd>
 <dt>
 --check
 </dt>
 <dd>
 <p>
  Warn if changes introduce trailing whitespace
  or an indent that uses a space before a tab.
 </p>
 </dd>
 <dt>
 --full-index
 </dt>
 <dd>
 <p>
  Instead of the first handful characters, show full
  object name of pre- and post-image blob on the "index"
  line when generating a patch format output.
 </p>
 </dd>
 <dt>
 --binary
 </dt>
 <dd>
 <p>
  In addition to --full-index, output "binary diff" that
  can be applied with "git apply".
 </p>
 </dd>
 <dt>
 --abbrev[=&lt;n&gt;]
 </dt>
 <dd>
 <p>
  Instead of showing the full 40-byte hexadecimal object
  name in diff-raw format output and diff-tree header
  lines, show only handful hexdigits prefix. This is
  independent of --full-index option above, which controls
  the diff-patch output format. Non default number of
  digits can be specified with --abbrev=&lt;n&gt;.
 </p>
 </dd>
 <dt>
 -B
 </dt>
 <dd>
 <p>
  Break complete rewrite changes into pairs of delete and create.
 </p>
 </dd>
 <dt>
 -M
 </dt>
 <dd>
 <p>
  Detect renames.
 </p>
 </dd>
 <dt>
 -C
 </dt>
 <dd>
 <p>
  Detect copies as well as renames. See also <tt>--find-copies-harder</tt>.
 </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 (mode) 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>
 <p>
  For performance reasons, by default, <tt>-C</tt> option finds copies only
  if the original file of the copy was modified in the same
  changeset. This flag makes the command
  inspect unmodified files as candidates for the source of
  copy. This is a very expensive operation for large
  projects, so use it with caution. Giving more than one
  <tt>-C</tt> option has the same effect.
 </p>
 </dd>
 <dt>
 -l&lt;num&gt;
 </dt>
 <dd>
 <p>
  -M and -C 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
  number.
 </p>
 </dd>
 <dt>
 -S&lt;string&gt;
 </dt>
 <dd>
 <p>
  Look for differences that contain the change in &lt;string&gt;.
 </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>
 <p>
  Output the patch in the order specified in the
  &lt;orderfile&gt;, which has one shell glob pattern per line.
 </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>
 --text
 </dt>
 <dd>
 <p>
  Treat all files as text.
 </p>
 </dd>
 <dt>
 -a
 </dt>
 <dd>
 <p>
  Shorthand for "--text".
 </p>
 </dd>
 <dt>
 --ignore-space-at-eol
 </dt>
 <dd>
 <p>
  Ignore changes in white spaces at EOL.
 </p>
 </dd>
 <dt>
 --ignore-space-change
 </dt>
 <dd>
 <p>
  Ignore changes in amount of white space. This ignores white
  space at line end, and consider all other sequences of one or
  more white space characters to be equivalent.
 </p>
 </dd>
 <dt>
 -b
 </dt>
 <dd>
 <p>
  Shorthand for "--ignore-space-change".
 </p>
 </dd>
 <dt>
 --ignore-all-space
 </dt>
 <dd>
 <p>
  Ignore white space when comparing lines. This ignores
  difference even if one line has white space where the other
  line has none.
 </p>
 </dd>
 <dt>
 -w
 </dt>
 <dd>
 <p>
  Shorthand for "--ignore-all-space".
 </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>
 <p>
  Allow an external diff helper to be executed. If you set an
  external diff driver with gitlink:gitattributes(5), you need
  to use this option with gitlink:git-log(1) and friends.
 </p>
 </dd>
 <dt>
 --no-ext-diff
 </dt>
 <dd>
 <p>
  Disallow external diff drivers.
 </p>
 </dd>
 </dl>
 <p>For more detailed explanation on these common options, see also
 <a href="diffcore.html">diffcore documentation</a>.</p>
 <dl>
 <dt>
 -&lt;n&gt;
 </dt>
 <dd>
 <p>
  Limits the number of patches to prepare.
 </p>
 </dd>
 <dt>
 -o|--output-directory &lt;dir&gt;
 </dt>
 <dd>
 <p>
  Use &lt;dir&gt; to store the resulting files, instead of the
  current working directory.
 </p>
 </dd>
 <dt>
 -n|--numbered
 </dt>
 <dd>
 <p>
  Name output in <em>[PATCH n/m]</em> format.
 </p>
 </dd>
 <dt>
 --start-number &lt;n&gt;
 </dt>
 <dd>
 <p>
  Start numbering the patches at &lt;n&gt; instead of 1.
 </p>
 </dd>
 <dt>
 --numbered-files
 </dt>
 <dd>
 <p>
  Output file names will be a simple number sequence
  without the default first line of the commit appended.
  Mutually exclusive with the --stdout option.
 </p>
 </dd>
 <dt>
 -k|--keep-subject
 </dt>
 <dd>
 <p>
  Do not strip/add <em>[PATCH]</em> from the first line of the
  commit log message.
 </p>
 </dd>
 <dt>
 -s|--signoff
 </dt>
 <dd>
 <p>
  Add <tt>Signed-off-by:</tt> line to the commit message, using
  the committer identity of yourself.
 </p>
 </dd>
 <dt>
 --stdout
 </dt>
 <dd>
 <p>
  Print all commits to the standard output in mbox format,
  instead of creating a file for each one.
 </p>
 </dd>
 <dt>
 --attach[=&lt;boundary&gt;]
 </dt>
 <dd>
 <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".
 </p>
 </dd>
 <dt>
 --inline[=&lt;boundary&gt;]
 </dt>
 <dd>
 <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".
 </p>
 </dd>
 <dt>
 --thread
 </dt>
 <dd>
 <p>
  Add In-Reply-To and References headers to make the second and
  subsequent mails appear as replies to the first. Also generates
  the Message-Id header to reference.
 </p>
 </dd>
 <dt>
 --in-reply-to=Message-Id
 </dt>
 <dd>
 <p>
  Make the first mail (or all the mails with --no-thread) appear as a
  reply to the given Message-Id, which avoids breaking threads to
  provide a new patch series.
 </p>
 </dd>
 <dt>
 --ignore-if-in-upstream
 </dt>
 <dd>
 <p>
  Do not include a patch that matches a commit in
  &lt;until&gt;..&lt;since&gt;. This will examine all patches reachable
  from &lt;since&gt; but not from &lt;until&gt; and compare them with the
  patches being generated, and any patch that matches is
  ignored.
 </p>
 </dd>
 <dt>
 --subject-prefix=&lt;Subject-Prefix&gt;
 </dt>
 <dd>
 <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.
 </p>
 </dd>
 <dt>
 --suffix=.&lt;sfx&gt;
 </dt>
 <dd>
 <p>
  Instead of using <tt>.patch</tt> as the suffix for generated
  filenames, use specified suffix. A common alternative is
  <tt>--suffix=.txt</tt>.
 </p>
 <p>Note that you would need to include the leading dot <tt>.</tt> if you
 want a filename like <tt>0001-description-of-my-change.patch</tt>, and
 the first letter does not have to be a dot. Leaving it empty would
 not add any suffix.</p>
 </dd>
 </dl>
 </div>
 <h2>CONFIGURATION</h2>
 <div class="sectionbody">
 <p>You can specify extra mail header lines to be added to each
 message in the repository configuration. You can also specify
 new defaults for the subject prefix and file suffix.</p>
 <div class="listingblock">
 <div class="content">
 <pre><tt>[format]
  headers = "Organization: git-foo\n"
  subjectprefix = CHANGE
  suffix = .txt</tt></pre>
 </div></div>
 </div>
 <h2>EXAMPLES</h2>
 <div class="sectionbody">
 <dl>
 <dt>
 git-format-patch -k --stdout R1..R2 | git-am -3 -k
 </dt>
 <dd>
 <p>
  Extract commits between revisions R1 and R2, and apply
  them on top of the current branch using <tt>git-am</tt> to
  cherry-pick them.
 </p>
 </dd>
 <dt>
 git-format-patch origin
 </dt>
 <dd>
 <p>
  Extract all commits which are in the current branch but
  not in the origin branch. For each commit a separate file
  is created in the current directory.
 </p>
 </dd>
 <dt>
 git-format-patch --root origin
 </dt>
 <dd>
 <p>
  Extract all commits which that leads to <em>origin</em> since the
  inception of the project.
 </p>
 </dd>
 <dt>
 git-format-patch -M -B origin
 </dt>
 <dd>
 <p>
  The same as the previous one. Additionally, it detects
  and handles renames and complete rewrites intelligently to
  produce a renaming patch. A renaming patch reduces the
  amount of text output, and generally makes it easier to
  review it. Note that the "patch" program does not
  understand renaming patches, so use it only when you know
  the recipient uses git to apply your patch.
 </p>
 </dd>
 <dt>
 git-format-patch -3
 </dt>
 <dd>
 <p>
  Extract three topmost commits from the current branch
  and format them as e-mailable patches.
 </p>
 </dd>
 </dl>
 </div>
 <h2>See Also</h2>
 <div class="sectionbody">
 <p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p>
 </div>
 <h2>Author</h2>
 <div class="sectionbody">
 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>
 </div>
 <h2>Documentation</h2>
 <div class="sectionbody">
 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
 </div>
 <h2>GIT</h2>
 <div class="sectionbody">
 <p>Part of the <a href="git.html">git(7)</a> suite</p>
 </div>
 <div id="footer">
 <div id="footer-text">
 Last updated 29-Aug-2007 07:30:57 UTC
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<meta name="generator" content="AsciiDoc 7.0.2" />
	<style type="text/css">
	/* Debug borders */
	p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
	/*
	border: 1px solid red;
	*/
	}

	body {
	margin: 1em 5% 1em 5%;
	}

	a { color: blue; }
	a:visited { color: fuchsia; }

	em {
	font-style: italic;
	}

	strong {
	font-weight: bold;
	}

	tt {
	color: navy;
	}

	h1, h2, h3, h4, h5, h6 {
	color: #527bbd;
	font-family: sans-serif;
	margin-top: 1.2em;
	margin-bottom: 0.5em;
	line-height: 1.3;
	}

	h1 {
	border-bottom: 2px solid silver;
	}
	h2 {
	border-bottom: 2px solid silver;
	padding-top: 0.5em;
	}

	div.sectionbody {
	font-family: serif;
	margin-left: 0;
	}

	hr {
	border: 1px solid silver;
	}

	p {
	margin-top: 0.5em;
	margin-bottom: 0.5em;
	}

	pre {
	padding: 0;
	margin: 0;
	}

	span#author {
	color: #527bbd;
	font-family: sans-serif;
	font-weight: bold;
	font-size: 1.2em;
	}
	span#email {
	}
	span#revision {
	font-family: sans-serif;
	}

	div#footer {
	font-family: sans-serif;
	font-size: small;
	border-top: 2px solid silver;
	padding-top: 0.5em;
	margin-top: 4.0em;
	}
	div#footer-text {
	float: left;
	padding-bottom: 0.5em;
	}
	div#footer-badges {
	float: right;
	padding-bottom: 0.5em;
	}

	div#preamble,
	div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
	div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
	div.admonitionblock {
	margin-right: 10%;
	margin-top: 1.5em;
	margin-bottom: 1.5em;
	}
	div.admonitionblock {
	margin-top: 2.5em;
	margin-bottom: 2.5em;
	}

	div.content { /* Block element content. */
	padding: 0;
	}

	/* Block element titles. */
	div.title, caption.title {
	font-family: sans-serif;
	font-weight: bold;
	text-align: left;
	margin-top: 1.0em;
	margin-bottom: 0.5em;
	}
	div.title + * {
	margin-top: 0;
	}

	td div.title:first-child {
	margin-top: 0.0em;
	}
	div.content div.title:first-child {
	margin-top: 0.0em;
	}
	div.content + div.title {
	margin-top: 0.0em;
	}

	div.sidebarblock > div.content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}

	div.listingblock > div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock > div.content {
	padding-left: 2.0em;
	}
	div.quoteblock .attribution {
	text-align: right;
	}

	div.admonitionblock .icon {
	vertical-align: top;
	font-size: 1.1em;
	font-weight: bold;
	text-decoration: underline;
	color: #527bbd;
	padding-right: 0.5em;
	}
	div.admonitionblock td.content {
	padding-left: 0.5em;
	border-left: 2px solid silver;
	}

	div.exampleblock > div.content {
	border-left: 2px solid silver;
	padding: 0.5em;
	}

	div.verseblock div.content {
	white-space: pre;
	}

	div.imageblock div.content { padding-left: 0; }
	div.imageblock img { border: 1px solid silver; }
	span.image img { border-style: none; }

	dl {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	dt {
	margin-top: 0.5em;
	margin-bottom: 0;
	font-style: italic;
	}
	dd > *:first-child {
	margin-top: 0;
	}

	ul, ol {
	list-style-position: outside;
	}
	ol.olist2 {
	list-style-type: lower-alpha;
	}

	div.tableblock > table {
	border-color: #527bbd;
	border-width: 3px;
	}
	thead {
	font-family: sans-serif;
	font-weight: bold;
	}
	tfoot {
	font-weight: bold;
	}

	div.hlist {
	margin-top: 0.8em;
	margin-bottom: 0.8em;
	}
	td.hlist1 {
	vertical-align: top;
	font-style: italic;
	padding-right: 0.8em;
	}
	td.hlist2 {
	vertical-align: top;
	}

	@media print {
	div#footer-badges { display: none; }
	}
	include::./stylesheets/xhtml11-manpage.css[]
	/* Workarounds for IE6's broken and incomplete CSS2. */

	div.sidebar-content {
	background: #ffffee;
	border: 1px solid silver;
	padding: 0.5em;
	}
	div.sidebar-title, div.image-title {
	font-family: sans-serif;
	font-weight: bold;
	margin-top: 0.0em;
	margin-bottom: 0.5em;
	}

	div.listingblock div.content {
	border: 1px solid silver;
	background: #f4f4f4;
	padding: 0.5em;
	}

	div.quoteblock-content {
	padding-left: 2.0em;
	}

	div.exampleblock-content {
	border-left: 2px solid silver;
	padding-left: 0.5em;
	}
	</style>
	<title>git-format-patch(1)</title>
	</head>
	<body>
	<div id="header">
	<h1>
	git-format-patch(1) Manual Page
	</h1>
	<h2>NAME</h2>
	<div class="sectionbody">
	<p>git-format-patch -
	Prepare patches for e-mail submission
	</p>
	</div>
	</div>
	<h2>SYNOPSIS</h2>
	<div class="sectionbody">
	<div class="verseblock">
	<div class="content"><em>git-format-patch</em> [-n \| -k] [-o <dir> \| --stdout] [--thread]
	[--attach[=<boundary>] \| --inline[=<boundary>]]
	[-s \| --signoff] [<common diff options>]
	[--start-number <n>] [--numbered-files]
	[--in-reply-to=Message-Id] [--suffix=.<sfx>]
	[--ignore-if-in-upstream]
	[--subject-prefix=Subject-Prefix]
	[ <since> \| <revision range> ]</div></div>
	</div>
	<h2>DESCRIPTION</h2>
	<div class="sectionbody">
	<p>Prepare each commit with its patch in
	one file per commit, formatted to resemble UNIX mailbox format.
	The output of this command is convenient for e-mail submission or
	for use with <a href="git-am.html">git-am(1)</a>.</p>
	<p>There are two ways to specify which commits to operate on.</p>
	<ol>
	<li>
	<p>
	A single commit, <since>, specifies that the commits leading
	to the tip of the current branch that are not in the history
	that leads to the <since> to be output.
	</p>
	</li>
	<li>
	<p>
	Generic <revision range> expression (see "SPECIFYING
	REVISIONS" section in <a href="git-rev-parse.html">git-rev-parse(1)</a>) means the
	commits in the specified range.
	</p>
	</li>
	</ol>
	<p>A single commit, when interpreted as a <revision range>
	expression, means "everything that leads to that commit", but
	if you write <em>git format-patch <commit></em>, the previous rule
	applies to that command line and you do not get "everything
	since the beginning of the time". If you want to format
	everything since project inception to one commit, say "git
	format-patch --root <commit>" to make it clear that it is the
	latter case.</p>
	<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
	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>
	<p>If -o is specified, output files are created in <dir>. Otherwise
	they are created in the current working directory.</p>
	<p>If -n is specified, instead of "[PATCH] Subject", the first line
	is formatted as "[PATCH n/m] Subject".</p>
	<p>If given --thread, git-format-patch 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
	reference.</p>
	</div>
	<h2>OPTIONS</h2>
	<div class="sectionbody">
	<dl>
	<dt>
	-p
	</dt>
	<dd>
	<p>
	Generate patch (see section on generating patches)
	</p>
	</dd>
	<dt>
	-u
	</dt>
	<dd>
	<p>
	Synonym for "-p".
	</p>
	</dd>
	<dt>
	-U<n>
	</dt>
	<dd>
	<p>
	Shorthand for "--unified=<n>".
	</p>
	</dd>
	<dt>
	--unified=<n>
	</dt>
	<dd>
	<p>
	Generate diffs with <n> 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".
	</p>
	</dd>
	<dt>
	--stat[=width[,name-width]]
	</dt>
	<dd>
	<p>
	Generate a diffstat. You can override the default
	output width for 80-column terminal by "--stat=width".
	The width of the filename part can be controlled by
	giving another width to it separated by a comma.
	</p>
	</dd>
	<dt>
	--numstat
	</dt>
	<dd>
	<p>
	Similar to --stat, 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
	<tt>0 0</tt>.
	</p>
	</dd>
	<dt>
	--shortstat
	</dt>
	<dd>
	<p>
	Output only the last line of the --stat format containing total
	number of modified files, as well as number of added and deleted
	lines.
	</p>
	</dd>
	<dt>
	--summary
	</dt>
	<dd>
	<p>
	Output a condensed summary of extended header information
	such as creations, renames and mode changes.
	</p>
	</dd>
	<dt>
	--patch-with-stat
	</dt>
	<dd>
	<p>
	Synonym for "-p --stat".
	</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.
	</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
	</dt>
	<dd>
	<p>
	Show colored word diff, i.e. color words which have changed.
	</p>
	</dd>
	<dt>
	--no-renames
	</dt>
	<dd>
	<p>
	Turn off rename detection, even when the configuration
	file gives the default to do so.
	</p>
	</dd>
	<dt>
	--check
	</dt>
	<dd>
	<p>
	Warn if changes introduce trailing whitespace
	or an indent that uses a space before a tab.
	</p>
	</dd>
	<dt>
	--full-index
	</dt>
	<dd>
	<p>
	Instead of the first handful characters, show full
	object name of pre- and post-image blob on the "index"
	line when generating a patch format output.
	</p>
	</dd>
	<dt>
	--binary
	</dt>
	<dd>
	<p>
	In addition to --full-index, output "binary diff" that
	can be applied with "git apply".
	</p>
	</dd>
	<dt>
	--abbrev[=<n>]
	</dt>
	<dd>
	<p>
	Instead of showing the full 40-byte hexadecimal object
	name in diff-raw format output and diff-tree header
	lines, show only handful hexdigits prefix. This is
	independent of --full-index option above, which controls
	the diff-patch output format. Non default number of
	digits can be specified with --abbrev=<n>.
	</p>
	</dd>
	<dt>
	-B
	</dt>
	<dd>
	<p>
	Break complete rewrite changes into pairs of delete and create.
	</p>
	</dd>
	<dt>
	-M
	</dt>
	<dd>
	<p>
	Detect renames.
	</p>
	</dd>
	<dt>
	-C
	</dt>
	<dd>
	<p>
	Detect copies as well as renames. See also <tt>--find-copies-harder</tt>.
	</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 (mode) 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>
	<p>
	For performance reasons, by default, <tt>-C</tt> option finds copies only
	if the original file of the copy was modified in the same
	changeset. This flag makes the command
	inspect unmodified files as candidates for the source of
	copy. This is a very expensive operation for large
	projects, so use it with caution. Giving more than one
	<tt>-C</tt> option has the same effect.
	</p>
	</dd>
	<dt>
	-l<num>
	</dt>
	<dd>
	<p>
	-M and -C 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
	number.
	</p>
	</dd>
	<dt>
	-S<string>
	</dt>
	<dd>
	<p>
	Look for differences that contain the change in <string>.
	</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 <string>.
	</p>
	</dd>
	<dt>
	--pickaxe-regex
	</dt>
	<dd>
	<p>
	Make the <string> not a plain string but an extended POSIX
	regex to match.
	</p>
	</dd>
	<dt>
	-O<orderfile>
	</dt>
	<dd>
	<p>
	Output the patch in the order specified in the
	<orderfile>, which has one shell glob pattern per line.
	</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>
	--text
	</dt>
	<dd>
	<p>
	Treat all files as text.
	</p>
	</dd>
	<dt>
	-a
	</dt>
	<dd>
	<p>
	Shorthand for "--text".
	</p>
	</dd>
	<dt>
	--ignore-space-at-eol
	</dt>
	<dd>
	<p>
	Ignore changes in white spaces at EOL.
	</p>
	</dd>
	<dt>
	--ignore-space-change
	</dt>
	<dd>
	<p>
	Ignore changes in amount of white space. This ignores white
	space at line end, and consider all other sequences of one or
	more white space characters to be equivalent.
	</p>
	</dd>
	<dt>
	-b
	</dt>
	<dd>
	<p>
	Shorthand for "--ignore-space-change".
	</p>
	</dd>
	<dt>
	--ignore-all-space
	</dt>
	<dd>
	<p>
	Ignore white space when comparing lines. This ignores
	difference even if one line has white space where the other
	line has none.
	</p>
	</dd>
	<dt>
	-w
	</dt>
	<dd>
	<p>
	Shorthand for "--ignore-all-space".
	</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>
	<p>
	Allow an external diff helper to be executed. If you set an
	external diff driver with gitlink:gitattributes(5), you need
	to use this option with gitlink:git-log(1) and friends.
	</p>
	</dd>
	<dt>
	--no-ext-diff
	</dt>
	<dd>
	<p>
	Disallow external diff drivers.
	</p>
	</dd>
	</dl>
	<p>For more detailed explanation on these common options, see also
	<a href="diffcore.html">diffcore documentation</a>.</p>
	<dl>
	<dt>
	-<n>
	</dt>
	<dd>
	<p>
	Limits the number of patches to prepare.
	</p>
	</dd>
	<dt>
	-o\|--output-directory <dir>
	</dt>
	<dd>
	<p>
	Use <dir> to store the resulting files, instead of the
	current working directory.
	</p>
	</dd>
	<dt>
	-n\|--numbered
	</dt>
	<dd>
	<p>
	Name output in <em>[PATCH n/m]</em> format.
	</p>
	</dd>
	<dt>
	--start-number <n>
	</dt>
	<dd>
	<p>
	Start numbering the patches at <n> instead of 1.
	</p>
	</dd>
	<dt>
	--numbered-files
	</dt>
	<dd>
	<p>
	Output file names will be a simple number sequence
	without the default first line of the commit appended.
	Mutually exclusive with the --stdout option.
	</p>
	</dd>
	<dt>
	-k\|--keep-subject
	</dt>
	<dd>
	<p>
	Do not strip/add <em>[PATCH]</em> from the first line of the
	commit log message.
	</p>
	</dd>
	<dt>
	-s\|--signoff
	</dt>
	<dd>
	<p>
	Add <tt>Signed-off-by:</tt> line to the commit message, using
	the committer identity of yourself.
	</p>
	</dd>
	<dt>
	--stdout
	</dt>
	<dd>
	<p>
	Print all commits to the standard output in mbox format,
	instead of creating a file for each one.
	</p>
	</dd>
	<dt>
	--attach[=<boundary>]
	</dt>
	<dd>
	<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".
	</p>
	</dd>
	<dt>
	--inline[=<boundary>]
	</dt>
	<dd>
	<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".
	</p>
	</dd>
	<dt>
	--thread
	</dt>
	<dd>
	<p>
	Add In-Reply-To and References headers to make the second and
	subsequent mails appear as replies to the first. Also generates
	the Message-Id header to reference.
	</p>
	</dd>
	<dt>
	--in-reply-to=Message-Id
	</dt>
	<dd>
	<p>
	Make the first mail (or all the mails with --no-thread) appear as a
	reply to the given Message-Id, which avoids breaking threads to
	provide a new patch series.
	</p>
	</dd>
	<dt>
	--ignore-if-in-upstream
	</dt>
	<dd>
	<p>
	Do not include a patch that matches a commit in
	<until>..<since>. This will examine all patches reachable
	from <since> but not from <until> and compare them with the
	patches being generated, and any patch that matches is
	ignored.
	</p>
	</dd>
	<dt>
	--subject-prefix=<Subject-Prefix>
	</dt>
	<dd>
	<p>
	Instead of the standard <em>[PATCH]</em> prefix in the subject
	line, instead use <em>[<Subject-Prefix>]</em>. This
	allows for useful naming of a patch series, and can be
	combined with the --numbered option.
	</p>
	</dd>
	<dt>
	--suffix=.<sfx>
	</dt>
	<dd>
	<p>
	Instead of using <tt>.patch</tt> as the suffix for generated
	filenames, use specified suffix. A common alternative is
	<tt>--suffix=.txt</tt>.
	</p>
	<p>Note that you would need to include the leading dot <tt>.</tt> if you
	want a filename like <tt>0001-description-of-my-change.patch</tt>, and
	the first letter does not have to be a dot. Leaving it empty would
	not add any suffix.</p>
	</dd>
	</dl>
	</div>
	<h2>CONFIGURATION</h2>
	<div class="sectionbody">
	<p>You can specify extra mail header lines to be added to each
	message in the repository configuration. You can also specify
	new defaults for the subject prefix and file suffix.</p>
	<div class="listingblock">
	<div class="content">
	<pre><tt>[format]
	headers = "Organization: git-foo\n"
	subjectprefix = CHANGE
	suffix = .txt</tt></pre>
	</div></div>
	</div>
	<h2>EXAMPLES</h2>
	<div class="sectionbody">
	<dl>
	<dt>
	git-format-patch -k --stdout R1..R2 \| git-am -3 -k
	</dt>
	<dd>
	<p>
	Extract commits between revisions R1 and R2, and apply
	them on top of the current branch using <tt>git-am</tt> to
	cherry-pick them.
	</p>
	</dd>
	<dt>
	git-format-patch origin
	</dt>
	<dd>
	<p>
	Extract all commits which are in the current branch but
	not in the origin branch. For each commit a separate file
	is created in the current directory.
	</p>
	</dd>
	<dt>
	git-format-patch --root origin
	</dt>
	<dd>
	<p>
	Extract all commits which that leads to <em>origin</em> since the
	inception of the project.
	</p>
	</dd>
	<dt>
	git-format-patch -M -B origin
	</dt>
	<dd>
	<p>
	The same as the previous one. Additionally, it detects
	and handles renames and complete rewrites intelligently to
	produce a renaming patch. A renaming patch reduces the
	amount of text output, and generally makes it easier to
	review it. Note that the "patch" program does not
	understand renaming patches, so use it only when you know
	the recipient uses git to apply your patch.
	</p>
	</dd>
	<dt>
	git-format-patch -3
	</dt>
	<dd>
	<p>
	Extract three topmost commits from the current branch
	and format them as e-mailable patches.
	</p>
	</dd>
	</dl>
	</div>
	<h2>See Also</h2>
	<div class="sectionbody">
	<p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p>
	</div>
	<h2>Author</h2>
	<div class="sectionbody">
	<p>Written by Junio C Hamano <junkio@cox.net></p>
	</div>
	<h2>Documentation</h2>
	<div class="sectionbody">
	<p>Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.</p>
	</div>
	<h2>GIT</h2>
	<div class="sectionbody">
	<p>Part of the <a href="git.html">git(7)</a> suite</p>
	</div>
	<div id="footer">
	<div id="footer-text">
	Last updated 29-Aug-2007 07:30:57 UTC
	</div>
	</div>
	</body>
	</html>