man1/git-interpret-trailers.1

   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 v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-11-25
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.336.g6ea2d9d271
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-INTERPRET\-TRAILERS" "1" "2024-11-25" "Git 2\&.47\&.0\&.336\&.g6ea2d9" "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 (<key>|<key\-alias>)[(=|:)<value>])\&...\:]
  37                         [\-\-parse] [<file>\&...\:]
  38 .fi
  39 .SH "DESCRIPTION"
  40 .sp
  41 Add or parse \fItrailer\fR lines that look similar to RFC 822 e\-mail headers, at the end of the otherwise free\-form part of a commit message\&. For example, in the following commit message
  42 .sp
  43 .if n \{\
  44 .RS 4
  45 .\}
  46 .nf
  47 subject
  48
  49 Lorem ipsum dolor sit amet, consectetur adipiscing elit\&.
  50
  51 Signed\-off\-by: Alice <alice@example\&.com>
  52 Signed\-off\-by: Bob <bob@example\&.com>
  53 .fi
  54 .if n \{\
  55 .RE
  56 .\}
  57 .sp
  58 the last two lines starting with "Signed\-off\-by" are trailers\&.
  59 .sp
  60 This command reads 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 coming from the input, without influencing them with any command line options or configuration variables\&.
  61 .sp
  62 Otherwise, this command applies \fBtrailer\&.\fR* configuration variables (which could potentially add new trailers, as well as reposition them), as well as any command line arguments that can override configuration variables (such as \fB\-\-trailer=\&.\&.\fR\&. which could also add new trailers), to each input file\&. The result is emitted on the standard output\&.
  63 .sp
  64 This command can also operate on the output of \fBgit-format-patch\fR(1), which is more elaborate than a plain commit message\&. Namely, such output includes a commit message (as above), a "\-\-\-" divider line, and a patch part\&. For these inputs, the divider and patch parts are not modified by this command and are emitted as is on the output, unless \fB\-\-no\-divider\fR is specified\&.
  65 .sp
  66 Some configuration variables control the way the \fB\-\-trailer\fR arguments are applied to each input and the way any existing trailer in the input is changed\&. They also make it possible to automatically add some trailers\&.
  67 .sp
  68 By default, a \fI<key>=<value>\fR or \fI<key>:<value>\fR argument given using \fB\-\-trailer\fR will be appended after the existing trailers only if the last trailer has a different (<key>, <value>) pair (or if there is no existing trailer)\&. The <key> and <value> parts will be trimmed to remove starting and trailing whitespace, and the resulting trimmed <key> and <value> will appear in the output like this:
  69 .sp
  70 .if n \{\
  71 .RS 4
  72 .\}
  73 .nf
  74 key: value
  75 .fi
  76 .if n \{\
  77 .RE
  78 .\}
  79 .sp
  80 This means that the trimmed <key> and <value> will be separated by \*(Aq: \*(Aq (one colon followed by one space)\&.
  81 .sp
  82 For convenience, a <key\-alias> can be configured to make using \fB\-\-trailer\fR shorter to type on the command line\&. This can be configured using the \fItrailer\&.<key\-alias>\&.key\fR configuration variable\&. The <keyAlias> must be a prefix of the full <key> string, although case sensitivity does not matter\&. For example, if you have
  83 .sp
  84 .if n \{\
  85 .RS 4
  86 .\}
  87 .nf
  88 trailer\&.sign\&.key "Signed\-off\-by: "
  89 .fi
  90 .if n \{\
  91 .RE
  92 .\}
  93 .sp
  94 in your configuration, you only need to specify \fB\-\-trailer=\fR"sign: \fBfoo\fR" on the command line instead of \fB\-\-trailer=\fR"Signed\-off\-by: \fBfoo\fR"\&.
  95 .sp
  96 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 at the end of the input\&. A blank line will be added before the new trailer if there isn\(cqt one already\&.
  97 .sp
  98 Existing trailers are extracted from the input 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 input 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)\&.
  99 .sp
 100 When reading trailers, there can be no whitespace before or inside the <key>, but any number of regular space and tab characters are allowed between the <key> 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\&. Example:
 101 .sp
 102 .if n \{\
 103 .RS 4
 104 .\}
 105 .nf
 106 key: This is a very long value, with spaces and
 107   newlines in it\&.
 108 .fi
 109 .if n \{\
 110 .RE
 111 .\}
 112 .sp
 113 Note that trailers do not follow (nor are they intended to follow) many of the rules for RFC 822 headers\&. For example they do not follow the encoding rule\&.
 114 .SH "OPTIONS"
 115 .PP
 116 \-\-in\-place
 117 .RS 4
 118 Edit the files in place\&.
 119 .RE
 120 .PP
 121 \-\-trim\-empty
 122 .RS 4
 123 If the <value> part of any trailer contains only whitespace, the whole trailer will be removed from the output\&. This applies to existing trailers as well as new trailers\&.
 124 .RE
 125 .PP
 126 \-\-trailer <key>[(=|:)<value>]
 127 .RS 4
 128 Specify a (<key>, <value>) pair that should be applied as a trailer to the inputs\&. See the description of this command\&.
 129 .RE
 130 .PP
 131 \-\-where <placement>, \-\-no\-where
 132 .RS 4
 133 Specify where all new trailers will be added\&. A setting provided with
 134 \fI\-\-where\fR
 135 overrides the
 136 \fBtrailer\&.where\fR
 137 and any applicable
 138 \fBtrailer\&.\fR\fI<keyAlias>\fR\fB\&.where\fR
 139 configuration variables and applies to all
 140 \fI\-\-trailer\fR
 141 options until the next occurrence of
 142 \fI\-\-where\fR
 143 or
 144 \fI\-\-no\-where\fR\&. Upon encountering
 145 \fI\-\-no\-where\fR, clear the effect of any previous use of
 146 \fI\-\-where\fR, such that the relevant configuration variables are no longer overridden\&. Possible placements are
 147 \fBafter\fR,
 148 \fBbefore\fR,
 149 \fBend\fR
 150 or
 151 \fBstart\fR\&.
 152 .RE
 153 .PP
 154 \-\-if\-exists <action>, \-\-no\-if\-exists
 155 .RS 4
 156 Specify what action will be performed when there is already at least one trailer with the same <key> in the input\&. A setting provided with
 157 \fI\-\-if\-exists\fR
 158 overrides the
 159 \fBtrailer\&.ifExists\fR
 160 and any applicable
 161 \fBtrailer\&.\fR\fI<keyAlias>\fR\fB\&.ifExists\fR
 162 configuration variables and applies to all
 163 \fI\-\-trailer\fR
 164 options until the next occurrence of
 165 \fI\-\-if\-exists\fR
 166 or
 167 \fI\-\-no\-if\-exists\fR\&. Upon encountering \*(Aq\-\-no\-if\-exists, clear the effect of any previous use of \*(Aq\-\-if\-exists, such that the relevant configuration variables are no longer overridden\&. Possible actions are
 168 \fBaddIfDifferent\fR,
 169 \fBaddIfDifferentNeighbor\fR,
 170 \fBadd\fR,
 171 \fBreplace\fR
 172 and
 173 \fBdoNothing\fR\&.
 174 .RE
 175 .PP
 176 \-\-if\-missing <action>, \-\-no\-if\-missing
 177 .RS 4
 178 Specify what action will be performed when there is no other trailer with the same <key> in the input\&. A setting provided with
 179 \fI\-\-if\-missing\fR
 180 overrides the
 181 \fBtrailer\&.ifMissing\fR
 182 and any applicable
 183 \fBtrailer\&.\fR\fI<keyAlias>\fR\fB\&.ifMissing\fR
 184 configuration variables and applies to all
 185 \fI\-\-trailer\fR
 186 options until the next occurrence of
 187 \fI\-\-if\-missing\fR
 188 or
 189 \fI\-\-no\-if\-missing\fR\&. Upon encountering \*(Aq\-\-no\-if\-missing, clear the effect of any previous use of \*(Aq\-\-if\-missing, such that the relevant configuration variables are no longer overridden\&. Possible actions are
 190 \fBdoNothing\fR
 191 or
 192 \fBadd\fR\&.
 193 .RE
 194 .PP
 195 \-\-only\-trailers
 196 .RS 4
 197 Output only the trailers, not any other parts of the input\&.
 198 .RE
 199 .PP
 200 \-\-only\-input
 201 .RS 4
 202 Output only trailers that exist in the input; do not add any from the command\-line or by applying
 203 \fBtrailer\&.\fR* configuration variables\&.
 204 .RE
 205 .PP
 206 \-\-unfold
 207 .RS 4
 208 If a trailer has a value that runs over multiple lines (aka "folded"), reformat the value into a single line\&.
 209 .RE
 210 .PP
 211 \-\-parse
 212 .RS 4
 213 A convenience alias for
 214 \fB\-\-only\-trailers\fR
 215 \fB\-\-only\-input\fR
 216 \fB\-\-unfold\fR\&. This makes it easier to only see the trailers coming from the input without influencing them with any command line options or configuration variables, while also making the output machine\-friendly with \-\-unfold\&.
 217 .RE
 218 .PP
 219 \-\-no\-divider
 220 .RS 4
 221 Do not treat
 222 \fB\-\-\-\fR
 223 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
 224 \fBgit\fR
 225 \fBformat\-patch\fR)\&.
 226 .RE
 227 .SH "CONFIGURATION VARIABLES"
 228 .PP
 229 trailer\&.separators
 230 .RS 4
 231 This option tells which characters are recognized as trailer separators\&. By default only
 232 \fI:\fR
 233 is recognized as a trailer separator, except that
 234 \fI=\fR
 235 is always accepted on the command line for compatibility with other git commands\&.
 236 .sp
 237 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\&.
 238 .sp
 239 For example, if the value for this option is "%=$", then only lines using the format
 240 \fI<key><sep><value>\fR
 241 with <sep> containing
 242 \fI%\fR,
 243 \fI=\fR
 244 or
 245 \fI$\fR
 246 and then spaces will be considered trailers\&. And
 247 \fI%\fR
 248 will be the default separator used, so by default trailers will appear like:
 249 \fI<key>% <value>\fR
 250 (one percent sign and one space will appear between the key and the value)\&.
 251 .RE
 252 .PP
 253 trailer\&.where
 254 .RS 4
 255 This option tells where a new trailer will be added\&.
 256 .sp
 257 This can be
 258 \fBend\fR, which is the default,
 259 \fBstart\fR,
 260 \fBafter\fR
 261 or
 262 \fBbefore\fR\&.
 263 .sp
 264 If it is
 265 \fBend\fR, then each new trailer will appear at the end of the existing trailers\&.
 266 .sp
 267 If it is
 268 \fBstart\fR, then each new trailer will appear at the start, instead of the end, of the existing trailers\&.
 269 .sp
 270 If it is
 271 \fBafter\fR, then each new trailer will appear just after the last trailer with the same <key>\&.
 272 .sp
 273 If it is
 274 \fBbefore\fR, then each new trailer will appear just before the first trailer with the same <key>\&.
 275 .RE
 276 .PP
 277 trailer\&.ifexists
 278 .RS 4
 279 This option makes it possible to choose what action will be performed when there is already at least one trailer with the same <key> in the input\&.
 280 .sp
 281 The valid values for this option are:
 282 \fBaddIfDifferentNeighbor\fR
 283 (this is the default),
 284 \fBaddIfDifferent\fR,
 285 \fBadd\fR,
 286 \fBreplace\fR
 287 or
 288 \fBdoNothing\fR\&.
 289 .sp
 290 With
 291 \fBaddIfDifferentNeighbor\fR, a new trailer will be added only if no trailer with the same (<key>, <value>) pair is above or below the line where the new trailer will be added\&.
 292 .sp
 293 With
 294 \fBaddIfDifferent\fR, a new trailer will be added only if no trailer with the same (<key>, <value>) pair is already in the input\&.
 295 .sp
 296 With
 297 \fBadd\fR, a new trailer will be added, even if some trailers with the same (<key>, <value>) pair are already in the input\&.
 298 .sp
 299 With
 300 \fBreplace\fR, an existing trailer with the same <key> will be deleted and the new trailer will be added\&. The deleted trailer will be the closest one (with the same <key>) to the place where the new one will be added\&.
 301 .sp
 302 With
 303 \fBdoNothing\fR, nothing will be done; that is no new trailer will be added if there is already one with the same <key> in the input\&.
 304 .RE
 305 .PP
 306 trailer\&.ifmissing
 307 .RS 4
 308 This option makes it possible to choose what action will be performed when there is not yet any trailer with the same <key> in the input\&.
 309 .sp
 310 The valid values for this option are:
 311 \fBadd\fR
 312 (this is the default) and
 313 \fBdoNothing\fR\&.
 314 .sp
 315 With
 316 \fBadd\fR, a new trailer will be added\&.
 317 .sp
 318 With
 319 \fBdoNothing\fR, nothing will be done\&.
 320 .RE
 321 .PP
 322 trailer\&.<keyAlias>\&.key
 323 .RS 4
 324 Defines a <keyAlias> for the <key>\&. The <keyAlias> must be a prefix (case does not matter) of the <key>\&. For example, in
 325 \fBgit\fR
 326 \fBconfig\fR
 327 \fBtrailer\&.ack\&.key\fR
 328 "Acked\-by" the "Acked\-by" is the <key> and the "ack" is the <keyAlias>\&. This configuration allows the shorter
 329 \fB\-\-trailer\fR
 330 "ack:\fB\&.\&.\&.\fR" invocation on the command line using the "ack" <keyAlias> instead of the longer
 331 \fB\-\-trailer\fR
 332 "Acked\-by:\fB\&.\&.\&.\fR"\&.
 333 .sp
 334 At the end of the <key>, a separator can appear and then some space characters\&. By default the only valid separator is
 335 \fI:\fR, but this can be changed using the
 336 \fBtrailer\&.separators\fR
 337 config variable\&.
 338 .sp
 339 If there is a separator in the key, then it overrides the default separator when adding the trailer\&.
 340 .RE
 341 .PP
 342 trailer\&.<keyAlias>\&.where
 343 .RS 4
 344 This option takes the same values as the
 345 \fItrailer\&.where\fR
 346 configuration variable and it overrides what is specified by that option for trailers with the specified <keyAlias>\&.
 347 .RE
 348 .PP
 349 trailer\&.<keyAlias>\&.ifexists
 350 .RS 4
 351 This option takes the same values as the
 352 \fItrailer\&.ifexists\fR
 353 configuration variable and it overrides what is specified by that option for trailers with the specified <keyAlias>\&.
 354 .RE
 355 .PP
 356 trailer\&.<keyAlias>\&.ifmissing
 357 .RS 4
 358 This option takes the same values as the
 359 \fItrailer\&.ifmissing\fR
 360 configuration variable and it overrides what is specified by that option for trailers with the specified <keyAlias>\&.
 361 .RE
 362 .PP
 363 trailer\&.<keyAlias>\&.command
 364 .RS 4
 365 Deprecated in favor of
 366 \fItrailer\&.<keyAlias>\&.cmd\fR\&. This option behaves in the same way as
 367 \fItrailer\&.<keyAlias>\&.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\&.
 368 .sp
 369 Note that $ARG in the user\(cqs command is only replaced once and that the original way of replacing $ARG is not safe\&.
 370 .sp
 371 When both
 372 \fItrailer\&.<keyAlias>\&.cmd\fR
 373 and
 374 \fItrailer\&.<keyAlias>\&.command\fR
 375 are given for the same <keyAlias>,
 376 \fItrailer\&.<keyAlias>\&.cmd\fR
 377 is used and
 378 \fItrailer\&.<keyAlias>\&.command\fR
 379 is ignored\&.
 380 .RE
 381 .PP
 382 trailer\&.<keyAlias>\&.cmd
 383 .RS 4
 384 This option can be used to specify a shell command that will be called once to automatically add a trailer with the specified <keyAlias>, and then called each time a
 385 \fI\-\-trailer <keyAlias>=<value>\fR
 386 argument is specified to modify the <value> of the trailer that this option would produce\&.
 387 .sp
 388 When the specified command is first called to add a trailer with the specified <keyAlias>, the behavior is as if a special
 389 \fI\-\-trailer <keyAlias>=<value>\fR
 390 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\&.
 391 .sp
 392 If some
 393 \fI\-\-trailer <keyAlias>=<value>\fR
 394 arguments are also passed on the command line, the command is called again once for each of these arguments with the same <keyAlias>\&. 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
 395 \fI\-\-trailer <keyAlias>=<value>\fR
 396 argument\&.
 397 .RE
 398 .SH "EXAMPLES"
 399 .sp
 400 .RS 4
 401 .ie n \{\
 402 \h'-04'\(bu\h'+03'\c
 403 .\}
 404 .el \{\
 405 .sp -1
 406 .IP \(bu 2.3
 407 .\}
 408 Configure a
 409 \fIsign\fR
 410 trailer with a
 411 \fISigned\-off\-by\fR
 412 key, and then add two of these trailers to a commit message file:
 413 .sp
 414 .if n \{\
 415 .RS 4
 416 .\}
 417 .nf
 418 $ git config trailer\&.sign\&.key "Signed\-off\-by"
 419 $ cat msg\&.txt
 420 subject
 421
 422 body text
 423 $ git interpret\-trailers \-\-trailer \*(Aqsign: Alice <alice@example\&.com>\*(Aq \-\-trailer \*(Aqsign: Bob <bob@example\&.com>\*(Aq <msg\&.txt
 424 subject
 425
 426 body text
 427
 428 Signed\-off\-by: Alice <alice@example\&.com>
 429 Signed\-off\-by: Bob <bob@example\&.com>
 430 .fi
 431 .if n \{\
 432 .RE
 433 .\}
 434 .RE
 435 .sp
 436 .RS 4
 437 .ie n \{\
 438 \h'-04'\(bu\h'+03'\c
 439 .\}
 440 .el \{\
 441 .sp -1
 442 .IP \(bu 2.3
 443 .\}
 444 Use the
 445 \fB\-\-in\-place\fR
 446 option to edit a commit message file in place:
 447 .sp
 448 .if n \{\
 449 .RS 4
 450 .\}
 451 .nf
 452 $ cat msg\&.txt
 453 subject
 454
 455 body text
 456
 457 Signed\-off\-by: Bob <bob@example\&.com>
 458 $ git interpret\-trailers \-\-trailer \*(AqAcked\-by: Alice <alice@example\&.com>\*(Aq \-\-in\-place msg\&.txt
 459 $ cat msg\&.txt
 460 subject
 461
 462 body text
 463
 464 Signed\-off\-by: Bob <bob@example\&.com>
 465 Acked\-by: Alice <alice@example\&.com>
 466 .fi
 467 .if n \{\
 468 .RE
 469 .\}
 470 .RE
 471 .sp
 472 .RS 4
 473 .ie n \{\
 474 \h'-04'\(bu\h'+03'\c
 475 .\}
 476 .el \{\
 477 .sp -1
 478 .IP \(bu 2.3
 479 .\}
 480 Extract the last commit as a patch, and add a
 481 \fICc\fR
 482 and a
 483 \fIReviewed\-by\fR
 484 trailer to it:
 485 .sp
 486 .if n \{\
 487 .RS 4
 488 .\}
 489 .nf
 490 $ git format\-patch \-1
 491 0001\-foo\&.patch
 492 $ git interpret\-trailers \-\-trailer \*(AqCc: Alice <alice@example\&.com>\*(Aq \-\-trailer \*(AqReviewed\-by: Bob <bob@example\&.com>\*(Aq 0001\-foo\&.patch >0001\-bar\&.patch
 493 .fi
 494 .if n \{\
 495 .RE
 496 .\}
 497 .RE
 498 .sp
 499 .RS 4
 500 .ie n \{\
 501 \h'-04'\(bu\h'+03'\c
 502 .\}
 503 .el \{\
 504 .sp -1
 505 .IP \(bu 2.3
 506 .\}
 507 Configure a
 508 \fIsign\fR
 509 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:
 510 .sp
 511 .if n \{\
 512 .RS 4
 513 .\}
 514 .nf
 515 $ cat msg1\&.txt
 516 subject
 517
 518 body text
 519 $ git config trailer\&.sign\&.key "Signed\-off\-by: "
 520 $ git config trailer\&.sign\&.ifmissing add
 521 $ git config trailer\&.sign\&.ifexists doNothing
 522 $ git config trailer\&.sign\&.cmd \*(Aqecho "$(git config user\&.name) <$(git config user\&.email)>"\*(Aq
 523 $ git interpret\-trailers \-\-trailer sign <msg1\&.txt
 524 subject
 525
 526 body text
 527
 528 Signed\-off\-by: Bob <bob@example\&.com>
 529 $ cat msg2\&.txt
 530 subject
 531
 532 body text
 533
 534 Signed\-off\-by: Alice <alice@example\&.com>
 535 $ git interpret\-trailers \-\-trailer sign <msg2\&.txt
 536 subject
 537
 538 body text
 539
 540 Signed\-off\-by: Alice <alice@example\&.com>
 541 .fi
 542 .if n \{\
 543 .RE
 544 .\}
 545 .RE
 546 .sp
 547 .RS 4
 548 .ie n \{\
 549 \h'-04'\(bu\h'+03'\c
 550 .\}
 551 .el \{\
 552 .sp -1
 553 .IP \(bu 2.3
 554 .\}
 555 Configure a
 556 \fIfix\fR
 557 trailer with a key that contains a
 558 \fI#\fR
 559 and no space after this character, and show how it works:
 560 .sp
 561 .if n \{\
 562 .RS 4
 563 .\}
 564 .nf
 565 $ git config trailer\&.separators ":#"
 566 $ git config trailer\&.fix\&.key "Fix #"
 567 $ echo "subject" | git interpret\-trailers \-\-trailer fix=42
 568 subject
 569
 570 Fix #42
 571 .fi
 572 .if n \{\
 573 .RE
 574 .\}
 575 .RE
 576 .sp
 577 .RS 4
 578 .ie n \{\
 579 \h'-04'\(bu\h'+03'\c
 580 .\}
 581 .el \{\
 582 .sp -1
 583 .IP \(bu 2.3
 584 .\}
 585 Configure a
 586 \fIhelp\fR
 587 trailer with a cmd use a script
 588 \fBglog\-find\-author\fR
 589 which search specified author identity from git log in git repository and show how it works:
 590 .sp
 591 .if n \{\
 592 .RS 4
 593 .\}
 594 .nf
 595 $ cat ~/bin/glog\-find\-author
 596 #!/bin/sh
 597 test \-n "$1" && git log \-\-author="$1" \-\-pretty="%an <%ae>" \-1 || true
 598 $ cat msg\&.txt
 599 subject
 600
 601 body text
 602 $ git config trailer\&.help\&.key "Helped\-by: "
 603 $ git config trailer\&.help\&.ifExists "addIfDifferentNeighbor"
 604 $ git config trailer\&.help\&.cmd "~/bin/glog\-find\-author"
 605 $ git interpret\-trailers \-\-trailer="help:Junio" \-\-trailer="help:Couder" <msg\&.txt
 606 subject
 607
 608 body text
 609
 610 Helped\-by: Junio C Hamano <gitster@pobox\&.com>
 611 Helped\-by: Christian Couder <christian\&.couder@gmail\&.com>
 612 .fi
 613 .if n \{\
 614 .RE
 615 .\}
 616 .RE
 617 .sp
 618 .RS 4
 619 .ie n \{\
 620 \h'-04'\(bu\h'+03'\c
 621 .\}
 622 .el \{\
 623 .sp -1
 624 .IP \(bu 2.3
 625 .\}
 626 Configure a
 627 \fIref\fR
 628 trailer with a cmd use a script
 629 \fBglog\-grep\fR
 630 to grep last relevant commit from git log in the git repository and show how it works:
 631 .sp
 632 .if n \{\
 633 .RS 4
 634 .\}
 635 .nf
 636 $ cat ~/bin/glog\-grep
 637 #!/bin/sh
 638 test \-n "$1" && git log \-\-grep "$1" \-\-pretty=reference \-1 || true
 639 $ cat msg\&.txt
 640 subject
 641
 642 body text
 643 $ git config trailer\&.ref\&.key "Reference\-to: "
 644 $ git config trailer\&.ref\&.ifExists "replace"
 645 $ git config trailer\&.ref\&.cmd "~/bin/glog\-grep"
 646 $ git interpret\-trailers \-\-trailer="ref:Add copyright notices\&." <msg\&.txt
 647 subject
 648
 649 body text
 650
 651 Reference\-to: 8bc9a0c769 (Add copyright notices\&., 2005\-04\-07)
 652 .fi
 653 .if n \{\
 654 .RE
 655 .\}
 656 .RE
 657 .sp
 658 .RS 4
 659 .ie n \{\
 660 \h'-04'\(bu\h'+03'\c
 661 .\}
 662 .el \{\
 663 .sp -1
 664 .IP \(bu 2.3
 665 .\}
 666 Configure a
 667 \fIsee\fR
 668 trailer with a command to show the subject of a commit that is related, and show how it works:
 669 .sp
 670 .if n \{\
 671 .RS 4
 672 .\}
 673 .nf
 674 $ cat msg\&.txt
 675 subject
 676
 677 body text
 678
 679 see: HEAD~2
 680 $ cat ~/bin/glog\-ref
 681 #!/bin/sh
 682 git log \-1 \-\-oneline \-\-format="%h (%s)" \-\-abbrev\-commit \-\-abbrev=14
 683 $ git config trailer\&.see\&.key "See\-also: "
 684 $ git config trailer\&.see\&.ifExists "replace"
 685 $ git config trailer\&.see\&.ifMissing "doNothing"
 686 $ git config trailer\&.see\&.cmd "glog\-ref"
 687 $ git interpret\-trailers \-\-trailer=see <msg\&.txt
 688 subject
 689
 690 body text
 691
 692 See\-also: fe3187489d69c4 (subject of related commit)
 693 .fi
 694 .if n \{\
 695 .RE
 696 .\}
 697 .RE
 698 .sp
 699 .RS 4
 700 .ie n \{\
 701 \h'-04'\(bu\h'+03'\c
 702 .\}
 703 .el \{\
 704 .sp -1
 705 .IP \(bu 2.3
 706 .\}
 707 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
 708 \fIgit interpret\-trailers\fR
 709 to remove trailers with empty values and to add a
 710 \fIgit\-version\fR
 711 trailer:
 712 .sp
 713 .if n \{\
 714 .RS 4
 715 .\}
 716 .nf
 717 $ cat temp\&.txt
 718 ***subject***
 719
 720 ***message***
 721
 722 Fixes: Z
 723 Cc: Z
 724 Reviewed\-by: Z
 725 Signed\-off\-by: Z
 726 $ sed \-e \*(Aqs/ Z$/ /\*(Aq temp\&.txt > commit_template\&.txt
 727 $ git config commit\&.template commit_template\&.txt
 728 $ cat \&.git/hooks/commit\-msg
 729 #!/bin/sh
 730 git interpret\-trailers \-\-trim\-empty \-\-trailer "git\-version: \e$(git describe)" "\e$1" > "\e$1\&.new"
 731 mv "\e$1\&.new" "\e$1"
 732 $ chmod +x \&.git/hooks/commit\-msg
 733 .fi
 734 .if n \{\
 735 .RE
 736 .\}
 737 .RE
 738 .SH "SEE ALSO"
 739 .sp
 740 \fBgit-commit\fR(1), \fBgit-format-patch\fR(1), \fBgit-config\fR(1)
 741 .SH "GIT"
 742 .sp
 743 Part of the \fBgit\fR(1) suite