Document -i flag to git-read-tree
[git/jnareb-git/bp-gitweb.git] / Documentation / git-apply.txt
blob4f7e1195dee9993974d8f671d750498e66ede984
1 git-apply(1)
2 ============
3 v0.1, June 2005
5 NAME
6 ----
7 git-apply - Apply patch on a GIT index file and a work tree
10 SYNOPSIS
11 --------
12 'git-apply' [--no-merge] [--stat] [--summary] [--check] [--index] [--show-files] [--apply] [<patch>...]
14 DESCRIPTION
15 -----------
16 Reads supplied diff output and applies it on a GIT index file
17 and a work tree.
19 OPTIONS
20 -------
21 <patch>...::
22         The files to read patch from.  '-' can be used to read
23         from the standard input.
25 --no-merge::
26         The default mode of operation is the merge behaviour
27         which is not implemented yet.  This flag explicitly
28         tells the program not to use the merge behaviour.
30 --stat::
31         Instead of applying the patch, output diffstat for the
32         input.  Turns off "apply".
34 --summary::
35         Instead of applying the patch, output a condensed
36         summary of information obtained from git diff extended
37         headers, such as creations, renames and mode changes.
38         Turns off "apply".
40 --check::
41         Instead of applying the patch, see if the patch is
42         applicable to the current work tree and/or the index
43         file and detects errors.  Turns off "apply".
45 --index::
46         When --check is in effect, or when applying the patch
47         (which is the default when none of the options that
48         disables it is in effect), make sure the patch is
49         applicable to what the current index file records.  If
50         the file to be patched in the work tree is not
51         up-to-date, it is flagged as an error.  This flag also
52         causes the index file to be updated.
54 --show-files::
55         Show summary of files that are affected by the patch.
57 --apply::
58         If you use any of the options marked ``Turns off
59         "apply"'' above, git-apply reads and outputs the
60         information you asked without actually applying the
61         patch.  Give this flag after those flags to also apply
62         the patch.
65 Author
66 ------
67 Written by Linus Torvalds <torvalds@osdl.org>
69 Documentation
70 --------------
71 Documentation by Junio C Hamano
73 GIT
74 ---
75 Part of the gitlink:git[7] suite