Merge branch 'fixes'
[git/jrn.git] / Documentation / git-applymbox.txt
blobbb543788c0c24d33e6fd2f163f46d791f1c0ae88
1 git-applymbox(1)
2 ================
4 NAME
5 ----
6 git-applymbox - Apply a series of patches in a mailbox
9 SYNOPSIS
10 --------
11 'git-applymbox' [-u] [-k] [-q] ( -c .dotest/<num> | <mbox> ) [ <signoff> ]
13 DESCRIPTION
14 -----------
15 Splits mail messages in a mailbox into commit log message,
16 authorship information and patches, and applies them to the
17 current branch.
20 OPTIONS
21 -------
22 -q::
23         Apply patches interactively.  The user will be given
24         opportunity to edit the log message and the patch before
25         attempting to apply it.
27 -k::
28         Usually the program 'cleans up' the Subject: header line
29         to extract the title line for the commit log message,
30         among which (1) remove 'Re:' or 're:', (2) leading
31         whitespaces, (3) '[' up to ']', typically '[PATCH]', and
32         then prepends "[PATCH] ".  This flag forbids this
33         munging, and is most useful when used to read back 'git
34         format-patch --mbox' output.
36 -u::
37         By default, the commit log message, author name and
38         author email are taken from the e-mail without any
39         charset conversion, after minimally decoding MIME
40         transfer encoding.  This flag causes the resulting
41         commit to be encoded in utf-8 by transliterating them.
42         Note that the patch is always used as is without charset
43         conversion, even with this flag.
45 -c .dotest/<num>::
46         When the patch contained in an e-mail does not cleanly
47         apply, the command exits with an error message. The
48         patch and extracted message are found in .dotest/, and
49         you could re-run 'git applymbox' with '-c .dotest/<num>'
50         flag to restart the process after inspecting and fixing
51         them.
53 <mbox>::
54         The name of the file that contains the e-mail messages
55         with patches.  This file should be in the UNIX mailbox
56         format.  See 'SubmittingPatches' document to learn about
57         the formatting convention for e-mail submission.
59 <signoff>::
60         The name of the file that contains your "Signed-off-by"
61         line.  See 'SubmittingPatches' document to learn what
62         "Signed-off-by" line means.  You can also just say
63         'yes', 'true', 'me', or 'please' to use an automatically
64         generated "Signed-off-by" line based on your committer
65         identity.
68 SEE ALSO
69 --------
70 gitlink:git-applypatch[1].
73 Author
74 ------
75 Written by Linus Torvalds <torvalds@osdl.org>
77 Documentation
78 --------------
79 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
81 GIT
82 ---
83 Part of the gitlink:git[7] suite