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