Autogenerated manpages for v2.41.0
[git-manpages.git] / man1 / git-interpret-trailers.1
blobbf06145eb74e4dd7b41e4a48f2929b92b70824f2
1 '\" t
2 .\"     Title: git-interpret-trailers
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 2023-06-01
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.41.0
8 .\"  Language: English
9 .\"
10 .TH "GIT\-INTERPRET\-TRAILERS" "1" "2023\-06\-01" "Git 2\&.41\&.0" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-interpret-trailers \- Add or parse structured information in commit messages
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit interpret\-trailers\fR [\-\-in\-place] [\-\-trim\-empty]
36                         [(\-\-trailer <token>[(=|:)<value>])\&...]
37                         [\-\-parse] [<file>\&...]
38 .fi
39 .sp
40 .SH "DESCRIPTION"
41 .sp
42 Help parsing or adding \fItrailers\fR lines, that look similar to RFC 822 e\-mail headers, at the end of the otherwise free\-form part of a commit message\&.
43 .sp
44 This command reads some patches or commit messages from either the <file> arguments or the standard input if no <file> is specified\&. If \fB\-\-parse\fR is specified, the output consists of the parsed trailers\&.
45 .sp
46 Otherwise, this command applies the arguments passed using the \fB\-\-trailer\fR option, if any, to the commit message part of each input file\&. The result is emitted on the standard output\&.
47 .sp
48 Some configuration variables control the way the \fB\-\-trailer\fR arguments are applied to each commit message and the way any existing trailer in the commit message is changed\&. They also make it possible to automatically add some trailers\&.
49 .sp
50 By default, a \fI<token>=<value>\fR or \fI<token>:<value>\fR argument given using \fB\-\-trailer\fR will be appended after the existing trailers only if the last trailer has a different (<token>, <value>) pair (or if there is no existing trailer)\&. The <token> and <value> parts will be trimmed to remove starting and trailing whitespace, and the resulting trimmed <token> and <value> will appear in the message like this:
51 .sp
52 .if n \{\
53 .RS 4
54 .\}
55 .nf
56 token: value
57 .fi
58 .if n \{\
59 .RE
60 .\}
61 .sp
62 .sp
63 This means that the trimmed <token> and <value> will be separated by \fB\*(Aq: \*(Aq\fR (one colon followed by one space)\&.
64 .sp
65 By default the new trailer will appear at the end of all the existing trailers\&. If there is no existing trailer, the new trailer will appear after the commit message part of the output, and, if there is no line with only spaces at the end of the commit message part, one blank line will be added before the new trailer\&.
66 .sp
67 Existing trailers are extracted from the input message by looking for a group of one or more lines that (i) is all trailers, or (ii) contains at least one Git\-generated or user\-configured trailer and consists of at least 25% trailers\&. The group must be preceded by one or more empty (or whitespace\-only) lines\&. The group must either be at the end of the message or be the last non\-whitespace lines before a line that starts with \fI\-\-\-\fR (followed by a space or the end of the line)\&. Such three minus signs start the patch part of the message\&. See also \fB\-\-no\-divider\fR below\&.
68 .sp
69 When reading trailers, there can be no whitespace before or inside the token, but any number of regular space and tab characters are allowed between the token and the separator\&. There can be whitespaces before, inside or after the value\&. The value may be split over multiple lines with each subsequent line starting with at least one whitespace, like the "folding" in RFC 822\&.
70 .sp
71 Note that \fItrailers\fR do not follow and are not intended to follow many rules for RFC 822 headers\&. For example they do not follow the encoding rules and probably many other rules\&.
72 .SH "OPTIONS"
73 .PP
74 \-\-in\-place
75 .RS 4
76 Edit the files in place\&.
77 .RE
78 .PP
79 \-\-trim\-empty
80 .RS 4
81 If the <value> part of any trailer contains only whitespace, the whole trailer will be removed from the resulting message\&. This applies to existing trailers as well as new trailers\&.
82 .RE
83 .PP
84 \-\-trailer <token>[(=|:)<value>]
85 .RS 4
86 Specify a (<token>, <value>) pair that should be applied as a trailer to the input messages\&. See the description of this command\&.
87 .RE
88 .PP
89 \-\-where <placement>, \-\-no\-where
90 .RS 4
91 Specify where all new trailers will be added\&. A setting provided with
92 \fI\-\-where\fR
93 overrides all configuration variables and applies to all
94 \fI\-\-trailer\fR
95 options until the next occurrence of
96 \fI\-\-where\fR
98 \fI\-\-no\-where\fR\&. Possible values are
99 \fBafter\fR,
100 \fBbefore\fR,
101 \fBend\fR
103 \fBstart\fR\&.
106 \-\-if\-exists <action>, \-\-no\-if\-exists
107 .RS 4
108 Specify what action will be performed when there is already at least one trailer with the same <token> in the message\&. A setting provided with
109 \fI\-\-if\-exists\fR
110 overrides all configuration variables and applies to all
111 \fI\-\-trailer\fR
112 options until the next occurrence of
113 \fI\-\-if\-exists\fR
115 \fI\-\-no\-if\-exists\fR\&. Possible actions are
116 \fBaddIfDifferent\fR,
117 \fBaddIfDifferentNeighbor\fR,
118 \fBadd\fR,
119 \fBreplace\fR
121 \fBdoNothing\fR\&.
124 \-\-if\-missing <action>, \-\-no\-if\-missing
125 .RS 4
126 Specify what action will be performed when there is no other trailer with the same <token> in the message\&. A setting provided with
127 \fI\-\-if\-missing\fR
128 overrides all configuration variables and applies to all
129 \fI\-\-trailer\fR
130 options until the next occurrence of
131 \fI\-\-if\-missing\fR
133 \fI\-\-no\-if\-missing\fR\&. Possible actions are
134 \fBdoNothing\fR
136 \fBadd\fR\&.
139 \-\-only\-trailers
140 .RS 4
141 Output only the trailers, not any other parts of the input\&.
144 \-\-only\-input
145 .RS 4
146 Output only trailers that exist in the input; do not add any from the command\-line or by following configured
147 \fBtrailer\&.*\fR
148 rules\&.
151 \-\-unfold
152 .RS 4
153 Remove any whitespace\-continuation in trailers, so that each trailer appears on a line by itself with its full content\&.
156 \-\-parse
157 .RS 4
158 A convenience alias for
159 \fB\-\-only\-trailers \-\-only\-input \-\-unfold\fR\&.
162 \-\-no\-divider
163 .RS 4
164 Do not treat
165 \fB\-\-\-\fR
166 as the end of the commit message\&. Use this when you know your input contains just the commit message itself (and not an email or the output of
167 \fBgit format\-patch\fR)\&.
169 .SH "CONFIGURATION VARIABLES"
171 trailer\&.separators
172 .RS 4
173 This option tells which characters are recognized as trailer separators\&. By default only
174 \fI:\fR
175 is recognized as a trailer separator, except that
176 \fI=\fR
177 is always accepted on the command line for compatibility with other git commands\&.
179 The first character given by this option will be the default character used when another separator is not specified in the config for this trailer\&.
181 For example, if the value for this option is "%=$", then only lines using the format
182 \fI<token><sep><value>\fR
183 with <sep> containing
184 \fI%\fR,
185 \fI=\fR
187 \fI$\fR
188 and then spaces will be considered trailers\&. And
189 \fI%\fR
190 will be the default separator used, so by default trailers will appear like:
191 \fI<token>% <value>\fR
192 (one percent sign and one space will appear between the token and the value)\&.
195 trailer\&.where
196 .RS 4
197 This option tells where a new trailer will be added\&.
199 This can be
200 \fBend\fR, which is the default,
201 \fBstart\fR,
202 \fBafter\fR
204 \fBbefore\fR\&.
206 If it is
207 \fBend\fR, then each new trailer will appear at the end of the existing trailers\&.
209 If it is
210 \fBstart\fR, then each new trailer will appear at the start, instead of the end, of the existing trailers\&.
212 If it is
213 \fBafter\fR, then each new trailer will appear just after the last trailer with the same <token>\&.
215 If it is
216 \fBbefore\fR, then each new trailer will appear just before the first trailer with the same <token>\&.
219 trailer\&.ifexists
220 .RS 4
221 This option makes it possible to choose what action will be performed when there is already at least one trailer with the same <token> in the message\&.
223 The valid values for this option are:
224 \fBaddIfDifferentNeighbor\fR
225 (this is the default),
226 \fBaddIfDifferent\fR,
227 \fBadd\fR,
228 \fBreplace\fR
230 \fBdoNothing\fR\&.
232 With
233 \fBaddIfDifferentNeighbor\fR, a new trailer will be added only if no trailer with the same (<token>, <value>) pair is above or below the line where the new trailer will be added\&.
235 With
236 \fBaddIfDifferent\fR, a new trailer will be added only if no trailer with the same (<token>, <value>) pair is already in the message\&.
238 With
239 \fBadd\fR, a new trailer will be added, even if some trailers with the same (<token>, <value>) pair are already in the message\&.
241 With
242 \fBreplace\fR, an existing trailer with the same <token> will be deleted and the new trailer will be added\&. The deleted trailer will be the closest one (with the same <token>) to the place where the new one will be added\&.
244 With
245 \fBdoNothing\fR, nothing will be done; that is no new trailer will be added if there is already one with the same <token> in the message\&.
248 trailer\&.ifmissing
249 .RS 4
250 This option makes it possible to choose what action will be performed when there is not yet any trailer with the same <token> in the message\&.
252 The valid values for this option are:
253 \fBadd\fR
254 (this is the default) and
255 \fBdoNothing\fR\&.
257 With
258 \fBadd\fR, a new trailer will be added\&.
260 With
261 \fBdoNothing\fR, nothing will be done\&.
264 trailer\&.<token>\&.key
265 .RS 4
266 This
267 \fBkey\fR
268 will be used instead of <token> in the trailer\&. At the end of this key, a separator can appear and then some space characters\&. By default the only valid separator is
269 \fI:\fR, but this can be changed using the
270 \fBtrailer\&.separators\fR
271 config variable\&.
273 If there is a separator, then the key will be used instead of both the <token> and the default separator when adding the trailer\&.
276 trailer\&.<token>\&.where
277 .RS 4
278 This option takes the same values as the
279 \fItrailer\&.where\fR
280 configuration variable and it overrides what is specified by that option for trailers with the specified <token>\&.
283 trailer\&.<token>\&.ifexists
284 .RS 4
285 This option takes the same values as the
286 \fItrailer\&.ifexists\fR
287 configuration variable and it overrides what is specified by that option for trailers with the specified <token>\&.
290 trailer\&.<token>\&.ifmissing
291 .RS 4
292 This option takes the same values as the
293 \fItrailer\&.ifmissing\fR
294 configuration variable and it overrides what is specified by that option for trailers with the specified <token>\&.
297 trailer\&.<token>\&.command
298 .RS 4
299 This option behaves in the same way as
300 \fItrailer\&.<token>\&.cmd\fR, except that it doesn\(cqt pass anything as argument to the specified command\&. Instead the first occurrence of substring $ARG is replaced by the value that would be passed as argument\&.
303 \fItrailer\&.<token>\&.command\fR
304 option has been deprecated in favor of
305 \fItrailer\&.<token>\&.cmd\fR
306 due to the fact that $ARG in the user\(cqs command is only replaced once and that the original way of replacing $ARG is not safe\&.
308 When both
309 \fItrailer\&.<token>\&.cmd\fR
311 \fItrailer\&.<token>\&.command\fR
312 are given for the same <token>,
313 \fItrailer\&.<token>\&.cmd\fR
314 is used and
315 \fItrailer\&.<token>\&.command\fR
316 is ignored\&.
319 trailer\&.<token>\&.cmd
320 .RS 4
321 This option can be used to specify a shell command that will be called: once to automatically add a trailer with the specified <token>, and then each time a
322 \fI\-\-trailer <token>=<value>\fR
323 argument to modify the <value> of the trailer that this option would produce\&.
325 When the specified command is first called to add a trailer with the specified <token>, the behavior is as if a special
326 \fI\-\-trailer <token>=<value>\fR
327 argument was added at the beginning of the "git interpret\-trailers" command, where <value> is taken to be the standard output of the command with any leading and trailing whitespace trimmed off\&.
329 If some
330 \fI\-\-trailer <token>=<value>\fR
331 arguments are also passed on the command line, the command is called again once for each of these arguments with the same <token>\&. And the <value> part of these arguments, if any, will be passed to the command as its first argument\&. This way the command can produce a <value> computed from the <value> passed in the
332 \fI\-\-trailer <token>=<value>\fR
333 argument\&.
335 .SH "EXAMPLES"
337 .RS 4
338 .ie n \{\
339 \h'-04'\(bu\h'+03'\c
341 .el \{\
342 .sp -1
343 .IP \(bu 2.3
345 Configure a
346 \fIsign\fR
347 trailer with a
348 \fISigned\-off\-by\fR
349 key, and then add two of these trailers to a message:
351 .if n \{\
352 .RS 4
355 $ git config trailer\&.sign\&.key "Signed\-off\-by"
356 $ cat msg\&.txt
357 subject
359 message
360 $ git interpret\-trailers \-\-trailer \*(Aqsign: Alice <alice@example\&.com>\*(Aq \-\-trailer \*(Aqsign: Bob <bob@example\&.com>\*(Aq <msg\&.txt
361 subject
363 message
365 Signed\-off\-by: Alice <alice@example\&.com>
366 Signed\-off\-by: Bob <bob@example\&.com>
368 .if n \{\
374 .RS 4
375 .ie n \{\
376 \h'-04'\(bu\h'+03'\c
378 .el \{\
379 .sp -1
380 .IP \(bu 2.3
382 Use the
383 \fB\-\-in\-place\fR
384 option to edit a message file in place:
386 .if n \{\
387 .RS 4
390 $ cat msg\&.txt
391 subject
393 message
395 Signed\-off\-by: Bob <bob@example\&.com>
396 $ git interpret\-trailers \-\-trailer \*(AqAcked\-by: Alice <alice@example\&.com>\*(Aq \-\-in\-place msg\&.txt
397 $ cat msg\&.txt
398 subject
400 message
402 Signed\-off\-by: Bob <bob@example\&.com>
403 Acked\-by: Alice <alice@example\&.com>
405 .if n \{\
411 .RS 4
412 .ie n \{\
413 \h'-04'\(bu\h'+03'\c
415 .el \{\
416 .sp -1
417 .IP \(bu 2.3
419 Extract the last commit as a patch, and add a
420 \fICc\fR
421 and a
422 \fIReviewed\-by\fR
423 trailer to it:
425 .if n \{\
426 .RS 4
429 $ git format\-patch \-1
430 0001\-foo\&.patch
431 $ git interpret\-trailers \-\-trailer \*(AqCc: Alice <alice@example\&.com>\*(Aq \-\-trailer \*(AqReviewed\-by: Bob <bob@example\&.com>\*(Aq 0001\-foo\&.patch >0001\-bar\&.patch
433 .if n \{\
439 .RS 4
440 .ie n \{\
441 \h'-04'\(bu\h'+03'\c
443 .el \{\
444 .sp -1
445 .IP \(bu 2.3
447 Configure a
448 \fIsign\fR
449 trailer with a command to automatically add a \*(AqSigned\-off\-by: \*(Aq with the author information only if there is no \*(AqSigned\-off\-by: \*(Aq already, and show how it works:
451 .if n \{\
452 .RS 4
455 $ cat msg1\&.txt
456 subject
458 message
459 $ git config trailer\&.sign\&.key "Signed\-off\-by: "
460 $ git config trailer\&.sign\&.ifmissing add
461 $ git config trailer\&.sign\&.ifexists doNothing
462 $ git config trailer\&.sign\&.cmd \*(Aqecho "$(git config user\&.name) <$(git config user\&.email)>"\*(Aq
463 $ git interpret\-trailers \-\-trailer sign <msg1\&.txt
464 subject
466 message
468 Signed\-off\-by: Bob <bob@example\&.com>
469 $ cat msg2\&.txt
470 subject
472 message
474 Signed\-off\-by: Alice <alice@example\&.com>
475 $ git interpret\-trailers \-\-trailer sign <msg2\&.txt
476 subject
478 message
480 Signed\-off\-by: Alice <alice@example\&.com>
482 .if n \{\
488 .RS 4
489 .ie n \{\
490 \h'-04'\(bu\h'+03'\c
492 .el \{\
493 .sp -1
494 .IP \(bu 2.3
496 Configure a
497 \fIfix\fR
498 trailer with a key that contains a
499 \fI#\fR
500 and no space after this character, and show how it works:
502 .if n \{\
503 .RS 4
506 $ git config trailer\&.separators ":#"
507 $ git config trailer\&.fix\&.key "Fix #"
508 $ echo "subject" | git interpret\-trailers \-\-trailer fix=42
509 subject
511 Fix #42
513 .if n \{\
519 .RS 4
520 .ie n \{\
521 \h'-04'\(bu\h'+03'\c
523 .el \{\
524 .sp -1
525 .IP \(bu 2.3
527 Configure a
528 \fIhelp\fR
529 trailer with a cmd use a script
530 \fBglog\-find\-author\fR
531 which search specified author identity from git log in git repository and show how it works:
533 .if n \{\
534 .RS 4
537 $ cat ~/bin/glog\-find\-author
538 #!/bin/sh
539 test \-n "$1" && git log \-\-author="$1" \-\-pretty="%an <%ae>" \-1 || true
540 $ cat msg\&.txt
541 subject
543 message
544 $ git config trailer\&.help\&.key "Helped\-by: "
545 $ git config trailer\&.help\&.ifExists "addIfDifferentNeighbor"
546 $ git config trailer\&.help\&.cmd "~/bin/glog\-find\-author"
547 $ git interpret\-trailers \-\-trailer="help:Junio" \-\-trailer="help:Couder" <msg\&.txt
548 subject
550 message
552 Helped\-by: Junio C Hamano <gitster@pobox\&.com>
553 Helped\-by: Christian Couder <christian\&.couder@gmail\&.com>
555 .if n \{\
561 .RS 4
562 .ie n \{\
563 \h'-04'\(bu\h'+03'\c
565 .el \{\
566 .sp -1
567 .IP \(bu 2.3
569 Configure a
570 \fIref\fR
571 trailer with a cmd use a script
572 \fBglog\-grep\fR
573 to grep last relevant commit from git log in the git repository and show how it works:
575 .if n \{\
576 .RS 4
579 $ cat ~/bin/glog\-grep
580 #!/bin/sh
581 test \-n "$1" && git log \-\-grep "$1" \-\-pretty=reference \-1 || true
582 $ cat msg\&.txt
583 subject
585 message
586 $ git config trailer\&.ref\&.key "Reference\-to: "
587 $ git config trailer\&.ref\&.ifExists "replace"
588 $ git config trailer\&.ref\&.cmd "~/bin/glog\-grep"
589 $ git interpret\-trailers \-\-trailer="ref:Add copyright notices\&." <msg\&.txt
590 subject
592 message
594 Reference\-to: 8bc9a0c769 (Add copyright notices\&., 2005\-04\-07)
596 .if n \{\
602 .RS 4
603 .ie n \{\
604 \h'-04'\(bu\h'+03'\c
606 .el \{\
607 .sp -1
608 .IP \(bu 2.3
610 Configure a
611 \fIsee\fR
612 trailer with a command to show the subject of a commit that is related, and show how it works:
614 .if n \{\
615 .RS 4
618 $ cat msg\&.txt
619 subject
621 message
623 see: HEAD~2
624 $ cat ~/bin/glog\-ref
625 #!/bin/sh
626 git log \-1 \-\-oneline \-\-format="%h (%s)" \-\-abbrev\-commit \-\-abbrev=14
627 $ git config trailer\&.see\&.key "See\-also: "
628 $ git config trailer\&.see\&.ifExists "replace"
629 $ git config trailer\&.see\&.ifMissing "doNothing"
630 $ git config trailer\&.see\&.cmd "glog\-ref"
631 $ git interpret\-trailers \-\-trailer=see <msg\&.txt
632 subject
634 message
636 See\-also: fe3187489d69c4 (subject of related commit)
638 .if n \{\
644 .RS 4
645 .ie n \{\
646 \h'-04'\(bu\h'+03'\c
648 .el \{\
649 .sp -1
650 .IP \(bu 2.3
652 Configure a commit template with some trailers with empty values (using sed to show and keep the trailing spaces at the end of the trailers), then configure a commit\-msg hook that uses
653 \fIgit interpret\-trailers\fR
654 to remove trailers with empty values and to add a
655 \fIgit\-version\fR
656 trailer:
658 .if n \{\
659 .RS 4
662 $ cat temp\&.txt
663 ***subject***
665 ***message***
667 Fixes: Z
668 Cc: Z
669 Reviewed\-by: Z
670 Signed\-off\-by: Z
671 $ sed \-e \*(Aqs/ Z$/ /\*(Aq temp\&.txt > commit_template\&.txt
672 $ git config commit\&.template commit_template\&.txt
673 $ cat \&.git/hooks/commit\-msg
674 #!/bin/sh
675 git interpret\-trailers \-\-trim\-empty \-\-trailer "git\-version: \e$(git describe)" "\e$1" > "\e$1\&.new"
676 mv "\e$1\&.new" "\e$1"
677 $ chmod +x \&.git/hooks/commit\-msg
679 .if n \{\
684 .SH "SEE ALSO"
686 \fBgit-commit\fR(1), \fBgit-format-patch\fR(1), \fBgit-config\fR(1)
687 .SH "GIT"
689 Part of the \fBgit\fR(1) suite