Code

Merge branch 'maint'
[git.git] / Documentation / git-am.txt
index ba79773f79fc8823f1c611e51b163866ada26306..46544a07694a90db908729b6badf92370f37226b 100644 (file)
@@ -9,10 +9,10 @@ git-am - Apply a series of patches from a mailbox
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]
-'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
+'git-am' [--signoff] [--keep] [--utf8 | --no-utf8]
          [--3way] [--interactive] [--binary]
          [--whitespace=<option>] [-C<n>] [-p<n>]
          [--3way] [--interactive] [--binary]
          [--whitespace=<option>] [-C<n>] [-p<n>]
-         <mbox>...
+         <mbox>|<Maildir>...
 'git-am' [--skip | --resolved]
 
 DESCRIPTION
 'git-am' [--skip | --resolved]
 
 DESCRIPTION
@@ -23,23 +23,23 @@ current branch.
 
 OPTIONS
 -------
 
 OPTIONS
 -------
-<mbox>...::
+<mbox>|<Maildir>...::
        The list of mailbox files to read patches from. If you do not
        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::
+-s::
+--signoff::
        Add `Signed-off-by:` line to the commit message, using
        the committer identity of yourself.
 
        Add `Signed-off-by:` line to the commit message, using
        the committer identity of yourself.
 
--d=<dir>, --dotest=<dir>::
-       Instead of `.dotest` directory, use <dir> as a working
-       area to store extracted patches.
+-k::
+--keep::
+       Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
 
 
--k, --keep::
-       Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
-
--u, --utf8::
-       Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
+-u::
+--utf8::
+       Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
        The proposed commit log message taken from the e-mail
        is re-coded into UTF-8 encoding (configuration variable
        `i18n.commitencoding` can be used to specify project's
        The proposed commit log message taken from the e-mail
        is re-coded into UTF-8 encoding (configuration variable
        `i18n.commitencoding` can be used to specify project's
@@ -50,36 +50,41 @@ default.   You could use `--no-utf8` to override this.
 
 --no-utf8::
        Pass `-n` flag to `git-mailinfo` (see
 
 --no-utf8::
        Pass `-n` flag to `git-mailinfo` (see
-       gitlink:git-mailinfo[1]).
+       linkgit:git-mailinfo[1]).
 
 
--3, --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
        available locally.
 
        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
        available locally.
 
--b, --binary::
+-b::
+--binary::
        Pass `--allow-binary-replacement` flag to `git-apply`
        Pass `--allow-binary-replacement` flag to `git-apply`
-       (see gitlink:git-apply[1]).
+       (see linkgit:git-apply[1]).
 
 --whitespace=<option>::
 
 --whitespace=<option>::
-       This flag is passed to the `git-apply` (see gitlink:git-apply[1])
+       This flag is passed to the `git-apply` (see linkgit:git-apply[1])
        program that applies
        the patch.
 
        program that applies
        the patch.
 
--C<n>, -p<n>::
-       These flags are passed to the `git-apply` (see gitlink:git-apply[1])
+-C<n>::
+-p<n>::
+       These flags are passed to the `git-apply` (see linkgit:git-apply[1])
        program that applies
        the patch.
 
        program that applies
        the patch.
 
--i, --interactive::
+-i::
+--interactive::
        Run interactively.
 
 --skip::
        Skip the current patch.  This is only meaningful when
        restarting an aborted patch.
 
        Run interactively.
 
 --skip::
        Skip the current patch.  This is only meaningful when
        restarting an aborted patch.
 
--r, --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.
        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.
@@ -126,8 +131,7 @@ 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
 
 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 patch by re-running the command with '--skip'
   option.
 
 . skip the current patch by re-running the command with '--skip'
   option.
@@ -138,13 +142,13 @@ recover from this in one of two ways:
 
 The command refuses to process new mailboxes while `.dotest`
 directory exists, so if you decide to start over from scratch,
 
 The command refuses to process new mailboxes while `.dotest`
 directory exists, so if you decide to start over from scratch,
-run `rm -f .dotest` before running the command with mailbox
+run `rm -f -r .dotest` before running the command with mailbox
 names.
 
 
 SEE ALSO
 --------
 names.
 
 
 SEE ALSO
 --------
-gitlink:git-applymbox[1], gitlink:git-applypatch[1], gitlink:git-apply[1].
+linkgit:git-apply[1].
 
 
 Author
 
 
 Author
@@ -157,5 +161,4 @@ Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.o
 
 GIT
 ---
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite