user-manual: use pithier example commit
[gitweb.git] / Documentation / git-applymbox.txt
index 5022643ad166e390a42da0f9d3a733219020417b..ea919ba5d7e8a01cd2e5aa9116ff4bbcf9ddd1ea 100644 (file)
@@ -8,7 +8,7 @@ git-applymbox - Apply a series of patches in a mailbox
 
 SYNOPSIS
 --------
-'git-applymbox' [-u] [-k] [-q] ( -c .dotest/<num> | <mbox> ) [ <signoff> ]
+'git-applymbox' [-u] [-k] [-q] [-m] ( -c .dotest/<num> | <mbox> ) [ <signoff> ]
 
 DESCRIPTION
 -----------
@@ -22,7 +22,7 @@ OPTIONS
 -q::
        Apply patches interactively.  The user will be given
        opportunity to edit the log message and the patch before
-       attempting to apply patch in each e-mail message.
+       attempting to apply it.
 
 -k::
        Usually the program 'cleans up' the Subject: header line
@@ -31,16 +31,30 @@ OPTIONS
        whitespaces, (3) '[' up to ']', typically '[PATCH]', and
        then prepends "[PATCH] ".  This flag forbids this
        munging, and is most useful when used to read back 'git
-       format-patch --mbox' output.
+       format-patch -k' output.
+
+-m::
+       Patches are applied with `git-apply` command, and unless
+       it cleanly applies without fuzz, the processing fails.
+       With this flag, if a tree that the patch applies cleanly
+       is found in a repository, the patch is applied to the
+       tree and then a 3-way merge between the resulting tree
+       and the current tree.
 
 -u::
-       By default, the commit log message, author name and
-       author email are taken from the e-mail without any
-       charset conversion, after minimally decoding MIME
-       transfer encoding.  This flag causes the resulting
-       commit to be encoded in utf-8 by transliterating them.
-       Note that the patch is always used as is without charset
-       conversion, even with this flag.
+       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 used to be
+       optional but now it is the default.
++
+Note that the patch is always used as-is without charset
+conversion, even with this flag.
+
+-n::
+       Pass `-n` flag to `git-mailinfo` (see
+       gitlink:git-mailinfo[1]).
 
 -c .dotest/<num>::
        When the patch contained in an e-mail does not cleanly
@@ -67,7 +81,7 @@ OPTIONS
 
 SEE ALSO
 --------
-gitlink:git-applypatch[1].
+gitlink:git-am[1], gitlink:git-applypatch[1].
 
 
 Author