Merge branch 'tt/gc'

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

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 148ce405681cd4f5bd38575b6a427a7e5745a109..ba79773f79fc8823f1c611e51b163866ada26306 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]
 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>...

 'git-am' [--skip | --resolved]
 
 DESCRIPTION
 'git-am' [--skip | --resolved]
 
 DESCRIPTION


@@ -26,21 +27,21 @@ OPTIONS
        The list of mailbox files to read patches from. If you do not
        supply this argument, reads from the standard input.
 
        The list of mailbox files to read patches from. If you do not
        supply this argument, reads from the standard input.
 

---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.
 

---dotest=<dir>::
+-d=<dir>, --dotest=<dir>::

        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.
 

---keep::
+-k, --keep::

        Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
 
        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
        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).
 +
        `i18n.commitencoding` can be used to specify project's
        preferred encoding if it is not UTF-8).
 +


@@ -48,35 +49,37 @@ This was optional in prior versions of git, but now it is the
 default.   You could use `--no-utf8` to override this.
 
 --no-utf8::
 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]).
 
        gitlink:git-mailinfo[1]).
 

---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
        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>::
 
 --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>::
        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.
 
        the patch.
 

---interactive::
-       Run interactively, just like git-applymbox.
+-i, --interactive::
+       Run interactively.
+
+--skip::
+       Skip the current patch.  This is only meaningful when
+       restarting an aborted patch.

 
 

---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.


@@ -84,6 +87,13 @@ default.   You could use `--no-utf8` to override this.
        extracted from the e-mail message and the current index
        file, and continue.
 
        extracted from the e-mail message and the current index
        file, and continue.
 

+--resolvemsg=<msg>::
+       When a patch failure occurs, <msg> 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
 ----------
 
 DISCUSSION
 ----------
 


@@ -119,7 +129,7 @@ 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, just like 'git-applymbox' does.  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
   option.
 
 . hand resolve the conflict in the working directory, and update