Documentation/git-apply.txt

   1 git-apply(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-apply - Apply a patch to files and/or to the index
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git apply' [--stat] [--numstat] [--summary] [--check] [--index] [--3way]
  13           [--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
  14           [--allow-binary-replacement | --binary] [--reject] [-z]
  15           [-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
  16           [--ignore-space-change | --ignore-whitespace ]
  17           [--whitespace=(nowarn|warn|fix|error|error-all)]
  18           [--exclude=<path>] [--include=<path>] [--directory=<root>]
  19           [--verbose] [--unsafe-paths] [<patch>...]
  20
  21 DESCRIPTION
  22 -----------
  23 Reads the supplied diff output (i.e. "a patch") and applies it to files.
  24 With the `--index` option the patch is also applied to the index, and
  25 with the `--cached` option the patch is only applied to the index.
  26 Without these options, the command applies the patch only to files,
  27 and does not require them to be in a Git repository.
  28
  29 This command applies the patch but does not create a commit.  Use
  30 linkgit:git-am[1] to create commits from patches generated by
  31 linkgit:git-format-patch[1] and/or received by email.
  32
  33 OPTIONS
  34 -------
  35 <patch>...::
  36         The files to read the patch from.  '-' can be used to read
  37         from the standard input.
  38
  39 --stat::
  40         Instead of applying the patch, output diffstat for the
  41         input.  Turns off "apply".
  42
  43 --numstat::
  44         Similar to `--stat`, but shows the number of added and
  45         deleted lines in decimal notation and the pathname without
  46         abbreviation, to make it more machine friendly.  For
  47         binary files, outputs two `-` instead of saying
  48         `0 0`.  Turns off "apply".
  49
  50 --summary::
  51         Instead of applying the patch, output a condensed
  52         summary of information obtained from git diff extended
  53         headers, such as creations, renames and mode changes.
  54         Turns off "apply".
  55
  56 --check::
  57         Instead of applying the patch, see if the patch is
  58         applicable to the current working tree and/or the index
  59         file and detects errors.  Turns off "apply".
  60
  61 --index::
  62         When `--check` is in effect, or when applying the patch
  63         (which is the default when none of the options that
  64         disables it is in effect), make sure the patch is
  65         applicable to what the current index file records.  If
  66         the file to be patched in the working tree is not
  67         up-to-date, it is flagged as an error.  This flag also
  68         causes the index file to be updated.
  69
  70 --cached::
  71         Apply a patch without touching the working tree. Instead take the
  72         cached data, apply the patch, and store the result in the index
  73         without using the working tree. This implies `--index`.
  74
  75 -3::
  76 --3way::
  77         When the patch does not apply cleanly, fall back on 3-way merge if
  78         the patch records the identity of blobs it is supposed to apply to,
  79         and we have those blobs available locally, possibly leaving the
  80         conflict markers in the files in the working tree for the user to
  81         resolve.  This option implies the `--index` option, and is incompatible
  82         with the `--reject` and the `--cached` options.
  83
  84 --build-fake-ancestor=<file>::
  85         Newer 'git diff' output has embedded 'index information'
  86         for each blob to help identify the original version that
  87         the patch applies to.  When this flag is given, and if
  88         the original versions of the blobs are available locally,
  89         builds a temporary index containing those blobs.
  90 +
  91 When a pure mode change is encountered (which has no index information),
  92 the information is read from the current index instead.
  93
  94 -R::
  95 --reverse::
  96         Apply the patch in reverse.
  97
  98 --reject::
  99         For atomicity, 'git apply' by default fails the whole patch and
 100         does not touch the working tree when some of the hunks
 101         do not apply.  This option makes it apply
 102         the parts of the patch that are applicable, and leave the
 103         rejected hunks in corresponding *.rej files.
 104
 105 -z::
 106         When `--numstat` has been given, do not munge pathnames,
 107         but use a NUL-terminated machine-readable format.
 108 +
 109 Without this option, each pathname output will have TAB, LF, double quotes,
 110 and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
 111 respectively, and the pathname will be enclosed in double quotes if
 112 any of those replacements occurred.
 113
 114 -p<n>::
 115         Remove <n> leading slashes from traditional diff paths. The
 116         default is 1.
 117
 118 -C<n>::
 119         Ensure at least <n> lines of surrounding context match before
 120         and after each change.  When fewer lines of surrounding
 121         context exist they all must match.  By default no context is
 122         ever ignored.
 123
 124 --unidiff-zero::
 125         By default, 'git apply' expects that the patch being
 126         applied is a unified diff with at least one line of context.
 127         This provides good safety measures, but breaks down when
 128         applying a diff generated with `--unified=0`. To bypass these
 129         checks use `--unidiff-zero`.
 130 +
 131 Note, for the reasons stated above usage of context-free patches is
 132 discouraged.
 133
 134 --apply::
 135         If you use any of the options marked "Turns off
 136         'apply'" above, 'git apply' reads and outputs the
 137         requested information without actually applying the
 138         patch.  Give this flag after those flags to also apply
 139         the patch.
 140
 141 --no-add::
 142         When applying a patch, ignore additions made by the
 143         patch.  This can be used to extract the common part between
 144         two files by first running 'diff' on them and applying
 145         the result with this option, which would apply the
 146         deletion part but not the addition part.
 147
 148 --allow-binary-replacement::
 149 --binary::
 150         Historically we did not allow binary patch applied
 151         without an explicit permission from the user, and this
 152         flag was the way to do so.  Currently we always allow binary
 153         patch application, so this is a no-op.
 154
 155 --exclude=<path-pattern>::
 156         Don't apply changes to files matching the given path pattern. This can
 157         be useful when importing patchsets, where you want to exclude certain
 158         files or directories.
 159
 160 --include=<path-pattern>::
 161         Apply changes to files matching the given path pattern. This can
 162         be useful when importing patchsets, where you want to include certain
 163         files or directories.
 164 +
 165 When `--exclude` and `--include` patterns are used, they are examined in the
 166 order they appear on the command line, and the first match determines if a
 167 patch to each path is used.  A patch to a path that does not match any
 168 include/exclude pattern is used by default if there is no include pattern
 169 on the command line, and ignored if there is any include pattern.
 170
 171 --ignore-space-change::
 172 --ignore-whitespace::
 173         When applying a patch, ignore changes in whitespace in context
 174         lines if necessary.
 175         Context lines will preserve their whitespace, and they will not
 176         undergo whitespace fixing regardless of the value of the
 177         `--whitespace` option. New lines will still be fixed, though.
 178
 179 --whitespace=<action>::
 180         When applying a patch, detect a new or modified line that has
 181         whitespace errors.  What are considered whitespace errors is
 182         controlled by `core.whitespace` configuration.  By default,
 183         trailing whitespaces (including lines that solely consist of
 184         whitespaces) and a space character that is immediately followed
 185         by a tab character inside the initial indent of the line are
 186         considered whitespace errors.
 187 +
 188 By default, the command outputs warning messages but applies the patch.
 189 When `git-apply` is used for statistics and not applying a
 190 patch, it defaults to `nowarn`.
 191 +
 192 You can use different `<action>` values to control this
 193 behavior:
 194 +
 195 * `nowarn` turns off the trailing whitespace warning.
 196 * `warn` outputs warnings for a few such errors, but applies the
 197   patch as-is (default).
 198 * `fix` outputs warnings for a few such errors, and applies the
 199   patch after fixing them (`strip` is a synonym --- the tool
 200   used to consider only trailing whitespace characters as errors, and the
 201   fix involved 'stripping' them, but modern Gits do more).
 202 * `error` outputs warnings for a few such errors, and refuses
 203   to apply the patch.
 204 * `error-all` is similar to `error` but shows all errors.
 205
 206 --inaccurate-eof::
 207         Under certain circumstances, some versions of 'diff' do not correctly
 208         detect a missing new-line at the end of the file. As a result, patches
 209         created by such 'diff' programs do not record incomplete lines
 210         correctly. This option adds support for applying such patches by
 211         working around this bug.
 212
 213 -v::
 214 --verbose::
 215         Report progress to stderr. By default, only a message about the
 216         current patch being applied will be printed. This option will cause
 217         additional information to be reported.
 218
 219 --recount::
 220         Do not trust the line counts in the hunk headers, but infer them
 221         by inspecting the patch (e.g. after editing the patch without
 222         adjusting the hunk headers appropriately).
 223
 224 --directory=<root>::
 225         Prepend <root> to all filenames.  If a "-p" argument was also passed,
 226         it is applied before prepending the new root.
 227 +
 228 For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`
 229 can be applied to the file in the working tree `modules/git-gui/git-gui.sh` by
 230 running `git apply --directory=modules/git-gui`.
 231
 232 --unsafe-paths::
 233         By default, a patch that affects outside the working area
 234         (either a Git controlled working tree, or the current working
 235         directory when "git apply" is used as a replacement of GNU
 236         patch) is rejected as a mistake (or a mischief).
 237 +
 238 When `git apply` is used as a "better GNU patch", the user can pass
 239 the `--unsafe-paths` option to override this safety check.  This option
 240 has no effect when `--index` or `--cached` is in use.
 241
 242 Configuration
 243 -------------
 244
 245 apply.ignoreWhitespace::
 246         Set to 'change' if you want changes in whitespace to be ignored by default.
 247         Set to one of: no, none, never, false if you want changes in
 248         whitespace to be significant.
 249 apply.whitespace::
 250         When no `--whitespace` flag is given from the command
 251         line, this configuration item is used as the default.
 252
 253 Submodules
 254 ----------
 255 If the patch contains any changes to submodules then 'git apply'
 256 treats these changes as follows.
 257
 258 If `--index` is specified (explicitly or implicitly), then the submodule
 259 commits must match the index exactly for the patch to apply.  If any
 260 of the submodules are checked-out, then these check-outs are completely
 261 ignored, i.e., they are not required to be up-to-date or clean and they
 262 are not updated.
 263
 264 If `--index` is not specified, then the submodule commits in the patch
 265 are ignored and only the absence or presence of the corresponding
 266 subdirectory is checked and (if possible) updated.
 267
 268 SEE ALSO
 269 --------
 270 linkgit:git-am[1].
 271
 272 GIT
 273 ---
 274 Part of the linkgit:git[1] suite