Code

Merge branch 'dh/pack'
[git.git] / Documentation / git-applymbox.txt
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] [-m] ( -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 -k' output.
36 -m::
37         Patches are applied with `git-apply` command, and unless
38         it cleanly applies without fuzz, the processing fails.
39         With this flag, if a tree that the patch applies cleanly
40         is found in a repository, the patch is applied to the
41         tree and then a 3-way merge between the resulting tree
42         and the current tree.
44 -u::
45         Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
46         The proposed commit log message taken from the e-mail
47         are re-coded into UTF-8 encoding (configuration variable
48         `i18n.commitencoding` can be used to specify project's
49         preferred encoding if it is not UTF-8).  This used to be
50         optional but now it is the default.
51 +
52 Note that the patch is always used as-is without charset
53 conversion, even with this flag.
55 -n::
56         Pass `-n` flag to `git-mailinfo` (see
57         gitlink:git-mailinfo[1]).
59 -c .dotest/<num>::
60         When the patch contained in an e-mail does not cleanly
61         apply, the command exits with an error message. The
62         patch and extracted message are found in .dotest/, and
63         you could re-run 'git applymbox' with '-c .dotest/<num>'
64         flag to restart the process after inspecting and fixing
65         them.
67 <mbox>::
68         The name of the file that contains the e-mail messages
69         with patches.  This file should be in the UNIX mailbox
70         format.  See 'SubmittingPatches' document to learn about
71         the formatting convention for e-mail submission.
73 <signoff>::
74         The name of the file that contains your "Signed-off-by"
75         line.  See 'SubmittingPatches' document to learn what
76         "Signed-off-by" line means.  You can also just say
77         'yes', 'true', 'me', or 'please' to use an automatically
78         generated "Signed-off-by" line based on your committer
79         identity.
82 SEE ALSO
83 --------
84 gitlink:git-am[1], gitlink:git-applypatch[1].
87 Author
88 ------
89 Written by Linus Torvalds <torvalds@osdl.org>
91 Documentation
92 --------------
93 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
95 GIT
96 ---
97 Part of the gitlink:git[7] suite