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.1" />\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] [-s] [-c] [--mbox]\r
 277                  [--diff-options] &lt;his&gt; [&lt;mine&gt;]</div></div>\r
 278 </div>\r
 279 <h2>DESCRIPTION</h2>\r
 280 <div class="sectionbody">\r
 281 <p>Prepare each commit with its patch since &lt;mine&gt; head forked from\r
 282 &lt;his&gt; head, one file per patch, for e-mail submission.  Each\r
 283 output file is numbered sequentially from 1, and uses the first\r
 284 line of the commit message (massaged for pathname safety) as the\r
 285 filename.</p>\r
 286 <p>When -o is specified, output files are created in that\r
 287 directory; otherwise in the current working directory.</p>\r
 288 <p>When -n is specified, instead of "[PATCH] Subject", the first\r
 289 line is formatted as "[PATCH N/M] Subject", unless you have only\r
 290 one patch.</p>\r
 291 <p>When --mbox is specified, the output is formatted to resemble\r
 292 UNIX mailbox format, and can be concatenated together for\r
 293 processing with applymbox.</p>\r
 294 </div>\r
 295 <h2>OPTIONS</h2>\r
 296 <div class="sectionbody">\r
 297 <dl>\r
 298 <dt>\r
 299 -o|--output-directory &lt;dir&gt;\r
 300 </dt>\r
 301 <dd>\r
 302 <p>\r
 303         Use &lt;dir&gt; to store the resulting files, instead of the\r
 304         current working directory.\r
 305 </p>\r
 306 </dd>\r
 307 <dt>\r
 308 -n|--numbered\r
 309 </dt>\r
 310 <dd>\r
 311 <p>\r
 312         Name output in <em>[PATCH n/m]</em> format.\r
 313 </p>\r
 314 </dd>\r
 315 <dt>\r
 316 -k|--keep-subject\r
 317 </dt>\r
 318 <dd>\r
 319 <p>\r
 320         Do not strip/add <em>[PATCH]</em> from the first line of the\r
 321         commit log message.\r
 322 </p>\r
 323 </dd>\r
 324 <dt>\r
 325 -a|--author, -d|--date\r
 326 </dt>\r
 327 <dd>\r
 328 <p>\r
 329         Output From: and Date: headers for commits made by\r
 330         yourself as well.  Usually these are output only for\r
 331         commits made by people other than yourself.\r
 332 </p>\r
 333 </dd>\r
 334 <dt>\r
 335 -s|--signoff\r
 336 </dt>\r
 337 <dd>\r
 338 <p>\r
 339         Add <tt>Signed-off-by:</tt> line to the commit message, using\r
 340         the committer identity of yourself.\r
 341 </p>\r
 342 </dd>\r
 343 <dt>\r
 344 -c|--check\r
 345 </dt>\r
 346 <dd>\r
 347 <p>\r
 348         Display suspicious lines in the patch.  The definition\r
 349         of <em>suspicious lines</em> is currently the lines that has\r
 350         trailing whitespaces, and the lines whose indentation\r
 351         has a SP character immediately followed by a TAB\r
 352         character.\r
 353 </p>\r
 354 </dd>\r
 355 <dt>\r
 356 -m|--mbox\r
 357 </dt>\r
 358 <dd>\r
 359 <p>\r
 360         Format the output files for closer to mbox format by\r
 361         adding a phony Unix "From " line, so they can be\r
 362         concatenated together and fed to <tt>git-applymbox</tt>.\r
 363         Implies --author and --date.\r
 364 </p>\r
 365 </dd>\r
 366 <dt>\r
 367 --stdout\r
 368 </dt>\r
 369 <dd>\r
 370 <p>\r
 371         This flag generates the mbox formatted output to the\r
 372         standard output, instead of saving them into a file per\r
 373         patch and implies --mbox.\r
 374 </p>\r
 375 </dd>\r
 376 </dl>\r
 377 </div>\r
 378 <h2>EXAMPLES</h2>\r
 379 <div class="sectionbody">\r
 380 <dl>\r
 381 <dt>\r
 382 git-format-patch -k --stdout R1..R2 | git-am -3 -k\r
 383 </dt>\r
 384 <dd>\r
 385 <p>\r
 386         Extract commits between revisions R1 and R2, and apply\r
 387         them on top of the current branch using <tt>git-am</tt> to\r
 388         cherry-pick them.\r
 389 </p>\r
 390 </dd>\r
 391 <dt>\r
 392 git-format-patch origin\r
 393 </dt>\r
 394 <dd>\r
 395 <p>\r
 396         Extract commits the current branch accumulated since it\r
 397         pulled from origin the last time in a patch form for\r
 398         e-mail submission.\r
 399 </p>\r
 400 </dd>\r
 401 <dt>\r
 402 git-format-patch -M -B origin\r
 403 </dt>\r
 404 <dd>\r
 405 <p>\r
 406         The same as the previous one, except detect and handle\r
 407         renames and complete rewrites intelligently to produce\r
 408         renaming patch.  A renaming patch reduces the amount of\r
 409         text output, and generally makes it easier to review\r
 410         it.  Note that the "patch" program does not understand\r
 411         renaming patch well, so use it only when you know the\r
 412         recipient uses git to apply your patch.\r
 413 </p>\r
 414 </dd>\r
 415 </dl>\r
 416 </div>\r
 417 <h2>See Also</h2>\r
 418 <div class="sectionbody">\r
 419 <p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p>\r
 420 </div>\r
 421 <h2>Author</h2>\r
 422 <div class="sectionbody">\r
 423 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 424 </div>\r
 425 <h2>Documentation</h2>\r
 426 <div class="sectionbody">\r
 427 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 428 </div>\r
 429 <h2>GIT</h2>\r
 430 <div class="sectionbody">\r
 431 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 432 </div>\r
 433 <div id="footer">\r
 434 <div id="footer-text">\r
 435 Last updated 06-Jan-2006 17:12:29 PDT\r
 436 </div>\r
 437 </div>\r
 438 </body>\r
 439 </html>\r