git merge documentation: -m is optional
[gitweb.git] / Documentation / git-am.txt
index 910457d3b388f2c3b1dbe25f5609e3584fb4f113..4fb1d844133ba8350361ee67d074935805a24156 100644 (file)
@@ -3,14 +3,15 @@ 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
 --------
 [verse]
-'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way]
-         [--interactive] [--whitespace=<option>] <mbox>...
+'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
+         [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
+        <mbox>...
 'git-am' [--skip | --resolved]
 
 DESCRIPTION
@@ -21,6 +22,10 @@ current branch.
 
 OPTIONS
 -------
+<mbox>...::
+       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.
@@ -29,8 +34,21 @@ OPTIONS
        Instead of `.dotest` directory, use <dir> as a working
        area to store extracted patches.
 
---utf8, --keep::
-       Pass `-u` and `-k` 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::
@@ -51,6 +69,10 @@ OPTIONS
        This flag is passed to the `git-apply` program that applies
        the patch.
 
+-C<n>, -p<n>::
+       These flag are passed to the `git-apply` program that applies
+       the patch.
+
 --interactive::
        Run interactively, just like git-applymbox.