![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 910457d3b388f2c3b1dbe25f5609e3584fb4f113..148ce405681cd4f5bd38575b6a427a7e5745a109 100644 (file)
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
NAME
----
NAME
----
-git-am - Apply a series of patches in a mailbox
+git-am - Apply a series of patches from a mailbox
SYNOPSIS
--------
[verse]
SYNOPSIS
--------
[verse]
-'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way]
- [--interactive] [--whitespace=<option>] <mbox>...
+'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
+ [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
+ <mbox>...
'git-am' [--skip | --resolved]
DESCRIPTION
'git-am' [--skip | --resolved]
DESCRIPTION
OPTIONS
-------
OPTIONS
-------
+<mbox>...::
+ The list of mailbox files to read patches from. If you do not
+ supply this argument, reads from the standard input.
+
--signoff::
Add `Signed-off-by:` line to the commit message, using
the committer identity of yourself.
--signoff::
Add `Signed-off-by:` line to the commit message, using
the committer identity of yourself.
Instead of `.dotest` directory, use <dir> as a working
area to store extracted patches.
Instead of `.dotest` directory, use <dir> as a working
area to store extracted patches.
---utf8, --keep::
- Pass `-u` and `-k` flags to `git-mailinfo` (see
+--keep::
+ Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
+
+--utf8::
+ Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
+ The proposed commit log message taken from the e-mail
+ are re-coded into UTF-8 encoding (configuration variable
+ `i18n.commitencoding` can be used to specify project's
+ preferred encoding if it is not UTF-8).
++
+This was optional in prior versions of git, but now it is the
+default. You could use `--no-utf8` to override this.
+
+--no-utf8::
+ Do not pass `-u` flag to `git-mailinfo` (see
gitlink:git-mailinfo[1]).
--binary::
gitlink:git-mailinfo[1]).
--binary::
This flag is passed to the `git-apply` program that applies
the patch.
This flag is passed to the `git-apply` program that applies
the patch.
+-C<n>, -p<n>::
+ These flags are passed to the `git-apply` program that applies
+ the patch.
+
--interactive::
Run interactively, just like git-applymbox.
--interactive::
Run interactively, just like git-applymbox.
DISCUSSION
----------
DISCUSSION
----------
+The commit author name is taken from the "From: " line of the
+message, and commit author time is taken from the "Date: " line
+of the message. The "Subject: " line is used as the title of
+the commit, after stripping common prefix "[PATCH <anything>]".
+It is supposed to describe what the commit is about concisely as
+a one line text.
+
+The body of the message (iow, after a blank line that terminates
+RFC2822 headers) can begin with "Subject: " and "From: " lines
+that are different from those of the mail header, to override
+the values of these fields.
+
+The commit message is formed by the title taken from the
+"Subject: ", a blank line and the body of the message up to
+where the patch begins. Excess whitespaces at the end of the
+lines are automatically stripped.
+
+The patch is expected to be inline, directly following the
+message. Any line that is of form:
+
+* three-dashes and end-of-line, or
+* a line that begins with "diff -", or
+* a line that begins with "Index: "
+
+is taken as the beginning of a patch, and the commit log message
+is terminated before the first occurrence of such a line.
+
When initially invoking it, you give it names of the mailboxes
to crunch. Upon seeing the first patch that does not apply, it
aborts in the middle, just like 'git-applymbox' does. You can
When initially invoking it, you give it names of the mailboxes
to crunch. Upon seeing the first patch that does not apply, it
aborts in the middle, just like 'git-applymbox' does. You can