6 git-apply - Apply a patch on a git index file and a working tree
12 'git-apply' [--stat] [--numstat] [--summary] [--check] [--index]
13 [--apply] [--no-add] [--build-fake-ancestor <file>] [-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>...]
21 Reads supplied diff output and applies it on a git index file
27 The files to read patch from. '-' can be used to read
28 from the standard input.
31 Instead of applying the patch, output diffstat for the
32 input. Turns off "apply".
35 Similar to \--stat, but shows number of added and
36 deleted lines in decimal notation and pathname without
37 abbreviation, to make it more machine friendly. For
38 binary files, outputs two `-` instead of saying
39 `0 0`. Turns off "apply".
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.
48 Instead of applying the patch, see if the patch is
49 applicable to the current work tree and/or the index
50 file and detects errors. Turns off "apply".
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.
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'.
66 --build-fake-ancestor <file>::
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 versions of the blobs is available locally,
71 builds a temporary index containing those blobs.
73 When a pure mode change is encountered (which has no index information),
74 the information is read from the current index instead.
77 Apply the patch in reverse.
80 For atomicity, gitlink:git-apply[1] by default fails the whole patch and
81 does not touch the working tree when some of the hunks
82 do not apply. This option makes it apply
83 the parts of the patch that are applicable, and leave the
84 rejected hunks in corresponding *.rej files.
87 When showing the index information, do not munge paths,
88 but use NUL terminated machine readable format. Without
89 this flag, the pathnames output will have TAB, LF, and
90 backslash characters replaced with `\t`, `\n`, and `\\`,
94 Remove <n> leading slashes from traditional diff paths. The
98 Ensure at least <n> lines of surrounding context match before
99 and after each change. When fewer lines of surrounding
100 context exist they all must match. By default no context is
104 By default, gitlink:git-apply[1] expects that the patch being
105 applied is a unified diff with at least one line of context.
106 This provides good safety measures, but breaks down when
107 applying a diff generated with --unified=0. To bypass these
108 checks use '--unidiff-zero'.
110 Note, for the reasons stated above usage of context-free patches are
114 If you use any of the options marked "Turns off
115 'apply'" above, gitlink:git-apply[1] reads and outputs the
116 information you asked without actually applying the
117 patch. Give this flag after those flags to also apply
121 When applying a patch, ignore additions made by the
122 patch. This can be used to extract common part between
123 two files by first running `diff` on them and applying
124 the result with this option, which would apply the
125 deletion part but not addition part.
127 --allow-binary-replacement, --binary::
128 Historically we did not allow binary patch applied
129 without an explicit permission from the user, and this
130 flag was the way to do so. Currently we always allow binary
131 patch application, so this is a no-op.
133 --exclude=<path-pattern>::
134 Don't apply changes to files matching the given path pattern. This can
135 be useful when importing patchsets, where you want to exclude certain
136 files or directories.
138 --whitespace=<option>::
139 When applying a patch, detect a new or modified line
140 that ends with trailing whitespaces (this includes a
141 line that solely consists of whitespaces). By default,
142 the command outputs warning messages and applies the
144 When gitlink:git-apply[1] is used for statistics and not applying a
145 patch, it defaults to `nowarn`.
146 You can use different `<option>` to control this
149 * `nowarn` turns off the trailing whitespace warning.
150 * `warn` outputs warnings for a few such errors, but applies the
152 * `error` outputs warnings for a few such errors, and refuses
154 * `error-all` is similar to `error` but shows all errors.
155 * `strip` outputs warnings for a few such errors, strips out the
156 trailing whitespaces and applies the patch.
159 Under certain circumstances, some versions of diff do not correctly
160 detect a missing new-line at the end of the file. As a result, patches
161 created by such diff programs do not record incomplete lines
162 correctly. This option adds support for applying such patches by
163 working around this bug.
166 Report progress to stderr. By default, only a message about the
167 current patch being applied will be printed. This option will cause
168 additional information to be reported.
174 When no `--whitespace` flag is given from the command
175 line, this configuration item is used as the default.
179 If the patch contains any changes to submodules then gitlink:git-apply[1]
180 treats these changes as follows.
182 If --index is specified (explicitly or implicitly), then the submodule
183 commits must match the index exactly for the patch to apply. If any
184 of the submodules are checked-out, then these check-outs are completely
185 ignored, i.e., they are not required to be up-to-date or clean and they
188 If --index is not specified, then the submodule commits in the patch
189 are ignored and only the absence of presence of the corresponding
190 subdirectory is checked and (if possible) updated.
194 Written by Linus Torvalds <torvalds@osdl.org>
198 Documentation by Junio C Hamano
202 Part of the gitlink:git[7] suite