]>
Commit | Line | Data |
---|---|---|
d0587fd5 JH |
1 | git-apply(1) |
2 | ============ | |
d0587fd5 JH |
3 | |
4 | NAME | |
5 | ---- | |
38a39647 | 6 | git-apply - Apply a patch to files and/or to the index |
d0587fd5 JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
353ce815 | 11 | [verse] |
78fb67f3 | 12 | 'git apply' [--stat] [--numstat] [--summary] [--check] [--index] [--3way] |
f26c4940 | 13 | [--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse] |
0b9a9dd0 | 14 | [--allow-binary-replacement | --binary] [--reject] [-z] |
62b4698e | 15 | [-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached] |
86c91f91 | 16 | [--ignore-space-change | --ignore-whitespace ] |
0adda936 | 17 | [--whitespace=(nowarn|warn|fix|error|error-all)] |
62b4698e | 18 | [--exclude=<path>] [--include=<path>] [--directory=<root>] |
c536c075 | 19 | [--verbose] [--unsafe-paths] [<patch>...] |
d0587fd5 JH |
20 | |
21 | DESCRIPTION | |
22 | ----------- | |
38a39647 BG |
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 | |
964498e7 | 25 | with the `--cached` option the patch is only applied to the index. |
38a39647 | 26 | Without these options, the command applies the patch only to files, |
2de9b711 | 27 | and does not require them to be in a Git repository. |
d0587fd5 | 28 | |
08b29826 BK |
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 | ||
d0587fd5 JH |
33 | OPTIONS |
34 | ------- | |
12dd6e8c | 35 | <patch>...:: |
1d035f85 | 36 | The files to read the patch from. '-' can be used to read |
12dd6e8c | 37 | from the standard input. |
d0587fd5 | 38 | |
d0587fd5 JH |
39 | --stat:: |
40 | Instead of applying the patch, output diffstat for the | |
12dd6e8c | 41 | input. Turns off "apply". |
d0587fd5 | 42 | |
7d8b7c21 | 43 | --numstat:: |
f9821e2b | 44 | Similar to `--stat`, but shows the number of added and |
1d035f85 | 45 | deleted lines in decimal notation and the pathname without |
2f89543e JH |
46 | abbreviation, to make it more machine friendly. For |
47 | binary files, outputs two `-` instead of saying | |
48 | `0 0`. Turns off "apply". | |
7d8b7c21 | 49 | |
d0587fd5 JH |
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. | |
12dd6e8c | 54 | Turns off "apply". |
d0587fd5 JH |
55 | |
56 | --check:: | |
57 | Instead of applying the patch, see if the patch is | |
c34ec655 | 58 | applicable to the current working tree and/or the index |
12dd6e8c | 59 | file and detects errors. Turns off "apply". |
d0587fd5 JH |
60 | |
61 | --index:: | |
f9821e2b | 62 | When `--check` is in effect, or when applying the patch |
d0587fd5 JH |
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 | |
c34ec655 | 66 | the file to be patched in the working tree is not |
d0587fd5 JH |
67 | up-to-date, it is flagged as an error. This flag also |
68 | causes the index file to be updated. | |
69 | ||
5684ed6d | 70 | --cached:: |
1d035f85 DM |
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 | |
f9821e2b | 73 | without using the working tree. This implies `--index`. |
5684ed6d | 74 | |
78fb67f3 JH |
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 | ||
f26c4940 | 84 | --build-fake-ancestor=<file>:: |
0b444cdb | 85 | Newer 'git diff' output has embedded 'index information' |
d88156e9 JH |
86 | for each blob to help identify the original version that |
87 | the patch applies to. When this flag is given, and if | |
1d035f85 | 88 | the original versions of the blobs are available locally, |
7a988699 JS |
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. | |
d88156e9 | 93 | |
3240240f SB |
94 | -R:: |
95 | --reverse:: | |
5684ed6d JF |
96 | Apply the patch in reverse. |
97 | ||
98 | --reject:: | |
0b444cdb | 99 | For atomicity, 'git apply' by default fails the whole patch and |
5684ed6d JF |
100 | does not touch the working tree when some of the hunks |
101 | do not apply. This option makes it apply | |
b32d37a3 | 102 | the parts of the patch that are applicable, and leave the |
8938045a | 103 | rejected hunks in corresponding *.rej files. |
5684ed6d | 104 | |
d88156e9 | 105 | -z:: |
64485b4a BG |
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. | |
d88156e9 | 113 | |
e36f8b60 DB |
114 | -p<n>:: |
115 | Remove <n> leading slashes from traditional diff paths. The | |
116 | default is 1. | |
117 | ||
47495887 EB |
118 | -C<n>:: |
119 | Ensure at least <n> lines of surrounding context match before | |
120 | and after each change. When fewer lines of surrounding | |
74237d62 | 121 | context exist they all must match. By default no context is |
47495887 EB |
122 | ever ignored. |
123 | ||
f58bb6fb | 124 | --unidiff-zero:: |
0b444cdb | 125 | By default, 'git apply' expects that the patch being |
f58bb6fb JF |
126 | applied is a unified diff with at least one line of context. |
127 | This provides good safety measures, but breaks down when | |
f9821e2b BG |
128 | applying a diff generated with `--unified=0`. To bypass these |
129 | checks use `--unidiff-zero`. | |
f58bb6fb | 130 | + |
1d035f85 | 131 | Note, for the reasons stated above usage of context-free patches is |
f58bb6fb JF |
132 | discouraged. |
133 | ||
12dd6e8c | 134 | --apply:: |
5684ed6d | 135 | If you use any of the options marked "Turns off |
0b444cdb | 136 | 'apply'" above, 'git apply' reads and outputs the |
1d035f85 | 137 | requested information without actually applying the |
12dd6e8c JH |
138 | patch. Give this flag after those flags to also apply |
139 | the patch. | |
140 | ||
e433705d JH |
141 | --no-add:: |
142 | When applying a patch, ignore additions made by the | |
71a9883d | 143 | patch. This can be used to extract the common part between |
2fd02c92 | 144 | two files by first running 'diff' on them and applying |
e433705d | 145 | the result with this option, which would apply the |
1d035f85 | 146 | deletion part but not the addition part. |
d0587fd5 | 147 | |
3240240f SB |
148 | --allow-binary-replacement:: |
149 | --binary:: | |
2b6eef94 JH |
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. | |
27dedf0c | 154 | |
5684ed6d JF |
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 | ||
6ecb1ee2 JH |
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 | + | |
f9821e2b | 165 | When `--exclude` and `--include` patterns are used, they are examined in the |
6ecb1ee2 JH |
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 | ||
86c91f91 GB |
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 | ||
91af7ae5 JH |
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. | |
eb006ccf | 189 | When `git-apply` is used for statistics and not applying a |
91af7ae5 JH |
190 | patch, it defaults to `nowarn`. |
191 | + | |
1d035f85 | 192 | You can use different `<action>` values to control this |
91af7ae5 | 193 | behavior: |
8273c79a JH |
194 | + |
195 | * `nowarn` turns off the trailing whitespace warning. | |
196 | * `warn` outputs warnings for a few such errors, but applies the | |
91af7ae5 JH |
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 | |
1d035f85 | 200 | used to consider only trailing whitespace characters as errors, and the |
2de9b711 | 201 | fix involved 'stripping' them, but modern Gits do more). |
8273c79a JH |
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. | |
8273c79a | 205 | |
f847c07b | 206 | --inaccurate-eof:: |
0979c106 | 207 | Under certain circumstances, some versions of 'diff' do not correctly |
5684ed6d | 208 | detect a missing new-line at the end of the file. As a result, patches |
0979c106 | 209 | created by such 'diff' programs do not record incomplete lines |
5684ed6d JF |
210 | correctly. This option adds support for applying such patches by |
211 | working around this bug. | |
212 | ||
3240240f SB |
213 | -v:: |
214 | --verbose:: | |
5684ed6d JF |
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. | |
8273c79a | 218 | |
c14b9d1e JS |
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 | ||
f5563887 | 224 | --directory=<root>:: |
1d035f85 | 225 | Prepend <root> to all filenames. If a "-p" argument was also passed, |
c4730f35 | 226 | it is applied before prepending the new root. |
f5563887 JH |
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`. | |
c4730f35 | 231 | |
c536c075 JH |
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 | ||
8273c79a JH |
242 | Configuration |
243 | ------------- | |
244 | ||
da0005b8 | 245 | apply.ignoreWhitespace:: |
86c91f91 GB |
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. | |
8273c79a JH |
249 | apply.whitespace:: |
250 | When no `--whitespace` flag is given from the command | |
251 | line, this configuration item is used as the default. | |
252 | ||
e06c5a6c SV |
253 | Submodules |
254 | ---------- | |
0b444cdb | 255 | If the patch contains any changes to submodules then 'git apply' |
e06c5a6c SV |
256 | treats these changes as follows. |
257 | ||
f9821e2b | 258 | If `--index` is specified (explicitly or implicitly), then the submodule |
e06c5a6c SV |
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 | ||
f9821e2b | 264 | If `--index` is not specified, then the submodule commits in the patch |
1d035f85 | 265 | are ignored and only the absence or presence of the corresponding |
e06c5a6c | 266 | subdirectory is checked and (if possible) updated. |
8273c79a | 267 | |
08b29826 BK |
268 | SEE ALSO |
269 | -------- | |
270 | linkgit:git-am[1]. | |
271 | ||
d0587fd5 JH |
272 | GIT |
273 | --- | |
9e1f0a85 | 274 | Part of the linkgit:git[1] suite |