Autogenerated HTML docs for v1.3.3-g16a4
[git.git] / git-format-patch.html
index 5811c70..9c14c17 100644 (file)
@@ -273,23 +273,26 @@ git-format-patch(1) Manual Page
 <h2>SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<div class="content"><em>git-format-patch</em> [-n | -k] [-o &lt;dir&gt; | --stdout] [--attach] [-s] [-c]\r
-                 [--diff-options] &lt;his&gt; [&lt;mine&gt;]</div></div>\r
+<div class="content"><em>git-format-patch</em> [-n | -k] [-o &lt;dir&gt; | --stdout] [--attach]\r
+                   [-s | --signoff] [--diff-options] [--start-number &lt;n&gt;]\r
+                   &lt;since&gt;[..&lt;until&gt;]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
 <div class="sectionbody">\r
-<p>Prepare each commit with its patch since &lt;mine&gt; head forked from\r
-&lt;his&gt; head, one file per patch formatted to resemble UNIX mailbox\r
-format, for e-mail submission or use with <a href="git-am.html">git-am(1)</a>.</p>\r
+<p>Prepare each commit between &lt;since&gt; and &lt;until&gt; with its patch in\r
+one file per commit, formatted to resemble UNIX mailbox format.\r
+If ..&lt;until&gt; is not specified, the head of the current working\r
+tree is implied.</p>\r
+<p>The output of this command is convenient for e-mail submission or\r
+for use with <a href="git-am.html">git-am(1)</a>.</p>\r
 <p>Each output file is numbered sequentially from 1, and uses the\r
-first line of the commit message (massaged for pathname safety)\r
-as the filename.</p>\r
-<p>When -o is specified, output files are created in &lt;dir&gt;; otherwise\r
-they are created in the current working directory.  This option\r
-is ignored if --stdout is specified.</p>\r
-<p>When -n is specified, instead of "[PATCH] Subject", the first\r
-line is formatted as "[PATCH N/M] Subject", unless you have only\r
-one patch.</p>\r
+first line of the commit message (massaged for pathname safety) as\r
+the filename. The names of the output files are printed to standard\r
+output, unless the --stdout option is specified.</p>\r
+<p>If -o is specified, output files are created in &lt;dir&gt;.  Otherwise\r
+they are created in the current working directory.</p>\r
+<p>If -n is specified, instead of "[PATCH] Subject", the first line\r
+is formatted as "[PATCH n/m] Subject".</p>\r
 </div>\r
 <h2>OPTIONS</h2>\r
 <div class="sectionbody">\r
@@ -300,7 +303,8 @@ one patch.</p>
 <dd>\r
 <p>\r
         Use &lt;dir&gt; to store the resulting files, instead of the\r
-        current working directory.\r
+        current working directory. This option is ignored if\r
+        --stdout is specified.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -312,33 +316,29 @@ one patch.</p>
 </p>\r
 </dd>\r
 <dt>\r
--k|--keep-subject\r
+--start-number &lt;n&gt;\r
 </dt>\r
 <dd>\r
 <p>\r
-        Do not strip/add <em>[PATCH]</em> from the first line of the\r
-        commit log message.\r
+        Start numbering the patches at &lt;n&gt; instead of 1.\r
 </p>\r
 </dd>\r
 <dt>\r
--s|--signoff\r
+-k|--keep-subject\r
 </dt>\r
 <dd>\r
 <p>\r
-        Add <tt>Signed-off-by:</tt> line to the commit message, using\r
-        the committer identity of yourself.\r
+        Do not strip/add <em>[PATCH]</em> from the first line of the\r
+        commit log message.\r
 </p>\r
 </dd>\r
 <dt>\r
--c|--check\r
+-s|--signoff\r
 </dt>\r
 <dd>\r
 <p>\r
-        Display suspicious lines in the patch.  The definition\r
-        of <em>suspicious lines</em> is currently the lines that has\r
-        trailing whitespaces, and the lines whose indentation\r
-        has a SP character immediately followed by a TAB\r
-        character.\r
+        Add <tt>Signed-off-by:</tt> line to the commit message, using\r
+        the committer identity of yourself.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -346,9 +346,8 @@ one patch.</p>
 </dt>\r
 <dd>\r
 <p>\r
-        This flag generates the mbox formatted output to the\r
-        standard output, instead of saving them into a file per\r
-        patch and implies --mbox.\r
+        Print all commits to the standard output in mbox format,\r
+        instead of creating a file for each one.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -388,9 +387,9 @@ git-format-patch origin
 </dt>\r
 <dd>\r
 <p>\r
-        Extract commits the current branch accumulated since it\r
-        pulled from origin the last time in a patch form for\r
-        e-mail submission.\r
+        Extract all commits which are in the current branch but\r
+        not in the origin branch.  For each commit a separate file\r
+        is created in the current directory.\r
 </p>\r
 </dd>\r
 <dt>\r
@@ -398,13 +397,13 @@ git-format-patch -M -B origin
 </dt>\r
 <dd>\r
 <p>\r
-        The same as the previous one, except detect and handle\r
-        renames and complete rewrites intelligently to produce\r
-        renaming patch.  A renaming patch reduces the amount of\r
-        text output, and generally makes it easier to review\r
-        it.  Note that the "patch" program does not understand\r
-        renaming patch well, so use it only when you know the\r
-        recipient uses git to apply your patch.\r
+        The same as the previous one.  Additionally, it detects\r
+        and handles renames and complete rewrites intelligently to\r
+        produce a renaming patch.  A renaming patch reduces the\r
+        amount of text output, and generally makes it easier to\r
+        review it.  Note that the "patch" program does not\r
+        understand renaming patches, so use it only when you know\r
+        the recipient uses git to apply your patch.\r
 </p>\r
 </dd>\r
 </dl>\r
@@ -427,7 +426,7 @@ git-format-patch -M -B origin
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 11-Mar-2006 08:04:28 UTC\r
+Last updated 04-Jun-2006 07:24:26 UTC\r
 </div>\r
 </div>\r
 </body>\r