git-format-patch.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-format-patch(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-format-patch(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-format-patch -\r
 269    Prepare patches for e-mail submission\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content"><em>git-format-patch</em> [-n | -k] [-o &lt;dir&gt; | --stdout] [--attach]\r
 277                    [-s | --signoff] [--diff-options] [--start-number &lt;n&gt;]\r
 278                    &lt;since&gt;[..&lt;until&gt;]</div></div>\r
 279 </div>\r
 280 <h2>DESCRIPTION</h2>\r
 281 <div class="sectionbody">\r
 282 <p>Prepare each commit between &lt;since&gt; and &lt;until&gt; with its patch in\r
 283 one file per commit, formatted to resemble UNIX mailbox format.\r
 284 If ..&lt;until&gt; is not specified, the head of the current working\r
 285 tree is implied.</p>\r
 286 <p>The output of this command is convenient for e-mail submission or\r
 287 for use with <a href="git-am.html">git-am(1)</a>.</p>\r
 288 <p>Each output file is numbered sequentially from 1, and uses the\r
 289 first line of the commit message (massaged for pathname safety) as\r
 290 the filename. The names of the output files are printed to standard\r
 291 output, unless the --stdout option is specified.</p>\r
 292 <p>If -o is specified, output files are created in &lt;dir&gt;.  Otherwise\r
 293 they are created in the current working directory.</p>\r
 294 <p>If -n is specified, instead of "[PATCH] Subject", the first line\r
 295 is formatted as "[PATCH n/m] Subject".</p>\r
 296 </div>\r
 297 <h2>OPTIONS</h2>\r
 298 <div class="sectionbody">\r
 299 <dl>\r
 300 <dt>\r
 301 -o|--output-directory &lt;dir&gt;\r
 302 </dt>\r
 303 <dd>\r
 304 <p>\r
 305         Use &lt;dir&gt; to store the resulting files, instead of the\r
 306         current working directory. This option is ignored if\r
 307         --stdout is specified.\r
 308 </p>\r
 309 </dd>\r
 310 <dt>\r
 311 -n|--numbered\r
 312 </dt>\r
 313 <dd>\r
 314 <p>\r
 315         Name output in <em>[PATCH n/m]</em> format.\r
 316 </p>\r
 317 </dd>\r
 318 <dt>\r
 319 --start-number &lt;n&gt;\r
 320 </dt>\r
 321 <dd>\r
 322 <p>\r
 323         Start numbering the patches at &lt;n&gt; instead of 1.\r
 324 </p>\r
 325 </dd>\r
 326 <dt>\r
 327 -k|--keep-subject\r
 328 </dt>\r
 329 <dd>\r
 330 <p>\r
 331         Do not strip/add <em>[PATCH]</em> from the first line of the\r
 332         commit log message.\r
 333 </p>\r
 334 </dd>\r
 335 <dt>\r
 336 -s|--signoff\r
 337 </dt>\r
 338 <dd>\r
 339 <p>\r
 340         Add <tt>Signed-off-by:</tt> line to the commit message, using\r
 341         the committer identity of yourself.\r
 342 </p>\r
 343 </dd>\r
 344 <dt>\r
 345 --stdout\r
 346 </dt>\r
 347 <dd>\r
 348 <p>\r
 349         Print all commits to the standard output in mbox format,\r
 350         instead of creating a file for each one.\r
 351 </p>\r
 352 </dd>\r
 353 <dt>\r
 354 --attach\r
 355 </dt>\r
 356 <dd>\r
 357 <p>\r
 358         Create attachments instead of inlining patches.\r
 359 </p>\r
 360 </dd>\r
 361 </dl>\r
 362 </div>\r
 363 <h2>CONFIGURATION</h2>\r
 364 <div class="sectionbody">\r
 365 <p>You can specify extra mail header lines to be added to each\r
 366 message in the repository configuration as follows:</p>\r
 367 <div class="literalblock">\r
 368 <div class="content">\r
 369 <pre><tt>headers = "Organization: git-foo\n"</tt></pre>\r
 370 </div></div>\r
 371 </div>\r
 372 <h2>EXAMPLES</h2>\r
 373 <div class="sectionbody">\r
 374 <dl>\r
 375 <dt>\r
 376 git-format-patch -k --stdout R1..R2 | git-am -3 -k\r
 377 </dt>\r
 378 <dd>\r
 379 <p>\r
 380         Extract commits between revisions R1 and R2, and apply\r
 381         them on top of the current branch using <tt>git-am</tt> to\r
 382         cherry-pick them.\r
 383 </p>\r
 384 </dd>\r
 385 <dt>\r
 386 git-format-patch origin\r
 387 </dt>\r
 388 <dd>\r
 389 <p>\r
 390         Extract all commits which are in the current branch but\r
 391         not in the origin branch.  For each commit a separate file\r
 392         is created in the current directory.\r
 393 </p>\r
 394 </dd>\r
 395 <dt>\r
 396 git-format-patch -M -B origin\r
 397 </dt>\r
 398 <dd>\r
 399 <p>\r
 400         The same as the previous one.  Additionally, it detects\r
 401         and handles renames and complete rewrites intelligently to\r
 402         produce a renaming patch.  A renaming patch reduces the\r
 403         amount of text output, and generally makes it easier to\r
 404         review it.  Note that the "patch" program does not\r
 405         understand renaming patches, so use it only when you know\r
 406         the recipient uses git to apply your patch.\r
 407 </p>\r
 408 </dd>\r
 409 </dl>\r
 410 </div>\r
 411 <h2>See Also</h2>\r
 412 <div class="sectionbody">\r
 413 <p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p>\r
 414 </div>\r
 415 <h2>Author</h2>\r
 416 <div class="sectionbody">\r
 417 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 418 </div>\r
 419 <h2>Documentation</h2>\r
 420 <div class="sectionbody">\r
 421 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 422 </div>\r
 423 <h2>GIT</h2>\r
 424 <div class="sectionbody">\r
 425 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 426 </div>\r
 427 <div id="footer">\r
 428 <div id="footer-text">\r
 429 Last updated 04-Jun-2006 07:24:26 UTC\r
 430 </div>\r
 431 </div>\r
 432 </body>\r
 433 </html>\r