]>
Commit | Line | Data |
---|---|---|
d0587fd5 JH |
1 | git-apply(1) |
2 | ============ | |
d0587fd5 JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-apply - Apply a patch on a git index file and a working tree |
d0587fd5 JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
353ce815 | 11 | [verse] |
0b9a9dd0 AR |
12 | 'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] |
13 | [--apply] [--no-add] [--index-info] [-R | --reverse] | |
14 | [--allow-binary-replacement | --binary] [--reject] [-z] | |
15 | [-pNUM] [-CNUM] [--inaccurate-eof] [--cached] | |
16 | [--whitespace=<nowarn|warn|error|error-all|strip>] | |
17 | [--exclude=PATH] [--verbose] [<patch>...] | |
d0587fd5 JH |
18 | |
19 | DESCRIPTION | |
20 | ----------- | |
f73ae1fc | 21 | Reads supplied diff output and applies it on a git index file |
d0587fd5 JH |
22 | and a work tree. |
23 | ||
24 | OPTIONS | |
25 | ------- | |
12dd6e8c JH |
26 | <patch>...:: |
27 | The files to read patch from. '-' can be used to read | |
28 | from the standard input. | |
d0587fd5 | 29 | |
d0587fd5 JH |
30 | --stat:: |
31 | Instead of applying the patch, output diffstat for the | |
12dd6e8c | 32 | input. Turns off "apply". |
d0587fd5 | 33 | |
7d8b7c21 JH |
34 | --numstat:: |
35 | Similar to \--stat, but shows number of added and | |
36 | deleted lines in decimal notation and pathname without | |
2f89543e JH |
37 | abbreviation, to make it more machine friendly. For |
38 | binary files, outputs two `-` instead of saying | |
39 | `0 0`. Turns off "apply". | |
7d8b7c21 | 40 | |
d0587fd5 JH |
41 | --summary:: |
42 | Instead of applying the patch, output a condensed | |
43 | summary of information obtained from git diff extended | |
44 | headers, such as creations, renames and mode changes. | |
12dd6e8c | 45 | Turns off "apply". |
d0587fd5 JH |
46 | |
47 | --check:: | |
48 | Instead of applying the patch, see if the patch is | |
49 | applicable to the current work tree and/or the index | |
12dd6e8c | 50 | file and detects errors. Turns off "apply". |
d0587fd5 JH |
51 | |
52 | --index:: | |
53 | When --check is in effect, or when applying the patch | |
54 | (which is the default when none of the options that | |
55 | disables it is in effect), make sure the patch is | |
56 | applicable to what the current index file records. If | |
57 | the file to be patched in the work tree is not | |
58 | up-to-date, it is flagged as an error. This flag also | |
59 | causes the index file to be updated. | |
60 | ||
5684ed6d JF |
61 | --cached:: |
62 | Apply a patch without touching the working tree. Instead, take the | |
63 | cached data, apply the patch, and store the result in the index, | |
64 | without using the working tree. This implies '--index'. | |
65 | ||
d88156e9 JH |
66 | --index-info:: |
67 | Newer git-diff output has embedded 'index information' | |
68 | for each blob to help identify the original version that | |
69 | the patch applies to. When this flag is given, and if | |
70 | the original version of the blob is available locally, | |
71 | outputs information about them to the standard output. | |
72 | ||
5684ed6d JF |
73 | -R, --reverse:: |
74 | Apply the patch in reverse. | |
75 | ||
76 | --reject:: | |
77 | For atomicity, gitlink:git-apply[1] by default fails the whole patch and | |
78 | does not touch the working tree when some of the hunks | |
79 | do not apply. This option makes it apply | |
b32d37a3 | 80 | the parts of the patch that are applicable, and leave the |
8938045a | 81 | rejected hunks in corresponding *.rej files. |
5684ed6d | 82 | |
d88156e9 JH |
83 | -z:: |
84 | When showing the index information, do not munge paths, | |
85 | but use NUL terminated machine readable format. Without | |
86 | this flag, the pathnames output will have TAB, LF, and | |
87 | backslash characters replaced with `\t`, `\n`, and `\\`, | |
88 | respectively. | |
89 | ||
e36f8b60 DB |
90 | -p<n>:: |
91 | Remove <n> leading slashes from traditional diff paths. The | |
92 | default is 1. | |
93 | ||
47495887 EB |
94 | -C<n>:: |
95 | Ensure at least <n> lines of surrounding context match before | |
96 | and after each change. When fewer lines of surrounding | |
74237d62 | 97 | context exist they all must match. By default no context is |
47495887 EB |
98 | ever ignored. |
99 | ||
f58bb6fb JF |
100 | --unidiff-zero:: |
101 | By default, gitlink:git-apply[1] expects that the patch being | |
102 | applied is a unified diff with at least one line of context. | |
103 | This provides good safety measures, but breaks down when | |
104 | applying a diff generated with --unified=0. To bypass these | |
105 | checks use '--unidiff-zero'. | |
106 | + | |
107 | Note, for the reasons stated above usage of context-free patches are | |
108 | discouraged. | |
109 | ||
12dd6e8c | 110 | --apply:: |
5684ed6d JF |
111 | If you use any of the options marked "Turns off |
112 | 'apply'" above, gitlink:git-apply[1] reads and outputs the | |
12dd6e8c JH |
113 | information you asked without actually applying the |
114 | patch. Give this flag after those flags to also apply | |
115 | the patch. | |
116 | ||
e433705d JH |
117 | --no-add:: |
118 | When applying a patch, ignore additions made by the | |
119 | patch. This can be used to extract common part between | |
120 | two files by first running `diff` on them and applying | |
121 | the result with this option, which would apply the | |
122 | deletion part but not addition part. | |
d0587fd5 | 123 | |
5684ed6d | 124 | --allow-binary-replacement, --binary:: |
2b6eef94 JH |
125 | Historically we did not allow binary patch applied |
126 | without an explicit permission from the user, and this | |
127 | flag was the way to do so. Currently we always allow binary | |
128 | patch application, so this is a no-op. | |
27dedf0c | 129 | |
5684ed6d JF |
130 | --exclude=<path-pattern>:: |
131 | Don't apply changes to files matching the given path pattern. This can | |
132 | be useful when importing patchsets, where you want to exclude certain | |
133 | files or directories. | |
134 | ||
8273c79a JH |
135 | --whitespace=<option>:: |
136 | When applying a patch, detect a new or modified line | |
137 | that ends with trailing whitespaces (this includes a | |
138 | line that solely consists of whitespaces). By default, | |
139 | the command outputs warning messages and applies the | |
140 | patch. | |
5684ed6d | 141 | When gitlink:git-apply[1] is used for statistics and not applying a |
8273c79a JH |
142 | patch, it defaults to `nowarn`. |
143 | You can use different `<option>` to control this | |
abda1ef5 | 144 | behavior: |
8273c79a JH |
145 | + |
146 | * `nowarn` turns off the trailing whitespace warning. | |
147 | * `warn` outputs warnings for a few such errors, but applies the | |
148 | patch (default). | |
149 | * `error` outputs warnings for a few such errors, and refuses | |
150 | to apply the patch. | |
151 | * `error-all` is similar to `error` but shows all errors. | |
152 | * `strip` outputs warnings for a few such errors, strips out the | |
153 | trailing whitespaces and applies the patch. | |
154 | ||
f847c07b | 155 | --inaccurate-eof:: |
5684ed6d JF |
156 | Under certain circumstances, some versions of diff do not correctly |
157 | detect a missing new-line at the end of the file. As a result, patches | |
158 | created by such diff programs do not record incomplete lines | |
159 | correctly. This option adds support for applying such patches by | |
160 | working around this bug. | |
161 | ||
0b9a9dd0 | 162 | -v, --verbose:: |
5684ed6d JF |
163 | Report progress to stderr. By default, only a message about the |
164 | current patch being applied will be printed. This option will cause | |
165 | additional information to be reported. | |
8273c79a JH |
166 | |
167 | Configuration | |
168 | ------------- | |
169 | ||
170 | apply.whitespace:: | |
171 | When no `--whitespace` flag is given from the command | |
172 | line, this configuration item is used as the default. | |
173 | ||
e06c5a6c SV |
174 | Submodules |
175 | ---------- | |
176 | If the patch contains any changes to submodules then gitlink:git-apply[1] | |
177 | treats these changes as follows. | |
178 | ||
179 | If --index is specified (explicitly or implicitly), then the submodule | |
180 | commits must match the index exactly for the patch to apply. If any | |
181 | of the submodules are checked-out, then these check-outs are completely | |
182 | ignored, i.e., they are not required to be up-to-date or clean and they | |
183 | are not updated. | |
184 | ||
185 | If --index is not specified, then the submodule commits in the patch | |
186 | are ignored and only the absence of presence of the corresponding | |
187 | subdirectory is checked and (if possible) updated. | |
8273c79a | 188 | |
d0587fd5 JH |
189 | Author |
190 | ------ | |
191 | Written by Linus Torvalds <torvalds@osdl.org> | |
192 | ||
193 | Documentation | |
194 | -------------- | |
195 | Documentation by Junio C Hamano | |
196 | ||
197 | GIT | |
198 | --- | |
a7154e91 | 199 | Part of the gitlink:git[7] suite |