Merge branch 'js/merge'

[git.git] / Documentation / git-am.txt

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index f0405a35e9aa34fe67b2ddf92052f35a2d706610..e4a6b3a6f0fc258e8a2052d1d56a71fb57667d39 100644 (file)
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -9,9 +9,10 @@ git-am - Apply a series of patches from a mailbox
 SYNOPSIS
 --------
 [verse]
-'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
-         [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
-        <mbox>...
+'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
+         [--3way] [--interactive] [--binary]
+         [--whitespace=<option>] [-C<n>] [-p<n>]
+         <mbox>|<Maildir>...
 'git-am' [--skip | --resolved]
 
 DESCRIPTION
@@ -22,9 +23,10 @@ current branch.
 
 OPTIONS
 -------
-<mbox>...::
+<mbox>|<Maildir>...::
        The list of mailbox files to read patches from. If you do not
-       supply this argument, reads from the standard input.
+       supply this argument, reads from the standard input. If you supply
+       directories, they'll be treated as Maildirs.
 
 -s, --signoff::
        Add `Signed-off-by:` line to the commit message, using
@@ -40,7 +42,7 @@ OPTIONS
 -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
+       is 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).
 +
@@ -51,30 +53,32 @@ default.   You could use `--no-utf8` to override this.
        Pass `-n` flag to `git-mailinfo` (see
        gitlink:git-mailinfo[1]).
 
--b, --binary::
-       Pass `--allow-binary-replacement` flag to `git-apply`
-       (see gitlink:git-apply[1]).
-
 -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
-       locally.
+       available locally.
 
---skip::
-       Skip the current patch.  This is only meaningful when
-       restarting an aborted patch.
+-b, --binary::
+       Pass `--allow-binary-replacement` flag to `git-apply`
+       (see gitlink:git-apply[1]).
 
 --whitespace=<option>::
-       This flag is passed to the `git-apply` program that applies
+       This flag is passed to the `git-apply` (see gitlink:git-apply[1])
+       program that applies
        the patch.
 
 -C<n>, -p<n>::
-       These flags are passed to the `git-apply` program that applies
+       These flags are passed to the `git-apply` (see gitlink:git-apply[1])
+       program that applies
        the patch.
 
 -i, --interactive::
-       Run interactively, just like git-applymbox.
+       Run interactively.
+
+--skip::
+       Skip the current patch.  This is only meaningful when
+       restarting an aborted patch.
 
 -r, --resolved::
        After a patch failure (e.g. attempting to apply
@@ -123,10 +127,9 @@ 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
-recover from this in one of two ways:
+aborts in the middle,.  You can recover from this in one of two ways:
 
-. skip the current one by re-running the command with '--skip'
+. skip the current patch by re-running the command with '--skip'
   option.
 
 . hand resolve the conflict in the working directory, and update
@@ -141,7 +144,7 @@ names.
 
 SEE ALSO
 --------
-gitlink:git-applymbox[1], gitlink:git-applypatch[1], gitlink:git-apply[1].
+gitlink:git-apply[1].
 
 
 Author
@@ -155,4 +158,3 @@ Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.o
 GIT
 ---
 Part of the gitlink:git[7] suite
-