Documentation/git-apply.txt

   1 git-apply(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-apply - Apply patch on a git index file and a work tree
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply]
  13           [--no-add] [--index-info] [--allow-binary-replacement]
  14           [--reverse] [-z] [-pNUM]
  15           [-CNUM] [--whitespace=<nowarn|warn|error|error-all|strip>]
  16           [<patch>...]
  17
  18 DESCRIPTION
  19 -----------
  20 Reads supplied diff output and applies it on a git index file
  21 and a work tree.
  22
  23 OPTIONS
  24 -------
  25 <patch>...::
  26         The files to read patch from.  '-' can be used to read
  27         from the standard input.
  28
  29 --stat::
  30         Instead of applying the patch, output diffstat for the
  31         input.  Turns off "apply".
  32
  33 --numstat::
  34         Similar to \--stat, but shows number of added and
  35         deleted lines in decimal notation and pathname without
  36         abbreviation, to make it more machine friendly.  Turns
  37         off "apply".
  38
  39 --summary::
  40         Instead of applying the patch, output a condensed
  41         summary of information obtained from git diff extended
  42         headers, such as creations, renames and mode changes.
  43         Turns off "apply".
  44
  45 --check::
  46         Instead of applying the patch, see if the patch is
  47         applicable to the current work tree and/or the index
  48         file and detects errors.  Turns off "apply".
  49
  50 --index::
  51         When --check is in effect, or when applying the patch
  52         (which is the default when none of the options that
  53         disables it is in effect), make sure the patch is
  54         applicable to what the current index file records.  If
  55         the file to be patched in the work tree is not
  56         up-to-date, it is flagged as an error.  This flag also
  57         causes the index file to be updated.
  58
  59 --index-info::
  60         Newer git-diff output has embedded 'index information'
  61         for each blob to help identify the original version that
  62         the patch applies to.  When this flag is given, and if
  63         the original version of the blob is available locally,
  64         outputs information about them to the standard output.
  65
  66 --reverse::
  67         Apply the patch in reverse.
  68
  69 -z::
  70         When showing the index information, do not munge paths,
  71         but use NUL terminated machine readable format.  Without
  72         this flag, the pathnames output will have TAB, LF, and
  73         backslash characters replaced with `\t`, `\n`, and `\\`,
  74         respectively.
  75
  76 -p<n>::
  77         Remove <n> leading slashes from traditional diff paths. The
  78         default is 1.
  79
  80 -C<n>::
  81         Ensure at least <n> lines of surrounding context match before
  82         and after each change.  When fewer lines of surrounding
  83         context exist they all must match.  By default no context is
  84         ever ignored.
  85
  86 --apply::
  87         If you use any of the options marked ``Turns off
  88         "apply"'' above, git-apply reads and outputs the
  89         information you asked without actually applying the
  90         patch.  Give this flag after those flags to also apply
  91         the patch.
  92
  93 --no-add::
  94         When applying a patch, ignore additions made by the
  95         patch.  This can be used to extract common part between
  96         two files by first running `diff` on them and applying
  97         the result with this option, which would apply the
  98         deletion part but not addition part.
  99
 100 --allow-binary-replacement::
 101         When applying a patch, which is a git-enhanced patch
 102         that was prepared to record the pre- and post-image object
 103         name in full, and the path being patched exactly matches
 104         the object the patch applies to (i.e. "index" line's
 105         pre-image object name is what is in the working tree),
 106         and the post-image object is available in the object
 107         database, use the post-image object as the patch
 108         result.  This allows binary files to be patched in a
 109         very limited way.
 110
 111 --whitespace=<option>::
 112         When applying a patch, detect a new or modified line
 113         that ends with trailing whitespaces (this includes a
 114         line that solely consists of whitespaces).  By default,
 115         the command outputs warning messages and applies the
 116         patch.
 117         When `git-apply` is used for statistics and not applying a
 118         patch, it defaults to `nowarn`.
 119         You can use different `<option>` to control this
 120         behavior:
 121 +
 122 * `nowarn` turns off the trailing whitespace warning.
 123 * `warn` outputs warnings for a few such errors, but applies the
 124   patch (default).
 125 * `error` outputs warnings for a few such errors, and refuses
 126   to apply the patch.
 127 * `error-all` is similar to `error` but shows all errors.
 128 * `strip` outputs warnings for a few such errors, strips out the
 129   trailing whitespaces and applies the patch.
 130
 131
 132 Configuration
 133 -------------
 134
 135 apply.whitespace::
 136         When no `--whitespace` flag is given from the command
 137         line, this configuration item is used as the default.
 138
 139
 140 Author
 141 ------
 142 Written by Linus Torvalds <torvalds@osdl.org>
 143
 144 Documentation
 145 --------------
 146 Documentation by Junio C Hamano
 147
 148 GIT
 149 ---
 150 Part of the gitlink:git[7] suite
 151