git push -f documentation
[git/mingw/4msysgit/kblees.git] / Documentation / git-applymbox.txt
blobf74c6a49b3c5d52ed662a83832c7d06915fac65b
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 --mbox' 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         By default, the commit log message, author name and
46         author email are taken from the e-mail without any
47         charset conversion, after minimally decoding MIME
48         transfer encoding.  This flag causes the resulting
49         commit to be encoded in utf-8 by transliterating them.
50         Note that the patch is always used as is without charset
51         conversion, even with this flag.
53 -c .dotest/<num>::
54         When the patch contained in an e-mail does not cleanly
55         apply, the command exits with an error message. The
56         patch and extracted message are found in .dotest/, and
57         you could re-run 'git applymbox' with '-c .dotest/<num>'
58         flag to restart the process after inspecting and fixing
59         them.
61 <mbox>::
62         The name of the file that contains the e-mail messages
63         with patches.  This file should be in the UNIX mailbox
64         format.  See 'SubmittingPatches' document to learn about
65         the formatting convention for e-mail submission.
67 <signoff>::
68         The name of the file that contains your "Signed-off-by"
69         line.  See 'SubmittingPatches' document to learn what
70         "Signed-off-by" line means.  You can also just say
71         'yes', 'true', 'me', or 'please' to use an automatically
72         generated "Signed-off-by" line based on your committer
73         identity.
76 SEE ALSO
77 --------
78 gitlink:git-am[1], gitlink:git-applypatch[1].
81 Author
82 ------
83 Written by Linus Torvalds <torvalds@osdl.org>
85 Documentation
86 --------------
87 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
89 GIT
90 ---
91 Part of the gitlink:git[7] suite