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