Documentation/git-interpret-trailers.txt

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