git-apply.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-apply(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-apply(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-apply -\r
 269    Apply patch on a git index file and a work tree\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-apply</em> [--stat] [--numstat] [--summary] [--check] [--index] [--apply]\r
 277           [--no-add] [--index-info] [--allow-binary-replacement] [-z] [-pNUM]\r
 278           [-CNUM] [--whitespace=&lt;nowarn|warn|error|error-all|strip&gt;]\r
 279           [&lt;patch&gt;&#8230;]</div></div>\r
 280 </div>\r
 281 <h2>DESCRIPTION</h2>\r
 282 <div class="sectionbody">\r
 283 <p>Reads supplied diff output and applies it on a git index file\r
 284 and a work tree.</p>\r
 285 </div>\r
 286 <h2>OPTIONS</h2>\r
 287 <div class="sectionbody">\r
 288 <dl>\r
 289 <dt>\r
 290 &lt;patch&gt;&#8230;\r
 291 </dt>\r
 292 <dd>\r
 293 <p>\r
 294         The files to read patch from.  <em>-</em> can be used to read\r
 295         from the standard input.\r
 296 </p>\r
 297 </dd>\r
 298 <dt>\r
 299 --stat\r
 300 </dt>\r
 301 <dd>\r
 302 <p>\r
 303         Instead of applying the patch, output diffstat for the\r
 304         input.  Turns off "apply".\r
 305 </p>\r
 306 </dd>\r
 307 <dt>\r
 308 --numstat\r
 309 </dt>\r
 310 <dd>\r
 311 <p>\r
 312         Similar to --stat, but shows number of added and\r
 313         deleted lines in decimal notation and pathname without\r
 314         abbreviation, to make it more machine friendly.  Turns\r
 315         off "apply".\r
 316 </p>\r
 317 </dd>\r
 318 <dt>\r
 319 --summary\r
 320 </dt>\r
 321 <dd>\r
 322 <p>\r
 323         Instead of applying the patch, output a condensed\r
 324         summary of information obtained from git diff extended\r
 325         headers, such as creations, renames and mode changes.\r
 326         Turns off "apply".\r
 327 </p>\r
 328 </dd>\r
 329 <dt>\r
 330 --check\r
 331 </dt>\r
 332 <dd>\r
 333 <p>\r
 334         Instead of applying the patch, see if the patch is\r
 335         applicable to the current work tree and/or the index\r
 336         file and detects errors.  Turns off "apply".\r
 337 </p>\r
 338 </dd>\r
 339 <dt>\r
 340 --index\r
 341 </dt>\r
 342 <dd>\r
 343 <p>\r
 344         When --check is in effect, or when applying the patch\r
 345         (which is the default when none of the options that\r
 346         disables it is in effect), make sure the patch is\r
 347         applicable to what the current index file records.  If\r
 348         the file to be patched in the work tree is not\r
 349         up-to-date, it is flagged as an error.  This flag also\r
 350         causes the index file to be updated.\r
 351 </p>\r
 352 </dd>\r
 353 <dt>\r
 354 --index-info\r
 355 </dt>\r
 356 <dd>\r
 357 <p>\r
 358         Newer git-diff output has embedded <em>index information</em>\r
 359         for each blob to help identify the original version that\r
 360         the patch applies to.  When this flag is given, and if\r
 361         the original version of the blob is available locally,\r
 362         outputs information about them to the standard output.\r
 363 </p>\r
 364 </dd>\r
 365 <dt>\r
 366 -z\r
 367 </dt>\r
 368 <dd>\r
 369 <p>\r
 370         When showing the index information, do not munge paths,\r
 371         but use NUL terminated machine readable format.  Without\r
 372         this flag, the pathnames output will have TAB, LF, and\r
 373         backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>,\r
 374         respectively.\r
 375 </p>\r
 376 </dd>\r
 377 <dt>\r
 378 -p&lt;n&gt;\r
 379 </dt>\r
 380 <dd>\r
 381 <p>\r
 382         Remove &lt;n&gt; leading slashes from traditional diff paths. The\r
 383         default is 1.\r
 384 </p>\r
 385 </dd>\r
 386 <dt>\r
 387 -C&lt;n&gt;\r
 388 </dt>\r
 389 <dd>\r
 390 <p>\r
 391         Ensure at least &lt;n&gt; lines of surrounding context match before\r
 392         and after each change.  When fewer lines of surrounding\r
 393         context exist they all must match.  By default no context is\r
 394         ever ignored.\r
 395 </p>\r
 396 </dd>\r
 397 <dt>\r
 398 --apply\r
 399 </dt>\r
 400 <dd>\r
 401 <p>\r
 402         If you use any of the options marked &#8220;Turns off\r
 403         "apply"&#8221; above, git-apply reads and outputs the\r
 404         information you asked without actually applying the\r
 405         patch.  Give this flag after those flags to also apply\r
 406         the patch.\r
 407 </p>\r
 408 </dd>\r
 409 <dt>\r
 410 --no-add\r
 411 </dt>\r
 412 <dd>\r
 413 <p>\r
 414         When applying a patch, ignore additions made by the\r
 415         patch.  This can be used to extract common part between\r
 416         two files by first running <tt>diff</tt> on them and applying\r
 417         the result with this option, which would apply the\r
 418         deletion part but not addition part.\r
 419 </p>\r
 420 </dd>\r
 421 <dt>\r
 422 --allow-binary-replacement\r
 423 </dt>\r
 424 <dd>\r
 425 <p>\r
 426         When applying a patch, which is a git-enhanced patch\r
 427         that was prepared to record the pre- and post-image object\r
 428         name in full, and the path being patched exactly matches\r
 429         the object the patch applies to (i.e. "index" line's\r
 430         pre-image object name is what is in the working tree),\r
 431         and the post-image object is available in the object\r
 432         database, use the post-image object as the patch\r
 433         result.  This allows binary files to be patched in a\r
 434         very limited way.\r
 435 </p>\r
 436 </dd>\r
 437 <dt>\r
 438 --whitespace=&lt;option&gt;\r
 439 </dt>\r
 440 <dd>\r
 441 <p>\r
 442         When applying a patch, detect a new or modified line\r
 443         that ends with trailing whitespaces (this includes a\r
 444         line that solely consists of whitespaces).  By default,\r
 445         the command outputs warning messages and applies the\r
 446         patch.\r
 447         When <tt>git-apply</tt> is used for statistics and not applying a\r
 448         patch, it defaults to <tt>nowarn</tt>.\r
 449         You can use different <tt>&lt;option&gt;</tt> to control this\r
 450         behavior:\r
 451 </p>\r
 452 <ul>\r
 453 <li>\r
 454 <p>\r
 455 <tt>nowarn</tt> turns off the trailing whitespace warning.\r
 456 </p>\r
 457 </li>\r
 458 <li>\r
 459 <p>\r
 460 <tt>warn</tt> outputs warnings for a few such errors, but applies the\r
 461   patch (default).\r
 462 </p>\r
 463 </li>\r
 464 <li>\r
 465 <p>\r
 466 <tt>error</tt> outputs warnings for a few such errors, and refuses\r
 467   to apply the patch.\r
 468 </p>\r
 469 </li>\r
 470 <li>\r
 471 <p>\r
 472 <tt>error-all</tt> is similar to <tt>error</tt> but shows all errors.\r
 473 </p>\r
 474 </li>\r
 475 <li>\r
 476 <p>\r
 477 <tt>strip</tt> outputs warnings for a few such errors, strips out the\r
 478   trailing whitespaces and applies the patch.\r
 479 </p>\r
 480 </li>\r
 481 </ul>\r
 482 </dd>\r
 483 </dl>\r
 484 </div>\r
 485 <h2>Configuration</h2>\r
 486 <div class="sectionbody">\r
 487 <dl>\r
 488 <dt>\r
 489 apply.whitespace\r
 490 </dt>\r
 491 <dd>\r
 492 <p>\r
 493         When no <tt>--whitespace</tt> flag is given from the command\r
 494         line, this configuration item is used as the default.\r
 495 </p>\r
 496 </dd>\r
 497 </dl>\r
 498 </div>\r
 499 <h2>Author</h2>\r
 500 <div class="sectionbody">\r
 501 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 502 </div>\r
 503 <h2>Documentation</h2>\r
 504 <div class="sectionbody">\r
 505 <p>Documentation by Junio C Hamano</p>\r
 506 </div>\r
 507 <h2>GIT</h2>\r
 508 <div class="sectionbody">\r
 509 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 510 </div>\r
 511 <div id="footer">\r
 512 <div id="footer-text">\r
 513 Last updated 07-Jun-2006 19:51:29 UTC\r
 514 </div>\r
 515 </div>\r
 516 </body>\r
 517 </html>\r