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]). Can be activated by default using 56 the `mailinfo.scissors` configuration variable. 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--patch-format:: 102 By default the command will try to detect the patch format 103 automatically. This option allows the user to bypass the automatic 104 detection and specify the patch format that the patch(es) should be 105 interpreted as. Valid formats are mbox, stgit, stgit-series and hg. 106 107-i:: 108--interactive:: 109 Run interactively. 110 111--committer-date-is-author-date:: 112 By default the command records the date from the e-mail 113 message as the commit author date, and uses the time of 114 commit creation as the committer date. This allows the 115 user to lie about the committer date by using the same 116 value as the author date. 117 118--ignore-date:: 119 By default the command records the date from the e-mail 120 message as the commit author date, and uses the time of 121 commit creation as the committer date. This allows the 122 user to lie about the author date by using the same 123 value as the committer date. 124 125--skip:: 126 Skip the current patch. This is only meaningful when 127 restarting an aborted patch. 128 129-S[<keyid>]:: 130--gpg-sign[=<keyid>]:: 131 GPG-sign commits. 132 133--continue:: 134-r:: 135--resolved:: 136 After a patch failure (e.g. attempting to apply 137 conflicting patch), the user has applied it by hand and 138 the index file stores the result of the application. 139 Make a commit using the authorship and commit log 140 extracted from the e-mail message and the current index 141 file, and continue. 142 143--resolvemsg=<msg>:: 144 When a patch failure occurs, <msg> will be printed 145 to the screen before exiting. This overrides the 146 standard message informing you to use `--continue` 147 or `--skip` to handle the failure. This is solely 148 for internal use between 'git rebase' and 'git am'. 149 150--abort:: 151 Restore the original branch and abort the patching operation. 152 153DISCUSSION 154---------- 155 156The commit author name is taken from the "From: " line of the 157message, and commit author date is taken from the "Date: " line 158of the message. The "Subject: " line is used as the title of 159the commit, after stripping common prefix "[PATCH <anything>]". 160The "Subject: " line is supposed to concisely describe what the 161commit is about in one line of text. 162 163"From: " and "Subject: " lines starting the body override the respective 164commit author name and title values taken from the headers. 165 166The commit message is formed by the title taken from the 167"Subject: ", a blank line and the body of the message up to 168where the patch begins. Excess whitespace at the end of each 169line is automatically stripped. 170 171The patch is expected to be inline, directly following the 172message. Any line that is of the form: 173 174* three-dashes and end-of-line, or 175* a line that begins with "diff -", or 176* a line that begins with "Index: " 177 178is taken as the beginning of a patch, and the commit log message 179is terminated before the first occurrence of such a line. 180 181When initially invoking `git am`, you give it the names of the mailboxes 182to process. Upon seeing the first patch that does not apply, it 183aborts in the middle. You can recover from this in one of two ways: 184 185. skip the current patch by re-running the command with the '--skip' 186 option. 187 188. hand resolve the conflict in the working directory, and update 189 the index file to bring it into a state that the patch should 190 have produced. Then run the command with the '--continue' option. 191 192The command refuses to process new mailboxes until the current 193operation is finished, so if you decide to start over from scratch, 194run `git am --abort` before running the command with mailbox 195names. 196 197Before any patches are applied, ORIG_HEAD is set to the tip of the 198current branch. This is useful if you have problems with multiple 199commits, like running 'git am' on the wrong branch or an error in the 200commits that is more easily fixed by changing the mailbox (e.g. 201errors in the "From:" lines). 202 203HOOKS 204----- 205This command can run `applypatch-msg`, `pre-applypatch`, 206and `post-applypatch` hooks. See linkgit:githooks[5] for more 207information. 208 209SEE ALSO 210-------- 211linkgit:git-apply[1]. 212 213GIT 214--- 215Part of the linkgit:git[1] suite