1git-am(1) 2========= 3 4NAME 5---- 6git-am - Apply a series of patches from a mailbox 7 8 9SYNOPSIS 10-------- 11[verse] 12'git am' [--signoff] [--keep] [--keep-cr | --no-keep-cr] [--utf8 | --no-utf8] 13 [--3way] [--interactive] [--committer-date-is-author-date] 14 [--ignore-date] [--ignore-space-change | --ignore-whitespace] 15 [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>] 16 [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet] 17 [--scissors | --no-scissors] 18 [(<mbox> | <Maildir>)...] 19'git am' (--continue | --skip | --abort) 20 21DESCRIPTION 22----------- 23Splits mail messages in a mailbox into commit log message, 24authorship information and patches, and applies them to the 25current branch. 26 27OPTIONS 28------- 29(<mbox>|<Maildir>)...:: 30 The list of mailbox files to read patches from. If you do not 31 supply this argument, the command reads from the standard input. 32 If you supply directories, they will be treated as Maildirs. 33 34-s:: 35--signoff:: 36 Add a `Signed-off-by:` line to the commit message, using 37 the committer identity of yourself. 38 39-k:: 40--keep:: 41 Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). 42 43--keep-non-patch:: 44 Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). 45 46--keep-cr:: 47--no-keep-cr:: 48 With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1]) 49 with the same option, to prevent it from stripping CR at the end of 50 lines. `am.keepcr` configuration variable can be used to specify the 51 default behaviour. `--no-keep-cr` is useful to override `am.keepcr`. 52 53-c:: 54--scissors:: 55 Remove everything in body before a scissors line (see 56 linkgit:git-mailinfo[1]). 57 58--no-scissors:: 59 Ignore scissors lines (see linkgit:git-mailinfo[1]). 60 61-q:: 62--quiet:: 63 Be quiet. Only print error messages. 64 65-u:: 66--utf8:: 67 Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). 68 The proposed commit log message taken from the e-mail 69 is re-coded into UTF-8 encoding (configuration variable 70 `i18n.commitencoding` can be used to specify project's 71 preferred encoding if it is not UTF-8). 72+ 73This was optional in prior versions of git, but now it is the 74default. You can use `--no-utf8` to override this. 75 76--no-utf8:: 77 Pass `-n` flag to 'git mailinfo' (see 78 linkgit:git-mailinfo[1]). 79 80-3:: 81--3way:: 82 When the patch does not apply cleanly, fall back on 83 3-way merge if the patch records the identity of blobs 84 it is supposed to apply to and we have those blobs 85 available locally. 86 87--ignore-date:: 88--ignore-space-change:: 89--ignore-whitespace:: 90--whitespace=<option>:: 91-C<n>:: 92-p<n>:: 93--directory=<dir>:: 94--exclude=<path>:: 95--include=<path>:: 96--reject:: 97 These flags are passed to the 'git apply' (see linkgit:git-apply[1]) 98 program that applies 99 the patch. 100 101-i:: 102--interactive:: 103 Run interactively. 104 105--committer-date-is-author-date:: 106 By default the command records the date from the e-mail 107 message as the commit author date, and uses the time of 108 commit creation as the committer date. This allows the 109 user to lie about the committer date by using the same 110 value as the author date. 111 112--ignore-date:: 113 By default the command records the date from the e-mail 114 message as the commit author date, and uses the time of 115 commit creation as the committer date. This allows the 116 user to lie about the author date by using the same 117 value as the committer date. 118 119--skip:: 120 Skip the current patch. This is only meaningful when 121 restarting an aborted patch. 122 123--continue:: 124-r:: 125--resolved:: 126 After a patch failure (e.g. attempting to apply 127 conflicting patch), the user has applied it by hand and 128 the index file stores the result of the application. 129 Make a commit using the authorship and commit log 130 extracted from the e-mail message and the current index 131 file, and continue. 132 133--resolvemsg=<msg>:: 134 When a patch failure occurs, <msg> will be printed 135 to the screen before exiting. This overrides the 136 standard message informing you to use `--resolved` 137 or `--skip` to handle the failure. This is solely 138 for internal use between 'git rebase' and 'git am'. 139 140--abort:: 141 Restore the original branch and abort the patching operation. 142 143DISCUSSION 144---------- 145 146The commit author name is taken from the "From: " line of the 147message, and commit author date is taken from the "Date: " line 148of the message. The "Subject: " line is used as the title of 149the commit, after stripping common prefix "[PATCH <anything>]". 150The "Subject: " line is supposed to concisely describe what the 151commit is about in one line of text. 152 153"From: " and "Subject: " lines starting the body override the respective 154commit author name and title values taken from the headers. 155 156The commit message is formed by the title taken from the 157"Subject: ", a blank line and the body of the message up to 158where the patch begins. Excess whitespace at the end of each 159line is automatically stripped. 160 161The patch is expected to be inline, directly following the 162message. Any line that is of the form: 163 164* three-dashes and end-of-line, or 165* a line that begins with "diff -", or 166* a line that begins with "Index: " 167 168is taken as the beginning of a patch, and the commit log message 169is terminated before the first occurrence of such a line. 170 171When initially invoking `git am`, you give it the names of the mailboxes 172to process. Upon seeing the first patch that does not apply, it 173aborts in the middle. You can recover from this in one of two ways: 174 175. skip the current patch by re-running the command with the '--skip' 176 option. 177 178. hand resolve the conflict in the working directory, and update 179 the index file to bring it into a state that the patch should 180 have produced. Then run the command with the '--resolved' option. 181 182The command refuses to process new mailboxes until the current 183operation is finished, so if you decide to start over from scratch, 184run `git am --abort` before running the command with mailbox 185names. 186 187Before any patches are applied, ORIG_HEAD is set to the tip of the 188current branch. This is useful if you have problems with multiple 189commits, like running 'git am' on the wrong branch or an error in the 190commits that is more easily fixed by changing the mailbox (e.g. 191errors in the "From:" lines). 192 193 194SEE ALSO 195-------- 196linkgit:git-apply[1]. 197 198GIT 199--- 200Part of the linkgit:git[1] suite