@@ -7,14 +7,14 @@ git-interpret-trailers - Add or parse structured information in commit messages
77
88SYNOPSIS
99--------
10- [verse ]
11- ' git interpret-trailers' [-- in-place] [-- trim-empty]
10+ [synopsis ]
11+ git interpret-trailers [-- in-place] [-- trim-empty]
1212 [(-- trailer (<key >|<key-alias >)[(=|:)<value >])... ]
1313 [-- parse] [<file >... ]
1414
1515DESCRIPTION
1616-----------
17- Add or parse 'trailer' lines that look similar to RFC 822 e-mail
17+ Add or parse _trailer_ lines that look similar to RFC 822 e-mail
1818headers, at the end of the otherwise free-form part of a commit
1919message. For example, in the following commit message
2020
@@ -27,23 +27,24 @@ Signed-off-by: Alice <alice@example.com>
2727Signed-off-by: Bob <bob@example.com>
2828------------------------------------------------
2929
30- the last two lines starting with " Signed-off-by" are trailers.
30+ the last two lines starting with ` Signed-off-by` are trailers.
3131
3232This command reads commit messages from either the
33- <file > arguments or the standard input if no <file > is specified.
33+ _ <file>_ arguments or the standard input if no _ <file>_ is specified.
3434If `--parse` is specified, the output consists of the parsed trailers
3535coming from the input, without influencing them with any command line
3636options or configuration variables.
3737
38- Otherwise, this command applies `trailer.*` configuration variables
39- (which could potentially add new trailers, as well as reposition them),
40- as well as any command line arguments that can override configuration
41- variables (such as `--trailer=...` which could also add new trailers),
42- to each input file. The result is emitted on the standard output.
38+ Otherwise, this command applies `trailer.<key-alias>` configuration
39+ variables (which could potentially add new trailers, as well as
40+ reposition them), as well as any command line arguments that can
41+ override configuration variables (such as `--trailer=...` which could
42+ also add new trailers), to each input file. The result is emitted on the
43+ standard output.
4344
4445This command can also operate on the output of linkgit:git-format-patch[1],
4546which is more elaborate than a plain commit message. Namely, such output
46- includes a commit message (as above), a " --- " divider line, and a patch part.
47+ includes a commit message (as above), a ` ---` divider line, and a patch part.
4748For these inputs, the divider and patch parts are not modified by
4849this command and are emitted as is on the output, unless
4950`--no-divider` is specified.
@@ -53,24 +54,24 @@ are applied to each input and the way any existing trailer in
5354the input is changed. They also make it possible to
5455automatically add some trailers.
5556
56- By default, a ' <key>=<value>' or ' <key>:<value>' argument given
57+ By default, a ` <key>=<value>` or ` <key>:<value>` argument given
5758using `--trailer` will be appended after the existing trailers only if
58- the last trailer has a different (<key >, <value >) pair (or if there
59- is no existing trailer). The <key > and <value > parts will be trimmed
59+ the last trailer has a different (_ <key>_ , _ <value>_ ) pair (or if there
60+ is no existing trailer). The _ <key>_ and _ <value>_ parts will be trimmed
6061to remove starting and trailing whitespace, and the resulting trimmed
61- <key > and <value > will appear in the output like this:
62+ _ <key>_ and _ <value>_ will appear in the output like this:
6263
6364------------------------------------------------
6465key: value
6566------------------------------------------------
6667
67- This means that the trimmed <key > and <value > will be separated by
68- `': '` (one colon followed by one space).
68+ This means that the trimmed _ <key>_ and _ <value>_ will be separated by
69+ " `:` {nbsp} " (one colon followed by one space).
6970
70- For convenience, a <key-alias > can be configured to make using `--trailer`
71+ For convenience, a _ <key-alias>_ can be configured to make using `--trailer`
7172shorter to type on the command line. This can be configured using the
72- ' trailer.<key-alias>.key' configuration variable. The < keyAlias > must be a prefix
73- of the full <key > string, although case sensitivity does not matter. For
73+ ` trailer.<key-alias>.key` configuration variable. The _<key-alias>_ must be a prefix
74+ of the full _ <key>_ string, although case sensitivity does not matter. For
7475example, if you have
7576
7677------------------------------------------------
@@ -91,13 +92,13 @@ least one Git-generated or user-configured trailer and consists of at
9192least 25% trailers.
9293The group must be preceded by one or more empty (or whitespace-only) lines.
9394The group must either be at the end of the input or be the last
94- non-whitespace lines before a line that starts with ' ---' (followed by a
95+ non-whitespace lines before a line that starts with ` ---` (followed by a
9596space or the end of the line).
9697
9798When reading trailers, there can be no whitespace before or inside the
98- <key >, but any number of regular space and tab characters are allowed
99- between the <key > and the separator. There can be whitespaces before,
100- inside or after the <value >. The <value > may be split over multiple lines
99+ _ <key>_ , but any number of regular space and tab characters are allowed
100+ between the _ <key>_ and the separator. There can be whitespaces before,
101+ inside or after the _ <value>_ . The _ <value>_ may be split over multiple lines
101102with each subsequent line starting with at least one whitespace, like
102103the "folding" in RFC 822. Example:
103104
@@ -111,77 +112,77 @@ rules for RFC 822 headers. For example they do not follow the encoding rule.
111112
112113OPTIONS
113114-------
114- -- in-place::
115+ ` --in-place` ::
115116 Edit the files in place.
116117
117- -- trim-empty::
118- If the <value > part of any trailer contains only whitespace,
118+ ` --trim-empty` ::
119+ If the _ <value>_ part of any trailer contains only whitespace,
119120 the whole trailer will be removed from the output.
120121 This applies to existing trailers as well as new trailers.
121122
122- -- trailer <key >[(=|:)<value >]::
123- Specify a (<key >, <value >) pair that should be applied as a
123+ ` --trailer <key>[(=|:)<value>]` ::
124+ Specify a (_ <key>_ , _ <value>_ ) pair that should be applied as a
124125 trailer to the inputs. See the description of this
125126 command.
126127
127- -- where <placement >::
128- -- no-where::
128+ ` --where <placement>` ::
129+ ` --no-where` ::
129130 Specify where all new trailers will be added. A setting
130- provided with ' --where' overrides the `trailer.where` and any
131- applicable `trailer.<keyAlias >.where` configuration variables
132- and applies to all ' --trailer' options until the next occurrence of
133- ' --where' or ' --no-where' . Upon encountering ' --no-where' , clear the
134- effect of any previous use of ' --where' , such that the relevant configuration
131+ provided with ` --where` overrides the `trailer.where` and any
132+ applicable `trailer.<key-alias >.where` configuration variables
133+ and applies to all ` --trailer` options until the next occurrence of
134+ ` --where` or ` --no-where` . Upon encountering ` --no-where` , clear the
135+ effect of any previous use of ` --where` , such that the relevant configuration
135136 variables are no longer overridden. Possible placements are `after` ,
136137 `before` , `end` or `start` .
137138
138- -- if-exists <action >::
139- -- no-if-exists::
139+ ` --if-exists <action>` ::
140+ ` --no-if-exists` ::
140141 Specify what action will be performed when there is already at
141- least one trailer with the same <key > in the input. A setting
142- provided with ' --if-exists' overrides the `trailer.ifExists` and any
143- applicable `trailer.<keyAlias >.ifExists` configuration variables
144- and applies to all ' --trailer' options until the next occurrence of
145- ' --if-exists' or ' --no-if-exists' . Upon encountering ' --no-if-exists' , clear the
146- effect of any previous use of ' --if-exists' , such that the relevant configuration
142+ least one trailer with the same _ <key>_ in the input. A setting
143+ provided with ` --if-exists` overrides the `trailer.ifExists` and any
144+ applicable `trailer.<key-alias >.ifExists` configuration variables
145+ and applies to all ` --trailer` options until the next occurrence of
146+ ` --if-exists` or ` --no-if-exists` . Upon encountering ` --no-if-exists` , clear the
147+ effect of any previous use of ` --if-exists` , such that the relevant configuration
147148 variables are no longer overridden. Possible actions are `addIfDifferent` ,
148149 `addIfDifferentNeighbor` , `add` , `replace` and `doNothing` .
149150
150- -- if-missing <action >::
151- -- no-if-missing::
151+ ` --if-missing <action>` ::
152+ ` --no-if-missing` ::
152153 Specify what action will be performed when there is no other
153- trailer with the same <key > in the input. A setting
154- provided with ' --if-missing' overrides the `trailer.ifMissing` and any
155- applicable `trailer.<keyAlias >.ifMissing` configuration variables
156- and applies to all ' --trailer' options until the next occurrence of
157- ' --if-missing' or ' --no-if-missing' . Upon encountering ' --no-if-missing' ,
158- clear the effect of any previous use of ' --if-missing' , such that the relevant
154+ trailer with the same _ <key>_ in the input. A setting
155+ provided with ` --if-missing` overrides the `trailer.ifMissing` and any
156+ applicable `trailer.<key-alias >.ifMissing` configuration variables
157+ and applies to all ` --trailer` options until the next occurrence of
158+ ` --if-missing` or ` --no-if-missing` . Upon encountering ` --no-if-missing` ,
159+ clear the effect of any previous use of ` --if-missing` , such that the relevant
159160 configuration variables are no longer overridden. Possible actions are `doNothing`
160161 or `add` .
161162
162- -- only-trailers::
163+ ` --only-trailers` ::
163164 Output only the trailers, not any other parts of the input.
164165
165- -- only-input::
166+ ` --only-input` ::
166167 Output only trailers that exist in the input; do not add any
167- from the command-line or by applying `trailer.* ` configuration
168+ from the command-line or by applying `trailer.<key-alias> ` configuration
168169 variables.
169170
170- -- unfold::
171+ ` --unfold` ::
171172 If a trailer has a value that runs over multiple lines (aka "folded"),
172173 reformat the value into a single line.
173174
174- -- parse::
175+ ` --parse` ::
175176 A convenience alias for `-- only-trailers -- only-input
176177 -- unfold`. This makes it easier to only see the trailers coming from the
177178 input without influencing them with any command line options or
178179 configuration variables, while also making the output machine-friendly with
179- -- unfold.
180+ ` --unfold` .
180181
181- -- no-divider::
182+ ` --no-divider` ::
182183 Do not treat `---` as the end of the commit message. Use this
183184 when you know your input contains just the commit message itself
184- (and not an email or the output of ` git format-patch` ).
185+ (and not an email or the output of linkgit: git- format-patch[1] ).
185186
186187CONFIGURATION VARIABLES
187188-----------------------
@@ -193,7 +194,7 @@ include::config/trailer.adoc[]
193194EXAMPLES
194195--------
195196
196- * Configure a ' sign' trailer with a ' Signed-off-by' key, and then
197+ * Configure a ` sign` trailer with a ` Signed-off-by` key, and then
197198 add two of these trailers to a commit message file:
198199+
199200------------
@@ -230,18 +231,18 @@ Signed-off-by: Bob <bob@example.com>
230231Acked-by: Alice <alice @example.com >
231232------------
232233
233- * Extract the last commit as a patch, and add a 'Cc' and a
234- ' Reviewed-by' trailer to it:
234+ * Extract the last commit as a patch, and add a `Cc` and a
235+ ` Reviewed-by` trailer to it:
235236+
236237------------
237238$ git format-patch -1
2382390001-foo.patch
239240$ git interpret-trailers -- trailer 'Cc: Alice <alice@example.com>' -- trailer 'Reviewed-by: Bob <bob@example.com>' 0001-foo.patch >0001-bar.patch
240241------------
241242
242- * Configure a ' sign' trailer with a command to automatically add a
243- ' Signed-off-by: ' with the author information only if there is no
244- ' Signed-off-by: ' already, and show how it works:
243+ * Configure a ` sign` trailer with a command to automatically add a
244+ " ` Signed-off-by:` {nbsp} " with the author information only if there is no
245+ " ` Signed-off-by:` {nbsp} " already, and show how it works:
245246+
246247------------
247248$ cat msg1.txt
@@ -272,7 +273,7 @@ body text
272273Signed-off-by: Alice <alice@example.com >
273274------------
274275
275- * Configure a ' fix' trailer with a key that contains a '#' and no
276+ * Configure a ` fix` trailer with a key that contains a `#` and no
276277 space after this character, and show how it works:
277278+
278279------------
@@ -284,7 +285,7 @@ subject
284285 Fix #42
285286------------
286287
287- * Configure a ' help' trailer with a cmd use a script `glog-find-author`
288+ * Configure a ` help` trailer with a cmd use a script `glog-find-author`
288289 which search specified author identity from git log in git repository
289290 and show how it works:
290291+
@@ -308,7 +309,7 @@ Helped-by: Junio C Hamano <gitster@pobox.com>
308309Helped-by: Christian Couder <christian .couder@gmail.com >
309310------------
310311
311- * Configure a ' ref' trailer with a cmd use a script `glog-grep`
312+ * Configure a ` ref` trailer with a cmd use a script `glog-grep`
312313 to grep last relevant commit from git log in the git repository
313314 and show how it works:
314315+
@@ -331,7 +332,7 @@ body text
331332Reference-to: 8bc9a0c769 (Add copyright notices., 2005-04-07)
332333------------
333334
334- * Configure a ' see' trailer with a command to show the subject of a
335+ * Configure a ` see` trailer with a command to show the subject of a
335336 commit that is related, and show how it works:
336337+
337338------------
@@ -359,8 +360,8 @@ See-also: fe3187489d69c4 (subject of related commit)
359360* Configure a commit template with some trailers with empty values
360361 (using sed to show and keep the trailing spaces at the end of the
361362 trailers), then configure a commit-msg hook that uses
362- ' git interpret-trailers' to remove trailers with empty values and
363- to add a ' git-version' trailer:
363+ git- interpret-trailers(1) to remove trailers with empty values and to
364+ add a ` git-version` trailer:
364365+
365366------------
366367$ cat temp.txt
0 commit comments