Officially deprecate repo-config.
[gitweb.git] / Documentation / git-am.txt
index 4fb1d844133ba8350361ee67d074935805a24156..2ffba2102b1c2a7dbd093fed89a15b2e644aa398 100644 (file)
@@ -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,25 +23,26 @@ 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.
 
---signoff::
+-s, --signoff::
        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.
 
---keep::
-       Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
+-k, --keep::
+       Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
 
---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
-       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).
 +
@@ -48,35 +50,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::
-       Do not pass `-u` flag to `git-mailinfo` (see
-       gitlink:git-mailinfo[1]).
+       Pass `-n` flag to `git-mailinfo` (see
+       linkgit: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
-       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 linkgit: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 linkgit:git-apply[1])
+       program that applies
        the patch.
 
 -C<n>, -p<n>::
-       These flag are passed to the `git-apply` program that applies
+       These flags are passed to the `git-apply` (see linkgit:git-apply[1])
+       program that applies
        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.
@@ -84,15 +88,48 @@ default.   You could use `--no-utf8` to override this.
        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
 ----------
 
+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 <anything>]".
+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
-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
@@ -107,7 +144,7 @@ names.
 
 SEE ALSO
 --------
-gitlink:git-applymbox[1], gitlink:git-applypatch[1], gitlink:git-apply[1].
+linkgit:git-apply[1].
 
 
 Author
@@ -120,5 +157,4 @@ Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.o
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[7] suite