Autogenerated man pages for v1.2.4-gec57
[git.git] / man1 / git-applymbox.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-APPLYMBOX" 1 "" "" ""
21 .SH NAME
22 git-applymbox \- Apply a series of patches in a mailbox
23 .SH "SYNOPSIS"
24
25
26 git\-applymbox [\-u] [\-k] [\-q] [\-m] ( \-c \&.dotest/<num> | <mbox> ) [ <signoff> ]
27
28 .SH "DESCRIPTION"
29
30
31 Splits mail messages in a mailbox into commit log message, authorship information and patches, and applies them to the current branch\&.
32
33 .SH "OPTIONS"
34
35 .TP
36 \-q
37 Apply patches interactively\&. The user will be given opportunity to edit the log message and the patch before attempting to apply it\&.
38
39 .TP
40 \-k
41 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 \-\-mbox output\&.
42
43 .TP
44 \-m
45 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\&.
46
47 .TP
48 \-u
49 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\&.
50
51 .TP
52 \-c \&.dotest/<num>
53 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\&.
54
55 .TP
56 <mbox>
57 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\&.
58
59 .TP
60 <signoff>
61 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\&.
62
63 .SH "SEE ALSO"
64
65
66 \fBgit\-am\fR(1), \fBgit\-applypatch\fR(1)\&.
67
68 .SH "AUTHOR"
69
70
71 Written by Linus Torvalds <torvalds@osdl\&.org>
72
73 .SH "DOCUMENTATION"
74
75
76 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
77
78 .SH "GIT"
79
80
81 Part of the \fBgit\fR(7) suite
82