| <!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 8.5.2" /> | |
| <title>git-format-patch(1)</title> | |
| <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; | |
| text-decoration: underline; | |
| } | |
| a:visited { | |
| color: fuchsia; | |
| } | |
| em { | |
| font-style: italic; | |
| color: navy; | |
| } | |
| strong { | |
| font-weight: bold; | |
| color: #083194; | |
| } | |
| 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, h2, h3 { | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| padding-top: 0.5em; | |
| } | |
| h3 { | |
| float: left; | |
| } | |
| h3 + * { | |
| clear: left; | |
| } | |
| div.sectionbody { | |
| font-family: serif; | |
| margin-left: 0; | |
| } | |
| hr { | |
| border: 1px solid silver; | |
| } | |
| p { | |
| margin-top: 0.5em; | |
| margin-bottom: 0.5em; | |
| } | |
| ul, ol, li > p { | |
| margin-top: 0; | |
| } | |
| pre { | |
| padding: 0; | |
| margin: 0; | |
| } | |
| span#author { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| font-weight: bold; | |
| font-size: 1.1em; | |
| } | |
| span#email { | |
| } | |
| span#revnumber, span#revdate, span#revremark { | |
| 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 { | |
| margin-top: 1.5em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.tableblock, div.imageblock, div.exampleblock, div.verseblock, | |
| div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
| div.admonitionblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.admonitionblock { | |
| margin-top: 2.0em; | |
| margin-bottom: 2.0em; | |
| margin-right: 10%; | |
| color: #606060; | |
| } | |
| div.content { /* Block element content. */ | |
| padding: 0; | |
| } | |
| /* Block element titles. */ | |
| div.title, caption.title { | |
| color: #527bbd; | |
| 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.verseblock { | |
| padding-left: 1.0em; | |
| margin-left: 1.0em; | |
| margin-right: 10%; | |
| border-left: 5px solid #dddddd; | |
| color: #777777; | |
| } | |
| div.quoteblock > div.attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock > div.content { | |
| white-space: pre; | |
| } | |
| div.verseblock > div.attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
| div.verseblock + div.attribution { | |
| text-align: left; | |
| } | |
| 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: 3px solid #dddddd; | |
| } | |
| div.exampleblock > div.content { | |
| border-left: 3px solid #dddddd; | |
| padding-left: 0.5em; | |
| } | |
| div.imageblock div.content { padding-left: 0; } | |
| span.image img { border-style: none; } | |
| a.image:visited { color: white; } | |
| dl { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| dt { | |
| margin-top: 0.5em; | |
| margin-bottom: 0; | |
| font-style: normal; | |
| color: navy; | |
| } | |
| dd > *:first-child { | |
| margin-top: 0.1em; | |
| } | |
| ul, ol { | |
| list-style-position: outside; | |
| } | |
| ol.arabic { | |
| list-style-type: decimal; | |
| } | |
| ol.loweralpha { | |
| list-style-type: lower-alpha; | |
| } | |
| ol.upperalpha { | |
| list-style-type: upper-alpha; | |
| } | |
| ol.lowerroman { | |
| list-style-type: lower-roman; | |
| } | |
| ol.upperroman { | |
| list-style-type: upper-roman; | |
| } | |
| div.compact ul, div.compact ol, | |
| div.compact p, div.compact p, | |
| div.compact div, div.compact div { | |
| margin-top: 0.1em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.tableblock > table { | |
| border: 3px solid #527bbd; | |
| } | |
| thead, p.table.header { | |
| font-family: sans-serif; | |
| font-weight: bold; | |
| } | |
| tfoot { | |
| font-weight: bold; | |
| } | |
| td > div.verse { | |
| white-space: pre; | |
| } | |
| p.table { | |
| margin-top: 0; | |
| } | |
| /* Because the table frame attribute is overriden by CSS in most browsers. */ | |
| div.tableblock > table[frame="void"] { | |
| border-style: none; | |
| } | |
| div.tableblock > table[frame="hsides"] { | |
| border-left-style: none; | |
| border-right-style: none; | |
| } | |
| div.tableblock > table[frame="vsides"] { | |
| border-top-style: none; | |
| border-bottom-style: none; | |
| } | |
| div.hdlist { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| div.hdlist tr { | |
| padding-bottom: 15px; | |
| } | |
| dt.hdlist1.strong, td.hdlist1.strong { | |
| font-weight: bold; | |
| } | |
| td.hdlist1 { | |
| vertical-align: top; | |
| font-style: normal; | |
| padding-right: 0.8em; | |
| color: navy; | |
| } | |
| td.hdlist2 { | |
| vertical-align: top; | |
| } | |
| div.hdlist.compact tr { | |
| margin: 0; | |
| padding-bottom: 0; | |
| } | |
| .comment { | |
| background: yellow; | |
| } | |
| .footnote, .footnoteref { | |
| font-size: 0.8em; | |
| } | |
| span.footnote, span.footnoteref { | |
| vertical-align: super; | |
| } | |
| #footnotes { | |
| margin: 20px 0 20px 0; | |
| padding: 7px 0 0 0; | |
| } | |
| #footnotes div.footnote { | |
| margin: 0 0 5px 0; | |
| } | |
| #footnotes hr { | |
| border: none; | |
| border-top: 1px solid silver; | |
| height: 1px; | |
| text-align: left; | |
| margin-left: 0; | |
| width: 20%; | |
| min-width: 100px; | |
| } | |
| @media print { | |
| div#footer-badges { display: none; } | |
| } | |
| div#toc { | |
| margin-bottom: 2.5em; | |
| } | |
| div#toctitle { | |
| color: #527bbd; | |
| font-family: sans-serif; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
| margin-top: 0; | |
| margin-bottom: 0; | |
| } | |
| div.toclevel2 { | |
| margin-left: 2em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel3 { | |
| margin-left: 4em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel4 { | |
| margin-left: 6em; | |
| font-size: 0.9em; | |
| } | |
| /* Overrides for manpage documents */ | |
| h1 { | |
| padding-top: 0.5em; | |
| padding-bottom: 0.5em; | |
| border-top: 2px solid silver; | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| border-style: none; | |
| } | |
| div.sectionbody { | |
| margin-left: 5%; | |
| } | |
| @media print { | |
| div#toc { display: none; } | |
| } | |
| /* 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 { | |
| color: #527bbd; | |
| 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-attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock-content { | |
| white-space: pre; | |
| } | |
| div.verseblock-attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| div.exampleblock-content { | |
| border-left: 3px solid #dddddd; | |
| padding-left: 0.5em; | |
| } | |
| /* IE6 sets dynamically generated links as visited. */ | |
| div#toc a:visited { color: blue; } | |
| </style> | |
| <script type="text/javascript"> | |
| /*<+'])'); | |
| // Function that scans the DOM tree for header elements (the DOM2 | |
| // nodeIterator API would be a better technique but not supported by all | |
| // browsers). | |
| var iterate = function (el) { | |
| for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
| if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
| var mo = re.exec(i.tagName); | |
| if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
| result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
| } | |
| iterate(i); | |
| } | |
| } | |
| } | |
| iterate(el); | |
| return result; | |
| } | |
| var toc = document.getElementById("toc"); | |
| var entries = tocEntries(document.getElementById("content"), toclevels); | |
| for (var i = 0; i < entries.length; ++i) { | |
| var entry = entries[i]; | |
| if (entry.element.id == "") | |
| entry.element.id = "_toc_" + i; | |
| var a = document.createElement("a"); | |
| a.href = "#" + entry.element.id; | |
| a.appendChild(document.createTextNode(entry.text)); | |
| var div = document.createElement("div"); | |
| div.appendChild(a); | |
| div.className = "toclevel" + entry.toclevel; | |
| toc.appendChild(div); | |
| } | |
| if (entries.length == 0) | |
| toc.parentNode.removeChild(toc); | |
| }, | |
| ///////////////////////////////////////////////////////////////////// | |
| // Footnotes generator | |
| ///////////////////////////////////////////////////////////////////// | |
| /* Based on footnote generation code from: | |
| * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
| */ | |
| footnotes: function () { | |
| var cont = document.getElementById("content"); | |
| var noteholder = document.getElementById("footnotes"); | |
| var spans = cont.getElementsByTagName("span"); | |
| var refs = {}; | |
| var n = 0; | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnote") { | |
| n++; | |
| // Use [\s\S] in place of . so multi-line matches work. | |
| // Because JavaScript has no s (dotall) regex flag. | |
| note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
| noteholder.innerHTML += | |
| "<div class='footnote' id='_footnote_" + n + "'>" + | |
| "<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
| n + "</a>. " + note + "</div>"; | |
| spans[i].innerHTML = | |
| "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| var id =spans[i].getAttribute("id"); | |
| if (id != null) refs["#"+id] = n; | |
| } | |
| } | |
| if (n == 0) | |
| noteholder.parentNode.removeChild(noteholder); | |
| else { | |
| // Process footnoterefs. | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnoteref") { | |
| var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
| href = href.match(/#.*/)[0]; // Because IE return full URL. | |
| n = refs[href]; | |
| spans[i].innerHTML = | |
| "[<a href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| } | |
| } | |
| } | |
| } | |
| } | |
| /*]]>*/ | |
| </script> | |
| </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> | |
| <div id="content"> | |
| <h2 id="_synopsis">SYNOPSIS</h2> | |
| <div class="sectionbody"> | |
| <div class="verseblock"> | |
| <div class="verseblock-content"><em>git format-patch</em> [-k] [(-o|--output-directory) <dir> | --stdout] | |
| [--no-thread | --thread[=<style>]] | |
| [(--attach|--inline)[=<boundary>] | --no-attach] | |
| [-s | --signoff] | |
| [--signature=<signature> | --no-signature] | |
| [-n | --numbered | -N | --no-numbered] | |
| [--start-number <n>] [--numbered-files] | |
| [--in-reply-to=Message-Id] [--suffix=.<sfx>] | |
| [--ignore-if-in-upstream] | |
| [--subject-prefix=Subject-Prefix] | |
| [--to=<email>] [--cc=<email>] | |
| [--cover-letter] [--quiet] | |
| [<common diff options>] | |
| [ <since> | <revision range> ]</div> | |
| <div class="verseblock-attribution"> | |
| </div></div> | |
| </div> | |
| <h2 id="_description">DESCRIPTION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><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 <em>git am</em>.</p></div> | |
| <div class="paragraph"><p>There are two ways to specify which commits to operate on.</p></div> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <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="gitrevisions.html">gitrevisions(7)</a>) means the | |
| commits in the specified range. | |
| </p> | |
| </li> | |
| </ol></div> | |
| <div class="paragraph"><p>The first rule takes precedence in the case of a single <commit>. To | |
| apply the second rule, i.e., format everything since the beginning of | |
| history up until <commit>, use the <em>--root</em> option: <tt>git format-patch | |
| --root <commit></tt>. If you want to format only <commit> itself, you | |
| can do this with <tt>git format-patch -1 <commit></tt>.</p></div> | |
| <div class="paragraph"><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 <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 <tt>--stdout</tt> option is specified.</p></div> | |
| <div class="paragraph"><p>If <tt>-o</tt> is specified, output files are created in <dir>. Otherwise | |
| they are created in the current working directory.</p></div> | |
| <div class="paragraph"><p>By default, the subject of a single patch is "[PATCH] " followed by | |
| the concatenation of lines from the commit message up to the first blank | |
| line (see the DISCUSSION section of <a href="git-commit.html">git-commit(1)</a>).</p></div> | |
| <div class="paragraph"><p>When multiple patches are output, the subject prefix will instead be | |
| "[PATCH n/m] ". 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="paragraph"><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> | |
| <div class="sectionbody"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| -p | |
| </dt> | |
| <dt class="hdlist1"> | |
| --no-stat | |
| </dt> | |
| <dd> | |
| <p> | |
| Generate plain patches without any diffstats. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -U<n> | |
| </dt> | |
| <dt class="hdlist1"> | |
| --unified=<n> | |
| </dt> | |
| <dd> | |
| <p> | |
| Generate diffs with <n> lines of context instead of | |
| the usual three. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --minimal | |
| </dt> | |
| <dd> | |
| <p> | |
| Spend extra time to make sure the smallest possible | |
| diff is produced. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --patience | |
| </dt> | |
| <dd> | |
| <p> | |
| Generate a diff using the "patience diff" algorithm. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --histogram | |
| </dt> | |
| <dd> | |
| <p> | |
| Generate a diff using the "histogram diff" algorithm. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --stat[=<width>[,<name-width>[,<count>]]] | |
| </dt> | |
| <dd> | |
| <p> | |
| Generate a diffstat. By default, as much space as necessary | |
| will be used for the filename part, and the rest for the graph | |
| part. Maximum width defaults to terminal width, or 80 columns | |
| if not connected to a terminal, and can be overridden by | |
| <tt><width></tt>. The width of the filename part can be limited by | |
| giving another width <tt><name-width></tt> after a comma. The width | |
| of the graph part can be limited by using | |
| <tt>--stat-graph-width=<width></tt> (affects all commands generating | |
| a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> | |
| (does not affect <tt>git format-patch</tt>). | |
| By giving a third parameter <tt><count></tt>, you can limit the | |
| output to the first <tt><count></tt> lines, followed by <tt>...</tt> if | |
| there are more. | |
| </p> | |
| <div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, | |
| <tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --numstat | |
| </dt> | |
| <dd> | |
| <p> | |
| 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 | |
| <tt>0 0</tt>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --shortstat | |
| </dt> | |
| <dd> | |
| <p> | |
| 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> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --dirstat[=<param1,param2,…>] | |
| </dt> | |
| <dd> | |
| <p> | |
| Output the distribution of relative amount of changes for each | |
| sub-directory. The behavior of <tt>--dirstat</tt> can be customized by | |
| passing it a comma separated list of parameters. | |
| The defaults are controlled by the <tt>diff.dirstat</tt> configuration | |
| variable (see <a href="git-config.html">git-config(1)</a>). | |
| The following parameters are available: | |
| </p> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| <tt>changes</tt> | |
| </dt> | |
| <dd> | |
| <p> | |
| Compute the dirstat numbers by counting the lines that have been | |
| removed from the source, or added to the destination. This ignores | |
| the amount of pure code movements within a file. In other words, | |
| rearranging lines in a file is not counted as much as other changes. | |
| This is the default behavior when no parameter is given. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <tt>lines</tt> | |
| </dt> | |
| <dd> | |
| <p> | |
| Compute the dirstat numbers by doing the regular line-based diff | |
| analysis, and summing the removed/added line counts. (For binary | |
| files, count 64-byte chunks instead, since binary files have no | |
| natural concept of lines). This is a more expensive <tt>--dirstat</tt> | |
| behavior than the <tt>changes</tt> behavior, but it does count rearranged | |
| lines within a file as much as other changes. The resulting output | |
| is consistent with what you get from the other <tt>--*stat</tt> options. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <tt>files</tt> | |
| </dt> | |
| <dd> | |
| <p> | |
| Compute the dirstat numbers by counting the number of files changed. | |
| Each changed file counts equally in the dirstat analysis. This is | |
| the computationally cheapest <tt>--dirstat</tt> behavior, since it does | |
| not have to look at the file contents at all. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <tt>cumulative</tt> | |
| </dt> | |
| <dd> | |
| <p> | |
| Count changes in a child directory for the parent directory as well. | |
| Note that when using <tt>cumulative</tt>, the sum of the percentages | |
| reported may exceed 100%. The default (non-cumulative) behavior can | |
| be specified with the <tt>noncumulative</tt> parameter. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <limit> | |
| </dt> | |
| <dd> | |
| <p> | |
| An integer parameter specifies a cut-off percent (3% by default). | |
| Directories contributing less than this percentage of the changes | |
| are not shown in the output. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="paragraph"><p>Example: The following will count changed files, while ignoring | |
| directories with less than 10% of the total amount of changed files, | |
| and accumulating child directory counts in the parent directories: | |
| <tt>--dirstat=files,10,cumulative</tt>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --summary | |
| </dt> | |
| <dd> | |
| <p> | |
| Output a condensed summary of extended header information | |
| such as creations, renames and mode changes. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --no-renames | |
| </dt> | |
| <dd> | |
| <p> | |
| Turn off rename detection, even when the configuration | |
| file gives the default to do so. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --full-index | |
| </dt> | |
| <dd> | |
| <p> | |
| Instead of the first handful of characters, show the full | |
| pre- and post-image blob object names on the "index" | |
| line when generating patch format output. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --binary | |
| </dt> | |
| <dd> | |
| <p> | |
| In addition to <tt>--full-index</tt>, output a binary diff that | |
| can be applied with <tt>git-apply</tt>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --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 a partial prefix. This is | |
| 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 <tt>--abbrev=<n></tt>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -B[<n>][/<m>] | |
| </dt> | |
| <dt class="hdlist1"> | |
| --break-rewrites[=[<n>][/<m>]] | |
| </dt> | |
| <dd> | |
| <p> | |
| Break complete rewrite changes into pairs of delete and | |
| create. This serves two purposes: | |
| </p> | |
| <div class="paragraph"><p>It affects the way a change that amounts to a total rewrite of a file | |
| not as a series of deletion and insertion mixed together with a very | |
| few lines that happen to match textually as the context, but as a | |
| single deletion of everything old followed by a single insertion of | |
| everything new, and the number <tt>m</tt> controls this aspect of the -B | |
| option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the | |
| original should remain in the result for git to consider it a total | |
| rewrite (i.e. otherwise the resulting patch will be a series of | |
| deletion and insertion mixed together with context lines).</p></div> | |
| <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the | |
| source of a rename (usually -M only considers a file that disappeared | |
| as the source of a rename), and the number <tt>n</tt> controls this aspect of | |
| the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with | |
| addition and deletion compared to 20% or more of the file’s size are | |
| eligible for being picked up as a possible source of a rename to | |
| another file.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -M[<n>] | |
| </dt> | |
| <dt class="hdlist1"> | |
| --find-renames[=<n>] | |
| </dt> | |
| <dd> | |
| <p> | |
| Detect renames. | |
| If <tt>n</tt> is specified, it is a threshold on the similarity | |
| index (i.e. amount of addition/deletions compared to the | |
| file’s size). For example, <tt>-M90%</tt> means git should consider a | |
| delete/add pair to be a rename if more than 90% of the file | |
| hasn’t changed. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -C[<n>] | |
| </dt> | |
| <dt class="hdlist1"> | |
| --find-copies[=<n>] | |
| </dt> | |
| <dd> | |
| <p> | |
| Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. | |
| If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --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 class="hdlist1"> | |
| -D | |
| </dt> | |
| <dt class="hdlist1"> | |
| --irreversible-delete | |
| </dt> | |
| <dd> | |
| <p> | |
| Omit the preimage for deletes, i.e. print only the header but not | |
| the diff between the preimage and <tt>/dev/null</tt>. The resulting patch | |
| is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is | |
| solely for people who want to just concentrate on reviewing the | |
| text after the change. In addition, the output obviously lack | |
| enough information to apply such a patch in reverse, even manually, | |
| hence the name of the option. | |
| </p> | |
| <div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part | |
| of a delete/create pair.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -l<num> | |
| </dt> | |
| <dd> | |
| <p> | |
| 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 | |
| number. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -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 class="hdlist1"> | |
| -a | |
| </dt> | |
| <dt class="hdlist1"> | |
| --text | |
| </dt> | |
| <dd> | |
| <p> | |
| Treat all files as text. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --ignore-space-at-eol | |
| </dt> | |
| <dd> | |
| <p> | |
| Ignore changes in whitespace at EOL. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -b | |
| </dt> | |
| <dt class="hdlist1"> | |
| --ignore-space-change | |
| </dt> | |
| <dd> | |
| <p> | |
| Ignore changes in amount of whitespace. This ignores whitespace | |
| at line end, and considers all other sequences of one or | |
| more whitespace characters to be equivalent. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -w | |
| </dt> | |
| <dt class="hdlist1"> | |
| --ignore-all-space | |
| </dt> | |
| <dd> | |
| <p> | |
| Ignore whitespace when comparing lines. This ignores | |
| differences even if one line has whitespace where the other | |
| line has none. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --inter-hunk-context=<lines> | |
| </dt> | |
| <dd> | |
| <p> | |
| Show the context between diff hunks, up to the specified number | |
| of lines, thereby fusing hunks that are close to each other. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -W | |
| </dt> | |
| <dt class="hdlist1"> | |
| --function-context | |
| </dt> | |
| <dd> | |
| <p> | |
| Show whole surrounding functions of changes. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --ext-diff | |
| </dt> | |
| <dd> | |
| <p> | |
| Allow an external diff helper to be executed. If you set an | |
| external diff driver with <a href="gitattributes.html">gitattributes(5)</a>, you need | |
| to use this option with <a href="git-log.html">git-log(1)</a> and friends. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --no-ext-diff | |
| </dt> | |
| <dd> | |
| <p> | |
| Disallow external diff drivers. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --textconv | |
| </dt> | |
| <dt class="hdlist1"> | |
| --no-textconv | |
| </dt> | |
| <dd> | |
| <p> | |
| Allow (or disallow) external text conversion filters to be run | |
| when comparing binary files. See <a href="gitattributes.html">gitattributes(5)</a> for | |
| details. Because textconv filters are typically a one-way | |
| conversion, the resulting diff is suitable for human | |
| consumption, but cannot be applied. For this reason, textconv | |
| filters are enabled by default only for <a href="git-diff.html">git-diff(1)</a> and | |
| <a href="git-log.html">git-log(1)</a>, but not for <a href="git-format-patch.html">git-format-patch(1)</a> or | |
| diff plumbing commands. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --ignore-submodules[=<when>] | |
| </dt> | |
| <dd> | |
| <p> | |
| Ignore changes to submodules in the diff generation. <when> can be | |
| either "none", "untracked", "dirty" or "all", which is the default | |
| Using "none" will consider the submodule modified when it either contains | |
| untracked or modified files or its HEAD differs from the commit recorded | |
| in the superproject and can be used to override any settings of the | |
| <em>ignore</em> option in <a href="git-config.html">git-config(1)</a> or <a href="gitmodules.html">gitmodules(5)</a>. When | |
| "untracked" is used submodules are not considered dirty when they only | |
| contain untracked content (but they are still scanned for modified | |
| content). Using "dirty" ignores all changes to the work tree of submodules, | |
| only changes to the commits stored in the superproject are shown (this was | |
| the behavior until 1.7.0). Using "all" hides all changes to submodules. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --src-prefix=<prefix> | |
| </dt> | |
| <dd> | |
| <p> | |
| Show the given source prefix instead of "a/". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --dst-prefix=<prefix> | |
| </dt> | |
| <dd> | |
| <p> | |
| Show the given destination prefix instead of "b/". | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --no-prefix | |
| </dt> | |
| <dd> | |
| <p> | |
| Do not show any source or destination prefix. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="paragraph"><p>For more detailed explanation on these common options, see also | |
| <a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| -<n> | |
| </dt> | |
| <dd> | |
| <p> | |
| Prepare patches from the topmost <n> commits. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -o <dir> | |
| </dt> | |
| <dt class="hdlist1"> | |
| --output-directory <dir> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use <dir> to store the resulting files, instead of the | |
| current working directory. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -n | |
| </dt> | |
| <dt class="hdlist1"> | |
| --numbered | |
| </dt> | |
| <dd> | |
| <p> | |
| Name output in <em>[PATCH n/m]</em> format, even with a single patch. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -N | |
| </dt> | |
| <dt class="hdlist1"> | |
| --no-numbered | |
| </dt> | |
| <dd> | |
| <p> | |
| Name output in <em>[PATCH]</em> format. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --start-number <n> | |
| </dt> | |
| <dd> | |
| <p> | |
| Start numbering the patches at <n> instead of 1. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --numbered-files | |
| </dt> | |
| <dd> | |
| <p> | |
| Output file names will be a simple number sequence | |
| without the default first line of the commit appended. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -k | |
| </dt> | |
| <dt class="hdlist1"> | |
| --keep-subject | |
| </dt> | |
| <dd> | |
| <p> | |
| Do not strip/add <em>[PATCH]</em> from the first line of the | |
| commit log message. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -s | |
| </dt> | |
| <dt class="hdlist1"> | |
| --signoff | |
| </dt> | |
| <dd> | |
| <p> | |
| Add <tt>Signed-off-by:</tt> line to the commit message, using | |
| the committer identity of yourself. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --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 class="hdlist1"> | |
| --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 <tt>Content-Disposition: attachment</tt>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --no-attach | |
| </dt> | |
| <dd> | |
| <p> | |
| Disable the creation of an attachment, overriding the | |
| configuration setting. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --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 <tt>Content-Disposition: inline</tt>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --thread[=<style>] | |
| </dt> | |
| <dt class="hdlist1"> | |
| --no-thread | |
| </dt> | |
| <dd> | |
| <p> | |
| 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 <tt>Message-Id</tt> header to | |
| reference. | |
| </p> | |
| <div class="paragraph"><p>The optional <style> argument can be either <tt>shallow</tt> or <tt>deep</tt>. | |
| <em>shallow</em> threading makes every mail a reply to the head of the | |
| 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="paragraph"><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="paragraph"><p>Beware that the default for <em>git send-email</em> is to thread emails | |
| 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 class="hdlist1"> | |
| --in-reply-to=Message-Id | |
| </dt> | |
| <dd> | |
| <p> | |
| 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> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --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 class="hdlist1"> | |
| --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 <tt>--numbered</tt> option. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --to=<email> | |
| </dt> | |
| <dd> | |
| <p> | |
| Add a <tt>To:</tt> header to the email headers. This is in addition | |
| to any configured headers, and may be used multiple times. | |
| The negated form <tt>--no-to</tt> discards all <tt>To:</tt> headers added so | |
| far (from config or command line). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --cc=<email> | |
| </dt> | |
| <dd> | |
| <p> | |
| Add a <tt>Cc:</tt> header to the email headers. This is in addition | |
| to any configured headers, and may be used multiple times. | |
| The negated form <tt>--no-cc</tt> discards all <tt>Cc:</tt> headers added so | |
| far (from config or command line). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --add-header=<header> | |
| </dt> | |
| <dd> | |
| <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, <tt>--add-header="Organization: git-foo"</tt>. | |
| The negated form <tt>--no-add-header</tt> discards <strong>all</strong> (<tt>To:</tt>, | |
| <tt>Cc:</tt>, and custom) headers added so far from config or command | |
| line. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --cover-letter | |
| </dt> | |
| <dd> | |
| <p> | |
| In addition to the patches, generate a cover letter file | |
| containing the shortlog and the overall diffstat. You can | |
| fill in a description in the file before sending it out. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --[no]-signature=<signature> | |
| </dt> | |
| <dd> | |
| <p> | |
| Add a signature to each message produced. Per RFC 3676 the signature | |
| is separated from the body by a line with '-- ' on it. If the | |
| signature option is omitted the signature defaults to the git version | |
| number. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --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>. Leaving this empty will remove the <tt>.patch</tt> | |
| suffix. | |
| </p> | |
| <div class="paragraph"><p>Note that the leading character does not have to be a dot; for example, | |
| you can use <tt>--suffix=-patch</tt> to get <tt>0001-description-of-my-change-patch</tt>.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --quiet | |
| </dt> | |
| <dd> | |
| <p> | |
| Do not print the names of the generated files to standard output. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --no-binary | |
| </dt> | |
| <dd> | |
| <p> | |
| Do not output contents of changes in binary files, instead | |
| display a notice that those files changed. Patches generated | |
| using this option cannot be applied properly, but they are | |
| still useful for code review. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --root | |
| </dt> | |
| <dd> | |
| <p> | |
| Treat the revision argument as a <revision range>, even if it | |
| is just a single commit (that would normally be treated as a | |
| <since>). Note that root commits included in the specified | |
| range are always formatted as creation patches, independently | |
| of this flag. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div> | |
| <h2 id="_configuration">CONFIGURATION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>You can specify extra mail header lines to be added to each message, | |
| defaults for the subject prefix and file suffix, number patches when | |
| outputting more than one patch, add "To" or "Cc:" headers, configure | |
| attachments, and sign off patches with configuration variables.</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>[format] | |
| headers = "Organization: git-foo\n" | |
| subjectprefix = CHANGE | |
| suffix = .txt | |
| numbered = auto | |
| to = <email> | |
| cc = <email> | |
| attach [ = mime-boundary-string ] | |
| signoff = true</tt></pre> | |
| </div></div> | |
| </div> | |
| <h2 id="_discussion">DISCUSSION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>The patch produced by <em>git format-patch</em> is in UNIX mailbox format, | |
| with a fixed "magic" time stamp to indicate that the file is output | |
| from format-patch rather than a real mailbox, like so:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 | |
| From: Tony Luck <tony.luck@intel.com> | |
| Date: Tue, 13 Jul 2010 11:42:54 -0700 | |
| Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?= | |
| =?UTF-8?q?Uwe=20Kleine-K=C3=B6nig=20diet?= | |
| MIME-Version: 1.0 | |
| Content-Type: text/plain; charset=UTF-8 | |
| Content-Transfer-Encoding: 8bit | |
| arch/arm config files were slimmed down using a python script | |
| (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment) | |
| Do the same for ia64 so we can have sleek & trim looking | |
| ...</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>Typically it will be placed in a MUA’s drafts folder, edited to add | |
| timely commentary that should not go in the changelog after the three | |
| dashes, and then sent as a message whose body, in our example, starts | |
| with "arch/arm config files were…". On the receiving end, readers | |
| can save interesting patches in a UNIX mailbox and apply them with | |
| <a href="git-am.html">git-am(1)</a>.</p></div> | |
| <div class="paragraph"><p>When a patch is part of an ongoing discussion, the patch generated by | |
| <em>git format-patch</em> can be tweaked to take advantage of the <em>git am | |
| --scissors</em> feature. After your response to the discussion comes a | |
| line that consists solely of "<tt>-- >8 --</tt>" (scissors and perforation), | |
| followed by the patch with unnecessary header fields removed:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>... | |
| > So we should do such-and-such. | |
| Makes sense to me. How about this patch? | |
| -- >8 -- | |
| Subject: [IA64] Put ia64 config files on the Uwe Kleine-König diet | |
| arch/arm config files were slimmed down using a python script | |
| ...</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>When sending a patch this way, most often you are sending your own | |
| patch, so in addition to the "<tt>From $SHA1 $magic_timestamp</tt>" marker you | |
| should omit <tt>From:</tt> and <tt>Date:</tt> lines from the patch file. The patch | |
| title is likely to be different from the subject of the discussion the | |
| patch is in response to, so it is likely that you would want to keep | |
| the Subject: line, like the example above.</p></div> | |
| <h3 id="_checking_for_patch_corruption">Checking for patch corruption</h3><div style="clear:left"></div> | |
| <div class="paragraph"><p>Many mailers if not set up properly will corrupt whitespace. Here are | |
| two common types of corruption:</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| Empty context lines that do not have <em>any</em> whitespace. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Non-empty context lines that have one extra whitespace at the | |
| beginning. | |
| </p> | |
| </li> | |
| </ul></div> | |
| <div class="paragraph"><p>One way to test if your MUA is set up correctly is:</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| Send the patch to yourself, exactly the way you would, except | |
| with To: and Cc: lines that do not contain the list and | |
| maintainer address. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Save that patch to a file in UNIX mailbox format. Call it a.patch, | |
| say. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Apply it: | |
| </p> | |
| <div class="literalblock"> | |
| <div class="content"> | |
| <pre><tt>$ git fetch <project> master:test-apply | |
| $ git checkout test-apply | |
| $ git reset --hard | |
| $ git am a.patch</tt></pre> | |
| </div></div> | |
| </li> | |
| </ul></div> | |
| <div class="paragraph"><p>If it does not apply correctly, there can be various reasons.</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| The patch itself does not apply cleanly. That is <em>bad</em> but | |
| does not have much to do with your MUA. You might want to rebase | |
| the patch with <a href="git-rebase.html">git-rebase(1)</a> before regenerating it in | |
| this case. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| The MUA corrupted your patch; "am" would complain that | |
| the patch does not apply. Look in the .git/rebase-apply/ subdirectory and | |
| see what <em>patch</em> file contains and check for the common | |
| corruption patterns mentioned above. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| While at it, check the <em>info</em> and <em>final-commit</em> files as well. | |
| If what is in <em>final-commit</em> is not exactly what you would want to | |
| see in the commit log message, it is very likely that the | |
| receiver would end up hand editing the log message when applying | |
| your patch. Things like "Hi, this is my first patch.\n" in the | |
| patch e-mail should come after the three-dash line that signals | |
| the end of the commit message. | |
| </p> | |
| </li> | |
| </ul></div> | |
| </div> | |
| <h2 id="_mua_specific_hints">MUA-SPECIFIC HINTS</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Here are some hints on how to successfully submit patches inline using | |
| various mailers.</p></div> | |
| <h3 id="_gmail">GMail</h3><div style="clear:left"></div> | |
| <div class="paragraph"><p>GMail does not have any way to turn off line wrapping in the web | |
| interface, so it will mangle any emails that you send. You can however | |
| use "git send-email" and send your patches through the GMail SMTP server, or | |
| use any IMAP email client to connect to the google IMAP server and forward | |
| the emails through that.</p></div> | |
| <div class="paragraph"><p>For hints on using <em>git send-email</em> to send your patches through the | |
| GMail SMTP server, see the EXAMPLE section of <a href="git-send-email.html">git-send-email(1)</a>.</p></div> | |
| <div class="paragraph"><p>For hints on submission using the IMAP interface, see the EXAMPLE | |
| section of <a href="git-imap-send.html">git-imap-send(1)</a>.</p></div> | |
| <h3 id="_thunderbird">Thunderbird</h3><div style="clear:left"></div> | |
| <div class="paragraph"><p>By default, Thunderbird will both wrap emails as well as flag | |
| them as being <em>format=flowed</em>, both of which will make the | |
| resulting email unusable by git.</p></div> | |
| <div class="paragraph"><p>There are three different approaches: use an add-on to turn off line wraps, | |
| configure Thunderbird to not mangle patches, or use | |
| an external editor to keep Thunderbird from mangling the patches.</p></div> | |
| <h4 id="_approach_1_add_on">Approach #1 (add-on)</h4> | |
| <div class="paragraph"><p>Install the Toggle Word Wrap add-on that is available from | |
| <a href="https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/">https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/</a> | |
| It adds a menu entry "Enable Word Wrap" in the composer’s "Options" menu | |
| that you can tick off. Now you can compose the message as you otherwise do | |
| (cut + paste, <em>git format-patch</em> | <em>git imap-send</em>, etc), but you have to | |
| insert line breaks manually in any text that you type.</p></div> | |
| <h4 id="_approach_2_configuration">Approach #2 (configuration)</h4> | |
| <div class="paragraph"><p>Three steps:</p></div> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <li> | |
| <p> | |
| Configure your mail server composition as plain text: | |
| Edit…Account Settings…Composition & Addressing, | |
| uncheck "Compose Messages in HTML". | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Configure your general composition window to not wrap. | |
| </p> | |
| <div class="paragraph"><p>In Thunderbird 2: | |
| Edit..Preferences..Composition, wrap plain text messages at 0</p></div> | |
| <div class="paragraph"><p>In Thunderbird 3: | |
| Edit..Preferences..Advanced..Config Editor. Search for | |
| "mail.wrap_long_lines". | |
| Toggle it to make sure it is set to <tt>false</tt>.</p></div> | |
| </li> | |
| <li> | |
| <p> | |
| Disable the use of format=flowed: | |
| Edit..Preferences..Advanced..Config Editor. Search for | |
| "mailnews.send_plaintext_flowed". | |
| Toggle it to make sure it is set to <tt>false</tt>. | |
| </p> | |
| </li> | |
| </ol></div> | |
| <div class="paragraph"><p>After that is done, you should be able to compose email as you | |
| otherwise would (cut + paste, <em>git format-patch</em> | <em>git imap-send</em>, etc), | |
| and the patches will not be mangled.</p></div> | |
| <h4 id="_approach_3_external_editor">Approach #3 (external editor)</h4> | |
| <div class="paragraph"><p>The following Thunderbird extensions are needed: | |
| AboutConfig from <a href="http://aboutconfig.mozdev.org/">http://aboutconfig.mozdev.org/</a> and | |
| External Editor from <a href="http://globs.org/articles.php?lng=en&pg=8">http://globs.org/articles.php?lng=en&pg=8</a></p></div> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <li> | |
| <p> | |
| Prepare the patch as a text file using your method of choice. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Before opening a compose window, use Edit→Account Settings to | |
| uncheck the "Compose messages in HTML format" setting in the | |
| "Composition & Addressing" panel of the account to be used to | |
| send the patch. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| In the main Thunderbird window, <em>before</em> you open the compose | |
| window for the patch, use Tools→about:config to set the | |
| following to the indicated values: | |
| </p> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> mailnews.send_plaintext_flowed => false | |
| mailnews.wraplength => 0</tt></pre> | |
| </div></div> | |
| </li> | |
| <li> | |
| <p> | |
| Open a compose window and click the external editor icon. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| In the external editor window, read in the patch file and exit | |
| the editor normally. | |
| </p> | |
| </li> | |
| </ol></div> | |
| <div class="paragraph"><p>Side note: it may be possible to do step 2 with | |
| about:config and the following settings but no one’s tried yet.</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt> mail.html_compose => false | |
| mail.identity.default.compose_html => false | |
| mail.identity.id?.compose_html => false</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>There is a script in contrib/thunderbird-patch-inline which can help | |
| you include patches with Thunderbird in an easy way. To use it, do the | |
| steps above and then use the script as the external editor.</p></div> | |
| <h3 id="_kmail">KMail</h3><div style="clear:left"></div> | |
| <div class="paragraph"><p>This should help you to submit patches inline using KMail.</p></div> | |
| <div class="olist arabic"><ol class="arabic"> | |
| <li> | |
| <p> | |
| Prepare the patch as a text file. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Click on New Mail. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Go under "Options" in the Composer window and be sure that | |
| "Word wrap" is not set. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Use Message → Insert file… and insert the patch. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Back in the compose window: add whatever other text you wish to the | |
| message, complete the addressing and subject fields, and press send. | |
| </p> | |
| </li> | |
| </ol></div> | |
| </div> | |
| <h2 id="_examples">EXAMPLES</h2> | |
| <div class="sectionbody"> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| Extract commits between revisions R1 and R2, and apply them on top of | |
| the current branch using <em>git am</em> to cherry-pick them: | |
| </p> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>$ git format-patch -k --stdout R1..R2 | git am -3 -k</tt></pre> | |
| </div></div> | |
| </li> | |
| <li> | |
| <p> | |
| Extract all commits which are in the current branch but not in the | |
| origin branch: | |
| </p> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>$ git format-patch origin</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>For each commit a separate file is created in the current directory.</p></div> | |
| </li> | |
| <li> | |
| <p> | |
| Extract all commits that lead to <em>origin</em> since the inception of the | |
| project: | |
| </p> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>$ git format-patch --root origin</tt></pre> | |
| </div></div> | |
| </li> | |
| <li> | |
| <p> | |
| The same as the previous one: | |
| </p> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>$ git format-patch -M -B origin</tt></pre> | |
| </div></div> | |
| <div class="paragraph"><p>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. | |
| Note that non-git "patch" programs won’t understand renaming patches, so | |
| use it only when you know the recipient uses git to apply your patch.</p></div> | |
| </li> | |
| <li> | |
| <p> | |
| Extract three topmost commits from the current branch and format them | |
| as e-mailable patches: | |
| </p> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><tt>$ git format-patch -3</tt></pre> | |
| </div></div> | |
| </li> | |
| </ul></div> | |
| </div> | |
| <h2 id="_see_also">SEE ALSO</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p></div> | |
| </div> | |
| <h2 id="_git">GIT</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> | |
| </div> | |
| </div> | |
| <div id="footnotes"><hr /></div> | |
| <div id="footer"> | |
| <div id="footer-text"> | |
| Last updated 2012-09-17 16:55:59 PDT | |
| </div> | |
| </div> | |
| </body> | |
| </html> |