]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-format-patch(1) |
2 | =================== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
7bd7f280 | 6 | git-format-patch - Prepare patches for e-mail submission |
7fc9d69f JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
353ce815 | 11 | [verse] |
6eea60f8 | 12 | 'git-format-patch' [-k] [-o <dir> | --stdout] [--thread] |
2d9e4a47 | 13 | [--attach[=<boundary>] | --inline[=<boundary>]] |
e6ff0f42 | 14 | [-s | --signoff] [<common diff options>] |
6eea60f8 | 15 | [-n | --numbered | -N | --no-numbered] |
e6ff0f42 | 16 | [--start-number <n>] [--numbered-files] |
2d9e4a47 RJ |
17 | [--in-reply-to=Message-Id] [--suffix=.<sfx>] |
18 | [--ignore-if-in-upstream] | |
19 | [--subject-prefix=Subject-Prefix] | |
8a1d076e | 20 | [ <since> | <revision range> ] |
7fc9d69f JH |
21 | |
22 | DESCRIPTION | |
23 | ----------- | |
2052d146 | 24 | |
8a1d076e | 25 | Prepare each commit with its patch in |
2052d146 | 26 | one file per commit, formatted to resemble UNIX mailbox format. |
2052d146 DS |
27 | The output of this command is convenient for e-mail submission or |
28 | for use with gitlink:git-am[1]. | |
35ef3a4c | 29 | |
8a1d076e JH |
30 | There are two ways to specify which commits to operate on. |
31 | ||
32 | 1. A single commit, <since>, specifies that the commits leading | |
33 | to the tip of the current branch that are not in the history | |
34 | that leads to the <since> to be output. | |
35 | ||
36 | 2. Generic <revision range> expression (see "SPECIFYING | |
37 | REVISIONS" section in gitlink:git-rev-parse[1]) means the | |
2f6a3823 JH |
38 | commits in the specified range. |
39 | ||
40 | A single commit, when interpreted as a <revision range> | |
41 | expression, means "everything that leads to that commit", but | |
42 | if you write 'git format-patch <commit>', the previous rule | |
43 | applies to that command line and you do not get "everything | |
44 | since the beginning of the time". If you want to format | |
45 | everything since project inception to one commit, say "git | |
46 | format-patch \--root <commit>" to make it clear that it is the | |
47 | latter case. | |
8a1d076e | 48 | |
e6ff0f42 | 49 | By default, each output file is numbered sequentially from 1, and uses the |
2052d146 | 50 | first line of the commit message (massaged for pathname safety) as |
e6ff0f42 JL |
51 | the filename. With the --numbered-files option, the output file names |
52 | will only be numbers, without the first line of the commit appended. | |
53 | The names of the output files are printed to standard | |
2052d146 | 54 | output, unless the --stdout option is specified. |
66f04f38 | 55 | |
2052d146 DS |
56 | If -o is specified, output files are created in <dir>. Otherwise |
57 | they are created in the current working directory. | |
35ef3a4c | 58 | |
2052d146 DS |
59 | If -n is specified, instead of "[PATCH] Subject", the first line |
60 | is formatted as "[PATCH n/m] Subject". | |
35ef3a4c | 61 | |
cc35de84 JT |
62 | If given --thread, git-format-patch will generate In-Reply-To and |
63 | References headers to make the second and subsequent patch mails appear | |
64 | as replies to the first mail; this also generates a Message-Id header to | |
65 | reference. | |
7fc9d69f JH |
66 | |
67 | OPTIONS | |
68 | ------- | |
c1a95fa6 | 69 | :git-format-patch: 1 |
b8105375 BG |
70 | include::diff-options.txt[] |
71 | ||
ed5f07a6 MV |
72 | -<n>:: |
73 | Limits the number of patches to prepare. | |
74 | ||
6f855371 | 75 | -o|--output-directory <dir>:: |
35ef3a4c | 76 | Use <dir> to store the resulting files, instead of the |
efd02016 | 77 | current working directory. |
35ef3a4c | 78 | |
6f855371 | 79 | -n|--numbered:: |
35ef3a4c JH |
80 | Name output in '[PATCH n/m]' format. |
81 | ||
49604a4d BG |
82 | -N|--no-numbered:: |
83 | Name output in '[PATCH]' format. | |
84 | ||
2052d146 DS |
85 | --start-number <n>:: |
86 | Start numbering the patches at <n> instead of 1. | |
87 | ||
e6ff0f42 JL |
88 | --numbered-files:: |
89 | Output file names will be a simple number sequence | |
90 | without the default first line of the commit appended. | |
91 | Mutually exclusive with the --stdout option. | |
92 | ||
6f855371 | 93 | -k|--keep-subject:: |
35ef3a4c JH |
94 | Do not strip/add '[PATCH]' from the first line of the |
95 | commit log message. | |
96 | ||
6f855371 NW |
97 | -s|--signoff:: |
98 | Add `Signed-off-by:` line to the commit message, using | |
99 | the committer identity of yourself. | |
100 | ||
54ba6013 | 101 | --stdout:: |
2052d146 DS |
102 | Print all commits to the standard output in mbox format, |
103 | instead of creating a file for each one. | |
7fc9d69f | 104 | |
c112f689 JS |
105 | --attach[=<boundary>]:: |
106 | Create multipart/mixed attachment, the first part of | |
107 | which is the commit message and the patch itself in the | |
108 | second part, with "Content-Disposition: attachment". | |
109 | ||
110 | --inline[=<boundary>]:: | |
111 | Create multipart/mixed attachment, the first part of | |
112 | which is the commit message and the patch itself in the | |
113 | second part, with "Content-Disposition: inline". | |
a15a44ef | 114 | |
cc35de84 JT |
115 | --thread:: |
116 | Add In-Reply-To and References headers to make the second and | |
117 | subsequent mails appear as replies to the first. Also generates | |
118 | the Message-Id header to reference. | |
28ffb898 | 119 | |
da56645d JT |
120 | --in-reply-to=Message-Id:: |
121 | Make the first mail (or all the mails with --no-thread) appear as a | |
122 | reply to the given Message-Id, which avoids breaking threads to | |
123 | provide a new patch series. | |
124 | ||
cc75ad67 DK |
125 | --ignore-if-in-upstream:: |
126 | Do not include a patch that matches a commit in | |
127 | <until>..<since>. This will examine all patches reachable | |
128 | from <since> but not from <until> and compare them with the | |
129 | patches being generated, and any patch that matches is | |
130 | ignored. | |
131 | ||
2d9e4a47 RJ |
132 | --subject-prefix=<Subject-Prefix>:: |
133 | Instead of the standard '[PATCH]' prefix in the subject | |
134 | line, instead use '[<Subject-Prefix>]'. This | |
135 | allows for useful naming of a patch series, and can be | |
136 | combined with the --numbered option. | |
137 | ||
03eeaeae | 138 | --suffix=.<sfx>:: |
917a8f89 | 139 | Instead of using `.patch` as the suffix for generated |
02783075 | 140 | filenames, use specified suffix. A common alternative is |
917a8f89 | 141 | `--suffix=.txt`. |
03eeaeae JH |
142 | + |
143 | Note that you would need to include the leading dot `.` if you | |
144 | want a filename like `0001-description-of-my-change.patch`, and | |
145 | the first letter does not have to be a dot. Leaving it empty would | |
146 | not add any suffix. | |
147 | ||
96ce6d26 MM |
148 | CONFIGURATION |
149 | ------------- | |
49604a4d BG |
150 | You can specify extra mail header lines to be added to each message |
151 | in the repository configuration, new defaults for the subject prefix | |
152 | and file suffix, and number patches when outputting more than one. | |
96ce6d26 | 153 | |
917a8f89 | 154 | ------------ |
96ce6d26 MM |
155 | [format] |
156 | headers = "Organization: git-foo\n" | |
dbd21447 | 157 | subjectprefix = CHANGE |
917a8f89 | 158 | suffix = .txt |
49604a4d | 159 | numbered = auto |
917a8f89 | 160 | ------------ |
03eeaeae | 161 | |
96ce6d26 | 162 | |
28ffb898 JH |
163 | EXAMPLES |
164 | -------- | |
165 | ||
166 | git-format-patch -k --stdout R1..R2 | git-am -3 -k:: | |
167 | Extract commits between revisions R1 and R2, and apply | |
168 | them on top of the current branch using `git-am` to | |
169 | cherry-pick them. | |
170 | ||
171 | git-format-patch origin:: | |
2052d146 DS |
172 | Extract all commits which are in the current branch but |
173 | not in the origin branch. For each commit a separate file | |
174 | is created in the current directory. | |
28ffb898 | 175 | |
8a1d076e | 176 | git-format-patch \--root origin:: |
136e6316 | 177 | Extract all commits that lead to 'origin' since the |
8a1d076e JH |
178 | inception of the project. |
179 | ||
803f498c | 180 | git-format-patch -M -B origin:: |
2052d146 DS |
181 | The same as the previous one. Additionally, it detects |
182 | and handles renames and complete rewrites intelligently to | |
183 | produce a renaming patch. A renaming patch reduces the | |
184 | amount of text output, and generally makes it easier to | |
185 | review it. Note that the "patch" program does not | |
186 | understand renaming patches, so use it only when you know | |
187 | the recipient uses git to apply your patch. | |
803f498c | 188 | |
7c496280 JH |
189 | git-format-patch -3:: |
190 | Extract three topmost commits from the current branch | |
191 | and format them as e-mailable patches. | |
28ffb898 JH |
192 | |
193 | See Also | |
194 | -------- | |
353ce815 | 195 | gitlink:git-am[1], gitlink:git-send-email[1] |
28ffb898 JH |
196 | |
197 | ||
7fc9d69f JH |
198 | Author |
199 | ------ | |
200 | Written by Junio C Hamano <junkio@cox.net> | |
201 | ||
202 | Documentation | |
203 | -------------- | |
204 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
205 | ||
206 | GIT | |
207 | --- | |
a7154e91 | 208 | Part of the gitlink:git[7] suite |