X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-am.txt;h=f0405a35e9aa34fe67b2ddf92052f35a2d706610;hb=abbf594763a14e9c00c61f688e45bed636f1eb52;hp=53e81cb103c4fbd65c1c728fccd710a301eed5e4;hpb=d84029b6738197fa409861597934b29bbebad262;p=git.git
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 53e81cb10..f0405a35e 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -3,14 +3,15 @@ git-am(1)
NAME
----
-git-am - Apply a series of patches in a mailbox
+git-am - Apply a series of patches from a mailbox
SYNOPSIS
--------
[verse]
'git-am' [--signoff] [--dotest=
] [--utf8 | --no-utf8] [--binary] [--3way]
- [--interactive] [--whitespace=] ...
+ [--interactive] [--whitespace=] [-C] [-p]
+ ...
'git-am' [--skip | --resolved]
DESCRIPTION
@@ -21,18 +22,22 @@ current branch.
OPTIONS
-------
---signoff::
+...::
+ The list of mailbox files to read patches from. If you do not
+ supply this argument, reads from the standard input.
+
+-s, --signoff::
Add `Signed-off-by:` line to the commit message, using
the committer identity of yourself.
---dotest=::
+-d=, --dotest=::
Instead of `.dotest` directory, use as a working
area to store extracted patches.
---keep::
+-k, --keep::
Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
---utf8::
+-u, --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
@@ -43,14 +48,14 @@ 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
+ Pass `-n` flag to `git-mailinfo` (see
gitlink:git-mailinfo[1]).
---binary::
+-b, --binary::
Pass `--allow-binary-replacement` flag to `git-apply`
(see gitlink:git-apply[1]).
---3way::
+-3, --3way::
When the patch does not apply cleanly, fall back on
3-way merge, if the patch records the identity of blobs
it is supposed to apply to, and we have those blobs
@@ -64,10 +69,14 @@ default. You could use `--no-utf8` to override this.
This flag is passed to the `git-apply` program that applies
the patch.
---interactive::
+-C, -p::
+ These flags are passed to the `git-apply` program that applies
+ the patch.
+
+-i, --interactive::
Run interactively, just like git-applymbox.
---resolved::
+-r, --resolved::
After a patch failure (e.g. attempting to apply
conflicting patch), the user has applied it by hand and
the index file stores the result of the application.
@@ -75,9 +84,43 @@ default. You could use `--no-utf8` to override this.
extracted from the e-mail message and the current index
file, and continue.
+--resolvemsg=::
+ When a patch failure occurs, will be printed
+ to the screen before exiting. This overrides the
+ standard message informing you to use `--resolved`
+ or `--skip` to handle the failure. This is solely
+ for internal use between `git-rebase` and `git-am`.
+
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 ]".
+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