3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
7 .\" Source: Git 2.39.1.231.ga7caae2729
10 .TH "GIT\-APPLY" "1" "01/17/2023" "Git 2\&.39\&.1\&.231\&.ga7caae" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 git-apply \- Apply a patch to files and/or to the index
35 \fIgit apply\fR [\-\-stat] [\-\-numstat] [\-\-summary] [\-\-check] [\-\-index | \-\-intent\-to\-add] [\-\-3way]
36 [\-\-apply] [\-\-no\-add] [\-\-build\-fake\-ancestor=<file>] [\-R | \-\-reverse]
37 [\-\-allow\-binary\-replacement | \-\-binary] [\-\-reject] [\-z]
38 [\-p<n>] [\-C<n>] [\-\-inaccurate\-eof] [\-\-recount] [\-\-cached]
39 [\-\-ignore\-space\-change | \-\-ignore\-whitespace]
40 [\-\-whitespace=(nowarn|warn|fix|error|error\-all)]
41 [\-\-exclude=<path>] [\-\-include=<path>] [\-\-directory=<root>]
42 [\-\-verbose | \-\-quiet] [\-\-unsafe\-paths] [\-\-allow\-empty] [<patch>\&...]
47 Reads the supplied diff output (i\&.e\&. "a patch") and applies it to files\&. When running from a subdirectory in a repository, patched paths outside the directory are ignored\&. With the \fB\-\-index\fR option the patch is also applied to the index, and with the \fB\-\-cached\fR option the patch is only applied to the index\&. Without these options, the command applies the patch only to files, and does not require them to be in a Git repository\&.
49 This command applies the patch but does not create a commit\&. Use \fBgit-am\fR(1) to create commits from patches generated by \fBgit-format-patch\fR(1) and/or received by email\&.
54 The files to read the patch from\&.
56 can be used to read from the standard input\&.
61 Instead of applying the patch, output diffstat for the input\&. Turns off "apply"\&.
67 \fB\-\-stat\fR, but shows the number of added and deleted lines in decimal notation and the pathname without abbreviation, to make it more machine friendly\&. For binary files, outputs two
70 \fB0 0\fR\&. Turns off "apply"\&.
75 Instead of applying the patch, output a condensed summary of information obtained from git diff extended headers, such as creations, renames and mode changes\&. Turns off "apply"\&.
80 Instead of applying the patch, see if the patch is applicable to the current working tree and/or the index file and detects errors\&. Turns off "apply"\&.
85 Apply the patch to both the index and the working tree (or merely check that it would apply cleanly to both if
87 is in effect)\&. Note that
89 expects index entries and working tree copies for relevant paths to be identical (their contents and metadata such as file mode must match), and will raise an error if they are not, even if the patch would apply cleanly to both the index and the working tree in isolation\&.
94 Apply the patch to just the index, without touching the working tree\&. If
96 is in effect, merely check that it would apply cleanly to the index entry\&.
101 When applying the patch only to the working tree, mark new files to be added to the index later (see
102 \fB\-\-intent\-to\-add\fR
104 \fBgit-add\fR(1))\&. This option is ignored unless running in a Git repository and
106 is not specified\&. Note that
108 could be implied by other options such as
116 Attempt 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally, possibly leaving the conflict markers in the files in the working tree for the user to resolve\&. This option implies the
120 option is used, and is incompatible with the
122 option\&. When used with the
124 option, any conflicts are left at higher stages in the cache\&.
127 \-\-build\-fake\-ancestor=<file>
132 \fIindex information\fR
133 for each blob to help identify the original version that the patch applies to\&. When this flag is given, and if the original versions of the blobs are available locally, builds a temporary index containing those blobs\&.
135 When a pure mode change is encountered (which has no index information), the information is read from the current index instead\&.
140 Apply the patch in reverse\&.
147 by default fails the whole patch and does not touch the working tree when some of the hunks do not apply\&. This option makes it apply the parts of the patch that are applicable, and leave the rejected hunks in corresponding *\&.rej files\&.
154 has been given, do not munge pathnames, but use a NUL\-terminated machine\-readable format\&.
156 Without this option, pathnames with "unusual" characters are quoted as explained for the configuration variable
157 \fBcore\&.quotePath\fR
159 \fBgit-config\fR(1))\&.
164 Remove <n> leading path components (separated by slashes) from traditional diff paths\&. E\&.g\&., with
165 \fB\-p2\fR, a patch against
167 will be applied directly to
168 \fBfile\fR\&. The default is 1\&.
173 Ensure at least <n> lines of surrounding context match before and after each change\&. When fewer lines of surrounding context exist they all must match\&. By default no context is ever ignored\&.
180 expects that the patch being applied is a unified diff with at least one line of context\&. This provides good safety measures, but breaks down when applying a diff generated with
181 \fB\-\-unified=0\fR\&. To bypass these checks use
182 \fB\-\-unidiff\-zero\fR\&.
184 Note, for the reasons stated above usage of context\-free patches is discouraged\&.
189 If you use any of the options marked "Turns off
192 reads and outputs the requested information without actually applying the patch\&. Give this flag after those flags to also apply the patch\&.
197 When applying a patch, ignore additions made by the patch\&. This can be used to extract the common part between two files by first running
199 on them and applying the result with this option, which would apply the deletion part but not the addition part\&.
202 \-\-allow\-binary\-replacement, \-\-binary
204 Historically we did not allow binary patch applied without an explicit permission from the user, and this flag was the way to do so\&. Currently we always allow binary patch application, so this is a no\-op\&.
207 \-\-exclude=<path\-pattern>
209 Don\(cqt apply changes to files matching the given path pattern\&. This can be useful when importing patchsets, where you want to exclude certain files or directories\&.
212 \-\-include=<path\-pattern>
214 Apply changes to files matching the given path pattern\&. This can be useful when importing patchsets, where you want to include certain files or directories\&.
220 patterns are used, they are examined in the order they appear on the command line, and the first match determines if a patch to each path is used\&. A patch to a path that does not match any include/exclude pattern is used by default if there is no include pattern on the command line, and ignored if there is any include pattern\&.
223 \-\-ignore\-space\-change, \-\-ignore\-whitespace
225 When applying a patch, ignore changes in whitespace in context lines if necessary\&. Context lines will preserve their whitespace, and they will not undergo whitespace fixing regardless of the value of the
227 option\&. New lines will still be fixed, though\&.
230 \-\-whitespace=<action>
232 When applying a patch, detect a new or modified line that has whitespace errors\&. What are considered whitespace errors is controlled by
233 \fBcore\&.whitespace\fR
234 configuration\&. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the initial indent of the line are considered whitespace errors\&.
236 By default, the command outputs warning messages but applies the patch\&. When
238 is used for statistics and not applying a patch, it defaults to
241 You can use different
243 values to control this behavior:
254 turns off the trailing whitespace warning\&.
266 outputs warnings for a few such errors, but applies the patch as\-is (default)\&.
278 outputs warnings for a few such errors, and applies the patch after fixing them (\fBstrip\fR
279 is a synonym \-\-\- the tool used to consider only trailing whitespace characters as errors, and the fix involved
281 them, but modern Gits do more)\&.
293 outputs warnings for a few such errors, and refuses to apply the patch\&.
307 but shows all errors\&.
313 Under certain circumstances, some versions of
315 do not correctly detect a missing new\-line at the end of the file\&. As a result, patches created by such
317 programs do not record incomplete lines correctly\&. This option adds support for applying such patches by working around this bug\&.
322 Report progress to stderr\&. By default, only a message about the current patch being applied will be printed\&. This option will cause additional information to be reported\&.
327 Suppress stderr output\&. Messages about patch status and progress will not be printed\&.
332 Do not trust the line counts in the hunk headers, but infer them by inspecting the patch (e\&.g\&. after editing the patch without adjusting the hunk headers appropriately)\&.
337 Prepend <root> to all filenames\&. If a "\-p" argument was also passed, it is applied before prepending the new root\&.
339 For example, a patch that talks about updating
340 \fBa/git\-gui\&.sh\fR
342 \fBb/git\-gui\&.sh\fR
343 can be applied to the file in the working tree
344 \fBmodules/git\-gui/git\-gui\&.sh\fR
346 \fBgit apply \-\-directory=modules/git\-gui\fR\&.
351 By default, a patch that affects outside the working area (either a Git controlled working tree, or the current working directory when "git apply" is used as a replacement of GNU patch) is rejected as a mistake (or a mischief)\&.
355 is used as a "better GNU patch", the user can pass the
356 \fB\-\-unsafe\-paths\fR
357 option to override this safety check\&. This option has no effect when
366 Don\(cqt return error for patches containing no diff\&. This includes empty patches and patches with commit text only\&.
370 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
372 apply\&.ignoreWhitespace
377 to ignore changes in whitespace, in the same way as the
378 \fB\-\-ignore\-space\-change\fR
379 option\&. When set to one of: no, none, never, false tells
381 to respect all whitespace differences\&. See
382 \fBgit-apply\fR(1)\&.
389 how to handle whitespaces, in the same way as the
392 \fBgit-apply\fR(1)\&.
396 If the patch contains any changes to submodules then \fIgit apply\fR treats these changes as follows\&.
398 If \fB\-\-index\fR is specified (explicitly or implicitly), then the submodule commits must match the index exactly for the patch to apply\&. If any of the submodules are checked\-out, then these check\-outs are completely ignored, i\&.e\&., they are not required to be up to date or clean and they are not updated\&.
400 If \fB\-\-index\fR is not specified, then the submodule commits in the patch are ignored and only the absence or presence of the corresponding subdirectory is checked and (if possible) updated\&.
406 Part of the \fBgit\fR(1) suite