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