X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-applymbox.txt;h=ea919ba5d7e8a01cd2e5aa9116ff4bbcf9ddd1ea;hb=99f171bb7ac5032dde256c02476240c0d019a5fe;hp=acf0bf3d63df6742a236a29392962892fadb5841;hpb=58eaf287f1b25f6427b06bd72d8e555615828aeb;p=git.git

diff --git a/Documentation/git-applymbox.txt b/Documentation/git-applymbox.txt
index acf0bf3d6..ea919ba5d 100644
--- a/Documentation/git-applymbox.txt
+++ b/Documentation/git-applymbox.txt
@@ -3,25 +3,85 @@ git-applymbox(1)
 
 NAME
 ----
-git-applymbox - Some git command not yet documented.
+git-applymbox - Apply a series of patches in a mailbox
 
 
 SYNOPSIS
 --------
-'git-applymbox' [ --option ] <args>...
+'git-applymbox' [-u] [-k] [-q] [-m] ( -c .dotest/<num> | <mbox> ) [ <signoff> ]
 
 DESCRIPTION
 -----------
-Does something not yet documented.
+Splits mail messages in a mailbox into commit log message,
+authorship information and patches, and applies them to the
+current branch.
 
 
 OPTIONS
 -------
---option::
-	Some option not yet documented.
+-q::
+	Apply patches interactively.  The user will be given
+	opportunity to edit the log message and the patch before
+	attempting to apply it.
 
-<args>...::
-	Some argument not yet documented.
+-k::
+	Usually the program 'cleans up' the Subject: header line
+	to extract the title line for the commit log message,
+	among which (1) remove 'Re:' or 're:', (2) leading
+	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 -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::
+	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
+	apply, the command exits with an error message. The
+	patch and extracted message are found in .dotest/, and
+	you could re-run 'git applymbox' with '-c .dotest/<num>'
+	flag to restart the process after inspecting and fixing
+	them.
+
+<mbox>::
+	The name of the file that contains the e-mail messages
+	with patches.  This file should be in the UNIX mailbox
+	format.  See 'SubmittingPatches' document to learn about
+	the formatting convention for e-mail submission.
+
+<signoff>::
+	The name of the file that contains your "Signed-off-by"
+	line.  See 'SubmittingPatches' document to learn what
+	"Signed-off-by" line means.  You can also just say
+	'yes', 'true', 'me', or 'please' to use an automatically
+	generated "Signed-off-by" line based on your committer
+	identity.
+
+
+SEE ALSO
+--------
+gitlink:git-am[1], gitlink:git-applypatch[1].
 
 
 Author
@@ -34,5 +94,5 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite