X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-am.txt;h=4fb1d844133ba8350361ee67d074935805a24156;hb=27ebd6e0443bdd795869f598ecebc9eadd64a26c;hp=704dc514de1daa29a0c72ce336ad6d04ea34d701;hpb=1301c6eb412e7c5511b952a12e42c70ad56f028b;p=git.git
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 704dc514d..4fb1d8441 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -3,13 +3,16 @@ 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
--------
-'git-am' [--signoff] [--dotest=
] [--utf8] [--3way] ...
-'git-am' [--skip]
+[verse]
+'git-am' [--signoff] [--dotest=] [--utf8 | --no-utf8] [--binary] [--3way]
+ [--interactive] [--whitespace=] [-C] [-p]
+ ...
+'git-am' [--skip | --resolved]
DESCRIPTION
-----------
@@ -19,6 +22,10 @@ current branch.
OPTIONS
-------
+...::
+ 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.
@@ -27,10 +34,27 @@ OPTIONS
Instead of `.dotest` directory, use as a working
area to store extracted patches.
---utf8, --keep::
- Pass `--utf8` and `--keep` 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::
+ Pass `--allow-binary-replacement` flag to `git-apply`
+ (see gitlink:git-apply[1]).
+
--3way::
When the patch does not apply cleanly, fall back on
3-way merge, if the patch records the identity of blobs
@@ -41,9 +65,24 @@ OPTIONS
Skip the current patch. This is only meaningful when
restarting an aborted patch.
+--whitespace=::
+ This flag is passed to the `git-apply` program that applies
+ the patch.
+
+-C, -p::
+ These flag are passed to the `git-apply` program that applies
+ the patch.
+
--interactive::
Run interactively, just like git-applymbox.
+--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.
+ Make a commit using the authorship and commit log
+ extracted from the e-mail message and the current index
+ file, and continue.
DISCUSSION
----------
@@ -56,12 +95,9 @@ recover from this in one of two ways:
. skip the current one by re-running the command with '--skip'
option.
-. hand resolve the conflict in the working directory, run 'git
- diff HEAD' to extract the merge result into a patch form and
- replacing the patch in .dotest/patch file. After doing this,
- run `git-reset --hard HEAD` to bring the working tree to the
- state before half-applying the patch, then re-run the command
- without any options.
+. hand resolve the conflict in the working directory, and update
+ the index file to bring it in a state that the patch should
+ have produced. Then run the command with '--resolved' option.
The command refuses to process new mailboxes while `.dotest`
directory exists, so if you decide to start over from scratch,
@@ -71,7 +107,7 @@ names.
SEE ALSO
--------
-gitlink:git-applymbox[1], gitlink:git-applypatch[1].
+gitlink:git-applymbox[1], gitlink:git-applypatch[1], gitlink:git-apply[1].
Author
@@ -82,8 +118,6 @@ Documentation
--------------
Documentation by Petr Baudis, Junio C Hamano and the git-list .
-This manual page is a stub. You can help the git documentation by expanding it.
-
GIT
---
Part of the gitlink:git[7] suite