6 git-apply - Apply a patch to files and/or to the index
12 'git apply' [--stat] [--numstat] [--summary] [--check] [--index | --intent-to-add] [--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>...]
23 Reads the supplied diff output (i.e. "a patch") and applies it to files.
24 When running from a subdirectory in a repository, patched paths
25 outside the directory are ignored.
26 With the `--index` option the patch is also applied to the index, and
27 with the `--cached` option the patch is only applied to the index.
28 Without these options, the command applies the patch only to files,
29 and does not require them to be in a Git repository.
31 This command applies the patch but does not create a commit. Use
32 linkgit:git-am[1] to create commits from patches generated by
33 linkgit:git-format-patch[1] and/or received by email.
38 The files to read the patch from. '-' can be used to read
39 from the standard input.
42 Instead of applying the patch, output diffstat for the
43 input. Turns off "apply".
46 Similar to `--stat`, but shows the number of added and
47 deleted lines in decimal notation and the pathname without
48 abbreviation, to make it more machine friendly. For
49 binary files, outputs two `-` instead of saying
50 `0 0`. Turns off "apply".
53 Instead of applying the patch, output a condensed
54 summary of information obtained from git diff extended
55 headers, such as creations, renames and mode changes.
59 Instead of applying the patch, see if the patch is
60 applicable to the current working tree and/or the index
61 file and detects errors. Turns off "apply".
64 Apply the patch to both the index and the working tree (or
65 merely check that it would apply cleanly to both if `--check` is
66 in effect). Note that `--index` expects index entries and
67 working tree copies for relevant paths to be identical (their
68 contents and metadata such as file mode must match), and will
69 raise an error if they are not, even if the patch would apply
70 cleanly to both the index and the working tree in isolation.
73 Apply the patch to just the index, without touching the working
74 tree. If `--check` is in effect, merely check that it would
75 apply cleanly to the index entry.
78 When applying the patch only to the working tree, mark new
79 files to be added to the index later (see `--intent-to-add`
80 option in linkgit:git-add[1]). This option is ignored unless
81 running in a Git repository and `--index` is not specified.
82 Note that `--index` could be implied by other options such
83 as `--cached` or `--3way`.
87 Attempt 3-way merge if the patch records the identity of blobs it is supposed
88 to apply to and we have those blobs available locally, possibly leaving the
89 conflict markers in the files in the working tree for the user to
90 resolve. This option implies the `--index` option, and is incompatible
91 with the `--reject` and the `--cached` options.
93 --build-fake-ancestor=<file>::
94 Newer 'git diff' output has embedded 'index information'
95 for each blob to help identify the original version that
96 the patch applies to. When this flag is given, and if
97 the original versions of the blobs are available locally,
98 builds a temporary index containing those blobs.
100 When a pure mode change is encountered (which has no index information),
101 the information is read from the current index instead.
105 Apply the patch in reverse.
108 For atomicity, 'git apply' by default fails the whole patch and
109 does not touch the working tree when some of the hunks
110 do not apply. This option makes it apply
111 the parts of the patch that are applicable, and leave the
112 rejected hunks in corresponding *.rej files.
115 When `--numstat` has been given, do not munge pathnames,
116 but use a NUL-terminated machine-readable format.
118 Without this option, pathnames with "unusual" characters are quoted as
119 explained for the configuration variable `core.quotePath` (see
120 linkgit:git-config[1]).
123 Remove <n> leading path components (separated by slashes) from
124 traditional diff paths. E.g., with `-p2`, a patch against
125 `a/dir/file` will be applied directly to `file`. The default is
129 Ensure at least <n> lines of surrounding context match before
130 and after each change. When fewer lines of surrounding
131 context exist they all must match. By default no context is
135 By default, 'git apply' expects that the patch being
136 applied is a unified diff with at least one line of context.
137 This provides good safety measures, but breaks down when
138 applying a diff generated with `--unified=0`. To bypass these
139 checks use `--unidiff-zero`.
141 Note, for the reasons stated above usage of context-free patches is
145 If you use any of the options marked "Turns off
146 'apply'" above, 'git apply' reads and outputs the
147 requested information without actually applying the
148 patch. Give this flag after those flags to also apply
152 When applying a patch, ignore additions made by the
153 patch. This can be used to extract the common part between
154 two files by first running 'diff' on them and applying
155 the result with this option, which would apply the
156 deletion part but not the addition part.
158 --allow-binary-replacement::
160 Historically we did not allow binary patch applied
161 without an explicit permission from the user, and this
162 flag was the way to do so. Currently we always allow binary
163 patch application, so this is a no-op.
165 --exclude=<path-pattern>::
166 Don't apply changes to files matching the given path pattern. This can
167 be useful when importing patchsets, where you want to exclude certain
168 files or directories.
170 --include=<path-pattern>::
171 Apply changes to files matching the given path pattern. This can
172 be useful when importing patchsets, where you want to include certain
173 files or directories.
175 When `--exclude` and `--include` patterns are used, they are examined in the
176 order they appear on the command line, and the first match determines if a
177 patch to each path is used. A patch to a path that does not match any
178 include/exclude pattern is used by default if there is no include pattern
179 on the command line, and ignored if there is any include pattern.
181 --ignore-space-change::
182 --ignore-whitespace::
183 When applying a patch, ignore changes in whitespace in context
185 Context lines will preserve their whitespace, and they will not
186 undergo whitespace fixing regardless of the value of the
187 `--whitespace` option. New lines will still be fixed, though.
189 --whitespace=<action>::
190 When applying a patch, detect a new or modified line that has
191 whitespace errors. What are considered whitespace errors is
192 controlled by `core.whitespace` configuration. By default,
193 trailing whitespaces (including lines that solely consist of
194 whitespaces) and a space character that is immediately followed
195 by a tab character inside the initial indent of the line are
196 considered whitespace errors.
198 By default, the command outputs warning messages but applies the patch.
199 When `git-apply` is used for statistics and not applying a
200 patch, it defaults to `nowarn`.
202 You can use different `<action>` values to control this
205 * `nowarn` turns off the trailing whitespace warning.
206 * `warn` outputs warnings for a few such errors, but applies the
207 patch as-is (default).
208 * `fix` outputs warnings for a few such errors, and applies the
209 patch after fixing them (`strip` is a synonym --- the tool
210 used to consider only trailing whitespace characters as errors, and the
211 fix involved 'stripping' them, but modern Gits do more).
212 * `error` outputs warnings for a few such errors, and refuses
214 * `error-all` is similar to `error` but shows all errors.
217 Under certain circumstances, some versions of 'diff' do not correctly
218 detect a missing new-line at the end of the file. As a result, patches
219 created by such 'diff' programs do not record incomplete lines
220 correctly. This option adds support for applying such patches by
221 working around this bug.
225 Report progress to stderr. By default, only a message about the
226 current patch being applied will be printed. This option will cause
227 additional information to be reported.
230 Do not trust the line counts in the hunk headers, but infer them
231 by inspecting the patch (e.g. after editing the patch without
232 adjusting the hunk headers appropriately).
235 Prepend <root> to all filenames. If a "-p" argument was also passed,
236 it is applied before prepending the new root.
238 For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`
239 can be applied to the file in the working tree `modules/git-gui/git-gui.sh` by
240 running `git apply --directory=modules/git-gui`.
243 By default, a patch that affects outside the working area
244 (either a Git controlled working tree, or the current working
245 directory when "git apply" is used as a replacement of GNU
246 patch) is rejected as a mistake (or a mischief).
248 When `git apply` is used as a "better GNU patch", the user can pass
249 the `--unsafe-paths` option to override this safety check. This option
250 has no effect when `--index` or `--cached` is in use.
255 apply.ignoreWhitespace::
256 Set to 'change' if you want changes in whitespace to be ignored by default.
257 Set to one of: no, none, never, false if you want changes in
258 whitespace to be significant.
260 When no `--whitespace` flag is given from the command
261 line, this configuration item is used as the default.
265 If the patch contains any changes to submodules then 'git apply'
266 treats these changes as follows.
268 If `--index` is specified (explicitly or implicitly), then the submodule
269 commits must match the index exactly for the patch to apply. If any
270 of the submodules are checked-out, then these check-outs are completely
271 ignored, i.e., they are not required to be up to date or clean and they
274 If `--index` is not specified, then the submodule commits in the patch
275 are ignored and only the absence or presence of the corresponding
276 subdirectory is checked and (if possible) updated.
284 Part of the linkgit:git[1] suite