]>
Commit | Line | Data |
---|---|---|
dfd66ddf CC |
1 | git-interpret-trailers(1) |
2 | ========================= | |
3 | ||
4 | NAME | |
5 | ---- | |
99e09daf | 6 | git-interpret-trailers - add or parse structured information in commit messages |
dfd66ddf CC |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
99e09daf JK |
11 | 'git interpret-trailers' [options] [(--trailer <token>[(=|:)<value>])...] [<file>...] |
12 | 'git interpret-trailers' [options] [--parse] [<file>...] | |
dfd66ddf CC |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
99e09daf | 16 | Help parsing or adding 'trailers' lines, that look similar to RFC 822 e-mail |
dfd66ddf CC |
17 | headers, at the end of the otherwise free-form part of a commit |
18 | message. | |
19 | ||
20 | This command reads some patches or commit messages from either the | |
99e09daf JK |
21 | <file> arguments or the standard input if no <file> is specified. If |
22 | `--parse` is specified, the output consists of the parsed trailers. | |
23 | ||
5a0d0c03 | 24 | Otherwise, this command applies the arguments passed using the |
99e09daf JK |
25 | `--trailer` option, if any, to the commit message part of each input |
26 | file. The result is emitted on the standard output. | |
dfd66ddf CC |
27 | |
28 | Some configuration variables control the way the `--trailer` arguments | |
29 | are applied to each commit message and the way any existing trailer in | |
30 | the commit message is changed. They also make it possible to | |
31 | automatically add some trailers. | |
32 | ||
33 | By default, a '<token>=<value>' or '<token>:<value>' argument given | |
34 | using `--trailer` will be appended after the existing trailers only if | |
35 | the last trailer has a different (<token>, <value>) pair (or if there | |
36 | is no existing trailer). The <token> and <value> parts will be trimmed | |
37 | to remove starting and trailing whitespace, and the resulting trimmed | |
38 | <token> and <value> will appear in the message like this: | |
39 | ||
40 | ------------------------------------------------ | |
41 | token: value | |
42 | ------------------------------------------------ | |
43 | ||
44 | This means that the trimmed <token> and <value> will be separated by | |
45 | `': '` (one colon followed by one space). | |
46 | ||
47 | By default the new trailer will appear at the end of all the existing | |
48 | trailers. If there is no existing trailer, the new trailer will appear | |
f745acb0 | 49 | after the commit message part of the output, and, if there is no line |
dfd66ddf CC |
50 | with only spaces at the end of the commit message part, one blank line |
51 | will be added before the new trailer. | |
52 | ||
53 | Existing trailers are extracted from the input message by looking for | |
14624506 | 54 | a group of one or more lines that (i) are all trailers, or (ii) contains at |
df616b19 JT |
55 | least one Git-generated or user-configured trailer and consists of at |
56 | least 25% trailers. | |
14624506 | 57 | The group must be preceded by one or more empty (or whitespace-only) lines. |
dfd66ddf CC |
58 | The group must either be at the end of the message or be the last |
59 | non-whitespace lines before a line that starts with '---'. Such three | |
60 | minus signs start the patch part of the message. | |
61 | ||
c463a6b2 | 62 | When reading trailers, there can be whitespaces after the |
dfd66ddf | 63 | token, the separator and the value. There can also be whitespaces |
60ef86a1 JT |
64 | inside the token and the value. The value may be split over multiple lines with |
65 | each subsequent line starting with whitespace, like the "folding" in RFC 822. | |
dfd66ddf CC |
66 | |
67 | Note that 'trailers' do not follow and are not intended to follow many | |
60ef86a1 JT |
68 | rules for RFC 822 headers. For example they do not follow |
69 | the encoding rules and probably many other rules. | |
dfd66ddf CC |
70 | |
71 | OPTIONS | |
72 | ------- | |
e1f89863 TK |
73 | --in-place:: |
74 | Edit the files in place. | |
75 | ||
dfd66ddf CC |
76 | --trim-empty:: |
77 | If the <value> part of any trailer contains only whitespace, | |
78 | the whole trailer will be removed from the resulting message. | |
a43eb67e | 79 | This applies to existing trailers as well as new trailers. |
dfd66ddf CC |
80 | |
81 | --trailer <token>[(=|:)<value>]:: | |
82 | Specify a (<token>, <value>) pair that should be applied as a | |
83 | trailer to the input messages. See the description of this | |
84 | command. | |
85 | ||
0ea5292e PB |
86 | --where <placement>:: |
87 | --no-where:: | |
88 | Specify where all new trailers will be added. A setting | |
89 | provided with '--where' overrides all configuration variables | |
90 | and applies to all '--trailer' options until the next occurrence of | |
91 | '--where' or '--no-where'. | |
92 | ||
93 | --if-exists <action>:: | |
94 | --no-if-exists:: | |
95 | Specify what action will be performed when there is already at | |
96 | least one trailer with the same <token> in the message. A setting | |
97 | provided with '--if-exists' overrides all configuration variables | |
98 | and applies to all '--trailer' options until the next occurrence of | |
99 | '--if-exists' or '--no-if-exists'. | |
100 | ||
101 | --if-missing <action>:: | |
102 | --no-if-missing:: | |
103 | Specify what action will be performed when there is no other | |
104 | trailer with the same <token> in the message. A setting | |
105 | provided with '--if-missing' overrides all configuration variables | |
106 | and applies to all '--trailer' options until the next occurrence of | |
107 | '--if-missing' or '--no-if-missing'. | |
108 | ||
56c493ed JK |
109 | --only-trailers:: |
110 | Output only the trailers, not any other parts of the input. | |
111 | ||
fdbdb64f JK |
112 | --only-input:: |
113 | Output only trailers that exist in the input; do not add any | |
114 | from the command-line or by following configured `trailer.*` | |
115 | rules. | |
116 | ||
00002396 JK |
117 | --unfold:: |
118 | Remove any whitespace-continuation in trailers, so that each | |
119 | trailer appears on a line by itself with its full content. | |
120 | ||
99e09daf JK |
121 | --parse:: |
122 | A convenience alias for `--only-trailers --only-input | |
123 | --unfold`. | |
124 | ||
dfd66ddf CC |
125 | CONFIGURATION VARIABLES |
126 | ----------------------- | |
127 | ||
128 | trailer.separators:: | |
129 | This option tells which characters are recognized as trailer | |
130 | separators. By default only ':' is recognized as a trailer | |
131 | separator, except that '=' is always accepted on the command | |
132 | line for compatibility with other git commands. | |
133 | + | |
134 | The first character given by this option will be the default character | |
135 | used when another separator is not specified in the config for this | |
136 | trailer. | |
137 | + | |
138 | For example, if the value for this option is "%=$", then only lines | |
139 | using the format '<token><sep><value>' with <sep> containing '%', '=' | |
140 | or '$' and then spaces will be considered trailers. And '%' will be | |
141 | the default separator used, so by default trailers will appear like: | |
142 | '<token>% <value>' (one percent sign and one space will appear between | |
143 | the token and the value). | |
144 | ||
145 | trailer.where:: | |
146 | This option tells where a new trailer will be added. | |
147 | + | |
148 | This can be `end`, which is the default, `start`, `after` or `before`. | |
149 | + | |
150 | If it is `end`, then each new trailer will appear at the end of the | |
151 | existing trailers. | |
152 | + | |
153 | If it is `start`, then each new trailer will appear at the start, | |
154 | instead of the end, of the existing trailers. | |
155 | + | |
156 | If it is `after`, then each new trailer will appear just after the | |
157 | last trailer with the same <token>. | |
158 | + | |
159 | If it is `before`, then each new trailer will appear just before the | |
160 | first trailer with the same <token>. | |
161 | ||
162 | trailer.ifexists:: | |
163 | This option makes it possible to choose what action will be | |
164 | performed when there is already at least one trailer with the | |
165 | same <token> in the message. | |
166 | + | |
167 | The valid values for this option are: `addIfDifferentNeighbor` (this | |
b275da81 | 168 | is the default), `addIfDifferent`, `add`, `replace` or `doNothing`. |
dfd66ddf CC |
169 | + |
170 | With `addIfDifferentNeighbor`, a new trailer will be added only if no | |
171 | trailer with the same (<token>, <value>) pair is above or below the line | |
172 | where the new trailer will be added. | |
173 | + | |
174 | With `addIfDifferent`, a new trailer will be added only if no trailer | |
175 | with the same (<token>, <value>) pair is already in the message. | |
176 | + | |
177 | With `add`, a new trailer will be added, even if some trailers with | |
178 | the same (<token>, <value>) pair are already in the message. | |
179 | + | |
180 | With `replace`, an existing trailer with the same <token> will be | |
181 | deleted and the new trailer will be added. The deleted trailer will be | |
182 | the closest one (with the same <token>) to the place where the new one | |
183 | will be added. | |
184 | + | |
185 | With `doNothing`, nothing will be done; that is no new trailer will be | |
186 | added if there is already one with the same <token> in the message. | |
187 | ||
188 | trailer.ifmissing:: | |
189 | This option makes it possible to choose what action will be | |
190 | performed when there is not yet any trailer with the same | |
191 | <token> in the message. | |
192 | + | |
193 | The valid values for this option are: `add` (this is the default) and | |
194 | `doNothing`. | |
195 | + | |
196 | With `add`, a new trailer will be added. | |
197 | + | |
198 | With `doNothing`, nothing will be done. | |
199 | ||
200 | trailer.<token>.key:: | |
201 | This `key` will be used instead of <token> in the trailer. At | |
202 | the end of this key, a separator can appear and then some | |
203 | space characters. By default the only valid separator is ':', | |
204 | but this can be changed using the `trailer.separators` config | |
205 | variable. | |
206 | + | |
207 | If there is a separator, then the key will be used instead of both the | |
208 | <token> and the default separator when adding the trailer. | |
209 | ||
210 | trailer.<token>.where:: | |
211 | This option takes the same values as the 'trailer.where' | |
212 | configuration variable and it overrides what is specified by | |
213 | that option for trailers with the specified <token>. | |
214 | ||
c88bf543 PB |
215 | trailer.<token>.ifexists:: |
216 | This option takes the same values as the 'trailer.ifexists' | |
dfd66ddf CC |
217 | configuration variable and it overrides what is specified by |
218 | that option for trailers with the specified <token>. | |
219 | ||
220 | trailer.<token>.ifmissing:: | |
221 | This option takes the same values as the 'trailer.ifmissing' | |
222 | configuration variable and it overrides what is specified by | |
223 | that option for trailers with the specified <token>. | |
224 | ||
225 | trailer.<token>.command:: | |
226 | This option can be used to specify a shell command that will | |
227 | be called to automatically add or modify a trailer with the | |
228 | specified <token>. | |
229 | + | |
230 | When this option is specified, the behavior is as if a special | |
231 | '<token>=<value>' argument were added at the beginning of the command | |
232 | line, where <value> is taken to be the standard output of the | |
233 | specified command with any leading and trailing whitespace trimmed | |
234 | off. | |
235 | + | |
236 | If the command contains the `$ARG` string, this string will be | |
237 | replaced with the <value> part of an existing trailer with the same | |
238 | <token>, if any, before the command is launched. | |
239 | + | |
240 | If some '<token>=<value>' arguments are also passed on the command | |
241 | line, when a 'trailer.<token>.command' is configured, the command will | |
242 | also be executed for each of these arguments. And the <value> part of | |
243 | these arguments, if any, will be used to replace the `$ARG` string in | |
244 | the command. | |
245 | ||
246 | EXAMPLES | |
247 | -------- | |
248 | ||
249 | * Configure a 'sign' trailer with a 'Signed-off-by' key, and then | |
250 | add two of these trailers to a message: | |
251 | + | |
252 | ------------ | |
253 | $ git config trailer.sign.key "Signed-off-by" | |
254 | $ cat msg.txt | |
255 | subject | |
256 | ||
257 | message | |
258 | $ cat msg.txt | git interpret-trailers --trailer 'sign: Alice <alice@example.com>' --trailer 'sign: Bob <bob@example.com>' | |
259 | subject | |
260 | ||
261 | message | |
262 | ||
263 | Signed-off-by: Alice <alice@example.com> | |
264 | Signed-off-by: Bob <bob@example.com> | |
265 | ------------ | |
266 | ||
bcf9626a | 267 | * Use the `--in-place` option to edit a message file in place: |
e1f89863 TK |
268 | + |
269 | ------------ | |
270 | $ cat msg.txt | |
271 | subject | |
272 | ||
273 | message | |
274 | ||
275 | Signed-off-by: Bob <bob@example.com> | |
276 | $ git interpret-trailers --trailer 'Acked-by: Alice <alice@example.com>' --in-place msg.txt | |
277 | $ cat msg.txt | |
278 | subject | |
279 | ||
280 | message | |
281 | ||
282 | Signed-off-by: Bob <bob@example.com> | |
283 | Acked-by: Alice <alice@example.com> | |
284 | ------------ | |
285 | ||
dfd66ddf CC |
286 | * Extract the last commit as a patch, and add a 'Cc' and a |
287 | 'Reviewed-by' trailer to it: | |
288 | + | |
289 | ------------ | |
290 | $ git format-patch -1 | |
291 | 0001-foo.patch | |
292 | $ git interpret-trailers --trailer 'Cc: Alice <alice@example.com>' --trailer 'Reviewed-by: Bob <bob@example.com>' 0001-foo.patch >0001-bar.patch | |
293 | ------------ | |
294 | ||
295 | * Configure a 'sign' trailer with a command to automatically add a | |
296 | 'Signed-off-by: ' with the author information only if there is no | |
297 | 'Signed-off-by: ' already, and show how it works: | |
298 | + | |
299 | ------------ | |
300 | $ git config trailer.sign.key "Signed-off-by: " | |
301 | $ git config trailer.sign.ifmissing add | |
302 | $ git config trailer.sign.ifexists doNothing | |
303 | $ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"' | |
304 | $ git interpret-trailers <<EOF | |
305 | > EOF | |
306 | ||
307 | Signed-off-by: Bob <bob@example.com> | |
308 | $ git interpret-trailers <<EOF | |
309 | > Signed-off-by: Alice <alice@example.com> | |
310 | > EOF | |
311 | ||
312 | Signed-off-by: Alice <alice@example.com> | |
313 | ------------ | |
314 | ||
315 | * Configure a 'fix' trailer with a key that contains a '#' and no | |
316 | space after this character, and show how it works: | |
317 | + | |
318 | ------------ | |
319 | $ git config trailer.separators ":#" | |
320 | $ git config trailer.fix.key "Fix #" | |
321 | $ echo "subject" | git interpret-trailers --trailer fix=42 | |
322 | subject | |
323 | ||
324 | Fix #42 | |
325 | ------------ | |
326 | ||
327 | * Configure a 'see' trailer with a command to show the subject of a | |
328 | commit that is related, and show how it works: | |
329 | + | |
330 | ------------ | |
331 | $ git config trailer.see.key "See-also: " | |
332 | $ git config trailer.see.ifExists "replace" | |
333 | $ git config trailer.see.ifMissing "doNothing" | |
334 | $ git config trailer.see.command "git log -1 --oneline --format=\"%h (%s)\" --abbrev-commit --abbrev=14 \$ARG" | |
335 | $ git interpret-trailers <<EOF | |
336 | > subject | |
337 | > | |
338 | > message | |
339 | > | |
340 | > see: HEAD~2 | |
341 | > EOF | |
342 | subject | |
343 | ||
344 | message | |
345 | ||
346 | See-also: fe3187489d69c4 (subject of related commit) | |
347 | ------------ | |
348 | ||
349 | * Configure a commit template with some trailers with empty values | |
350 | (using sed to show and keep the trailing spaces at the end of the | |
351 | trailers), then configure a commit-msg hook that uses | |
352 | 'git interpret-trailers' to remove trailers with empty values and | |
353 | to add a 'git-version' trailer: | |
354 | + | |
355 | ------------ | |
356 | $ sed -e 's/ Z$/ /' >commit_template.txt <<EOF | |
357 | > ***subject*** | |
358 | > | |
359 | > ***message*** | |
360 | > | |
361 | > Fixes: Z | |
362 | > Cc: Z | |
363 | > Reviewed-by: Z | |
364 | > Signed-off-by: Z | |
365 | > EOF | |
366 | $ git config commit.template commit_template.txt | |
367 | $ cat >.git/hooks/commit-msg <<EOF | |
368 | > #!/bin/sh | |
369 | > git interpret-trailers --trim-empty --trailer "git-version: \$(git describe)" "\$1" > "\$1.new" | |
370 | > mv "\$1.new" "\$1" | |
371 | > EOF | |
372 | $ chmod +x .git/hooks/commit-msg | |
373 | ------------ | |
374 | ||
375 | SEE ALSO | |
376 | -------- | |
377 | linkgit:git-commit[1], linkgit:git-format-patch[1], linkgit:git-config[1] | |
378 | ||
379 | GIT | |
380 | --- | |
381 | Part of the linkgit:git[1] suite |