2014-10-13 18:16:33 +00:00
|
|
|
git-interpret-trailers(1)
|
|
|
|
=========================
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2019-03-27 09:16:28 +00:00
|
|
|
git-interpret-trailers - Add or parse structured information in commit messages
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
[verse]
|
2022-10-13 15:39:18 +00:00
|
|
|
'git interpret-trailers' [--in-place] [--trim-empty]
|
2023-09-07 22:20:09 +00:00
|
|
|
[(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]
|
2022-10-13 15:39:18 +00:00
|
|
|
[--parse] [<file>...]
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2023-06-15 02:53:43 +00:00
|
|
|
Add or parse 'trailer' lines that look similar to RFC 822 e-mail
|
2014-10-13 18:16:33 +00:00
|
|
|
headers, at the end of the otherwise free-form part of a commit
|
2023-06-15 02:53:50 +00:00
|
|
|
message. For example, in the following commit message
|
|
|
|
|
|
|
|
------------------------------------------------
|
|
|
|
subject
|
|
|
|
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
|
|
|
|
|
|
|
|
Signed-off-by: Alice <alice@example.com>
|
|
|
|
Signed-off-by: Bob <bob@example.com>
|
|
|
|
------------------------------------------------
|
|
|
|
|
|
|
|
the last two lines starting with "Signed-off-by" are trailers.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-06-15 02:53:44 +00:00
|
|
|
This command reads commit messages from either the
|
|
|
|
<file> arguments or the standard input if no <file> is specified.
|
2023-09-07 22:20:05 +00:00
|
|
|
If `--parse` is specified, the output consists of the parsed trailers
|
|
|
|
coming from the input, without influencing them with any command line
|
|
|
|
options or configuration variables.
|
2023-09-07 22:20:07 +00:00
|
|
|
|
|
|
|
Otherwise, this command applies `trailer.*` 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 `--trailer=...` which could also add new trailers),
|
|
|
|
to each input file. The result is emitted on the standard output.
|
2023-06-15 02:53:44 +00:00
|
|
|
|
|
|
|
This command can also operate on the output of linkgit:git-format-patch[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
|
|
|
|
`--no-divider` is specified.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
Some configuration variables control the way the `--trailer` arguments
|
2023-06-15 02:53:44 +00:00
|
|
|
are applied to each input and the way any existing trailer in
|
|
|
|
the input is changed. They also make it possible to
|
2014-10-13 18:16:33 +00:00
|
|
|
automatically add some trailers.
|
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
By default, a '<key>=<value>' or '<key>:<value>' argument given
|
2014-10-13 18:16:33 +00:00
|
|
|
using `--trailer` will be appended after the existing trailers only if
|
2023-09-07 22:20:09 +00:00
|
|
|
the last trailer has a different (<key>, <value>) pair (or if there
|
|
|
|
is no existing trailer). The <key> and <value> parts will be trimmed
|
2014-10-13 18:16:33 +00:00
|
|
|
to remove starting and trailing whitespace, and the resulting trimmed
|
2023-09-07 22:20:09 +00:00
|
|
|
<key> and <value> will appear in the output like this:
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
------------------------------------------------
|
2023-09-07 22:20:09 +00:00
|
|
|
key: value
|
2014-10-13 18:16:33 +00:00
|
|
|
------------------------------------------------
|
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
This means that the trimmed <key> and <value> will be separated by
|
|
|
|
`': '` (one colon followed by one space).
|
|
|
|
|
|
|
|
For convenience, a <keyAlias> can be configured to make using `--trailer`
|
|
|
|
shorter to type on the command line. This can be configured using the
|
|
|
|
'trailer.<keyAlias>.key' configuration variable. The <keyAlias> must be a prefix
|
|
|
|
of the full <key> string, although case sensitivity does not matter. For
|
|
|
|
example, if you have
|
|
|
|
|
|
|
|
------------------------------------------------
|
|
|
|
trailer.sign.key "Signed-off-by: "
|
|
|
|
------------------------------------------------
|
|
|
|
|
|
|
|
in your configuration, you only need to specify `--trailer="sign: foo"`
|
|
|
|
on the command line instead of `--trailer="Signed-off-by: foo"`.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
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
|
2023-06-15 02:53:44 +00:00
|
|
|
at the end of the input. A blank line will be added before the new
|
|
|
|
trailer if there isn't one already.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-06-15 02:53:44 +00:00
|
|
|
Existing trailers are extracted from the input by looking for
|
2018-02-13 02:23:52 +00:00
|
|
|
a group of one or more lines that (i) is all trailers, or (ii) contains at
|
2016-11-21 20:47:21 +00:00
|
|
|
least one Git-generated or user-configured trailer and consists of at
|
|
|
|
least 25% trailers.
|
2016-10-21 17:55:01 +00:00
|
|
|
The group must be preceded by one or more empty (or whitespace-only) lines.
|
2023-06-15 02:53:44 +00:00
|
|
|
The group must either be at the end of the input or be the last
|
interpret-trailers: tighten check for "---" patch boundary
The interpret-trailers command accepts not only raw commit
messages, but it also can manipulate trailers in
format-patch output. That means it must find the "---"
boundary separating the commit message from the patch.
However, it does so by looking for any line starting with
"---", regardless of whether there is further content.
This is overly lax compared to the parsing done in
mailinfo.c's patchbreak(), and may cause false positives
(e.g., t/perf output tables uses dashes; if you cut and
paste them into your commit message, it fools the parser).
We could try to reuse patchbreak() here, but it actually has
several heuristics that are not of interest to us (e.g.,
matching "diff -" without a three-dash separator or even a
CVS "Index:" line). We're not interested in taking in
whatever random cruft people may send, but rather handling
git-formatted patches.
Note that the existing documentation was written in a loose
way, so technically we are changing the behavior from what
it said. But this should implement the original intent in a
more accurate way.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-08-23 00:48:21 +00:00
|
|
|
non-whitespace lines before a line that starts with '---' (followed by a
|
2023-06-15 02:53:44 +00:00
|
|
|
space or the end of the line).
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2022-08-30 10:50:46 +00:00
|
|
|
When reading trailers, there can be no whitespace before or inside the
|
2023-09-07 22:20:09 +00:00
|
|
|
<key>, but any number of regular space and tab characters are allowed
|
|
|
|
between the <key> and the separator. There can be whitespaces before,
|
2023-06-15 02:53:47 +00:00
|
|
|
inside or after the <value>. The <value> may be split over multiple lines
|
2022-08-30 10:50:46 +00:00
|
|
|
with each subsequent line starting with at least one whitespace, like
|
2023-06-15 02:53:50 +00:00
|
|
|
the "folding" in RFC 822. Example:
|
|
|
|
|
|
|
|
------------------------------------------------
|
2023-09-07 22:20:09 +00:00
|
|
|
key: This is a very long value, with spaces and
|
2023-06-15 02:53:50 +00:00
|
|
|
newlines in it.
|
|
|
|
------------------------------------------------
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-06-15 02:53:46 +00:00
|
|
|
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.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
-------
|
2016-01-14 16:57:55 +00:00
|
|
|
--in-place::
|
|
|
|
Edit the files in place.
|
|
|
|
|
2014-10-13 18:16:33 +00:00
|
|
|
--trim-empty::
|
|
|
|
If the <value> part of any trailer contains only whitespace,
|
2023-06-15 02:53:45 +00:00
|
|
|
the whole trailer will be removed from the output.
|
2015-10-07 16:46:22 +00:00
|
|
|
This applies to existing trailers as well as new trailers.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
--trailer <key>[(=|:)<value>]::
|
|
|
|
Specify a (<key>, <value>) pair that should be applied as a
|
2023-06-15 02:53:45 +00:00
|
|
|
trailer to the inputs. See the description of this
|
2014-10-13 18:16:33 +00:00
|
|
|
command.
|
|
|
|
|
2017-08-01 09:03:32 +00:00
|
|
|
--where <placement>::
|
|
|
|
--no-where::
|
|
|
|
Specify where all new trailers will be added. A setting
|
2023-09-07 22:20:00 +00:00
|
|
|
provided with '--where' overrides the `trailer.where` and any
|
2023-09-07 22:20:09 +00:00
|
|
|
applicable `trailer.<keyAlias>.where` configuration variables
|
2017-08-01 09:03:32 +00:00
|
|
|
and applies to all '--trailer' options until the next occurrence of
|
2023-09-07 22:19:59 +00:00
|
|
|
'--where' or '--no-where'. Upon encountering '--no-where', clear the
|
|
|
|
effect of any previous use of '--where', such that the relevant configuration
|
2023-09-07 22:20:01 +00:00
|
|
|
variables are no longer overridden. Possible placements are `after`,
|
2023-09-07 22:19:59 +00:00
|
|
|
`before`, `end` or `start`.
|
2017-08-01 09:03:32 +00:00
|
|
|
|
|
|
|
--if-exists <action>::
|
|
|
|
--no-if-exists::
|
|
|
|
Specify what action will be performed when there is already at
|
2023-09-07 22:20:09 +00:00
|
|
|
least one trailer with the same <key> in the input. A setting
|
2023-09-07 22:20:00 +00:00
|
|
|
provided with '--if-exists' overrides the `trailer.ifExists` and any
|
2023-09-07 22:20:09 +00:00
|
|
|
applicable `trailer.<keyAlias>.ifExists` configuration variables
|
2017-08-01 09:03:32 +00:00
|
|
|
and applies to all '--trailer' options until the next occurrence of
|
2023-09-07 22:19:59 +00:00
|
|
|
'--if-exists' or '--no-if-exists'. Upon encountering '--no-if-exists, clear the
|
|
|
|
effect of any previous use of '--if-exists, such that the relevant configuration
|
|
|
|
variables are no longer overridden. Possible actions are `addIfDifferent`,
|
2018-07-20 21:53:49 +00:00
|
|
|
`addIfDifferentNeighbor`, `add`, `replace` and `doNothing`.
|
2017-08-01 09:03:32 +00:00
|
|
|
|
|
|
|
--if-missing <action>::
|
|
|
|
--no-if-missing::
|
|
|
|
Specify what action will be performed when there is no other
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer with the same <key> in the input. A setting
|
2023-09-07 22:20:00 +00:00
|
|
|
provided with '--if-missing' overrides the `trailer.ifMissing` and any
|
2023-09-07 22:20:09 +00:00
|
|
|
applicable `trailer.<keyAlias>.ifMissing` configuration variables
|
2017-08-01 09:03:32 +00:00
|
|
|
and applies to all '--trailer' options until the next occurrence of
|
2023-09-07 22:19:59 +00:00
|
|
|
'--if-missing' or '--no-if-missing'. Upon encountering '--no-if-missing,
|
|
|
|
clear the effect of any previous use of '--if-missing, such that the relevant
|
|
|
|
configuration variables are no longer overridden. Possible actions are `doNothing`
|
2018-07-20 21:53:49 +00:00
|
|
|
or `add`.
|
2017-08-01 09:03:32 +00:00
|
|
|
|
2017-08-15 10:23:21 +00:00
|
|
|
--only-trailers::
|
|
|
|
Output only the trailers, not any other parts of the input.
|
|
|
|
|
2017-08-15 10:23:25 +00:00
|
|
|
--only-input::
|
|
|
|
Output only trailers that exist in the input; do not add any
|
2023-09-07 22:20:04 +00:00
|
|
|
from the command-line or by applying `trailer.*` configuration
|
|
|
|
variables.
|
2017-08-15 10:23:25 +00:00
|
|
|
|
2017-08-15 10:23:29 +00:00
|
|
|
--unfold::
|
2023-09-07 22:20:06 +00:00
|
|
|
If a trailer has a value that runs over multiple lines (aka "folded"),
|
|
|
|
reformat the value into a single line.
|
2017-08-15 10:23:29 +00:00
|
|
|
|
2017-08-15 10:23:34 +00:00
|
|
|
--parse::
|
|
|
|
A convenience alias for `--only-trailers --only-input
|
2023-09-07 22:20:05 +00:00
|
|
|
--unfold`. 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.
|
2017-08-15 10:23:34 +00:00
|
|
|
|
2018-08-23 00:49:56 +00:00
|
|
|
--no-divider::
|
|
|
|
Do not treat `---` 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 `git format-patch`).
|
|
|
|
|
2014-10-13 18:16:33 +00:00
|
|
|
CONFIGURATION VARIABLES
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
trailer.separators::
|
|
|
|
This option tells which characters are recognized as trailer
|
|
|
|
separators. By default only ':' is recognized as a trailer
|
|
|
|
separator, except that '=' is always accepted on the command
|
|
|
|
line for compatibility with other git commands.
|
|
|
|
+
|
|
|
|
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.
|
|
|
|
+
|
|
|
|
For example, if the value for this option is "%=$", then only lines
|
2023-09-07 22:20:09 +00:00
|
|
|
using the format '<key><sep><value>' with <sep> containing '%', '='
|
2014-10-13 18:16:33 +00:00
|
|
|
or '$' and then spaces will be considered trailers. And '%' will be
|
|
|
|
the default separator used, so by default trailers will appear like:
|
2023-09-07 22:20:09 +00:00
|
|
|
'<key>% <value>' (one percent sign and one space will appear between
|
|
|
|
the key and the value).
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
trailer.where::
|
|
|
|
This option tells where a new trailer will be added.
|
|
|
|
+
|
|
|
|
This can be `end`, which is the default, `start`, `after` or `before`.
|
|
|
|
+
|
|
|
|
If it is `end`, then each new trailer will appear at the end of the
|
|
|
|
existing trailers.
|
|
|
|
+
|
|
|
|
If it is `start`, then each new trailer will appear at the start,
|
|
|
|
instead of the end, of the existing trailers.
|
|
|
|
+
|
|
|
|
If it is `after`, then each new trailer will appear just after the
|
2023-09-07 22:20:09 +00:00
|
|
|
last trailer with the same <key>.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
|
|
|
If it is `before`, then each new trailer will appear just before the
|
2023-09-07 22:20:09 +00:00
|
|
|
first trailer with the same <key>.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
trailer.ifexists::
|
|
|
|
This option makes it possible to choose what action will be
|
|
|
|
performed when there is already at least one trailer with the
|
2023-09-07 22:20:09 +00:00
|
|
|
same <key> in the input.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
|
|
|
The valid values for this option are: `addIfDifferentNeighbor` (this
|
2017-05-22 19:45:33 +00:00
|
|
|
is the default), `addIfDifferent`, `add`, `replace` or `doNothing`.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
|
|
|
With `addIfDifferentNeighbor`, a new trailer will be added only if no
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer with the same (<key>, <value>) pair is above or below the line
|
2014-10-13 18:16:33 +00:00
|
|
|
where the new trailer will be added.
|
|
|
|
+
|
|
|
|
With `addIfDifferent`, a new trailer will be added only if no trailer
|
2023-09-07 22:20:09 +00:00
|
|
|
with the same (<key>, <value>) pair is already in the input.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
|
|
|
With `add`, a new trailer will be added, even if some trailers with
|
2023-09-07 22:20:09 +00:00
|
|
|
the same (<key>, <value>) pair are already in the input.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
2023-09-07 22:20:09 +00:00
|
|
|
With `replace`, an existing trailer with the same <key> will be
|
2014-10-13 18:16:33 +00:00
|
|
|
deleted and the new trailer will be added. The deleted trailer will be
|
2023-09-07 22:20:09 +00:00
|
|
|
the closest one (with the same <key>) to the place where the new one
|
2014-10-13 18:16:33 +00:00
|
|
|
will be added.
|
|
|
|
+
|
|
|
|
With `doNothing`, nothing will be done; that is no new trailer will be
|
2023-09-07 22:20:09 +00:00
|
|
|
added if there is already one with the same <key> in the input.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
trailer.ifmissing::
|
|
|
|
This option makes it possible to choose what action will be
|
|
|
|
performed when there is not yet any trailer with the same
|
2023-09-07 22:20:09 +00:00
|
|
|
<key> in the input.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
|
|
|
The valid values for this option are: `add` (this is the default) and
|
|
|
|
`doNothing`.
|
|
|
|
+
|
|
|
|
With `add`, a new trailer will be added.
|
|
|
|
+
|
|
|
|
With `doNothing`, nothing will be done.
|
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer.<keyAlias>.key::
|
|
|
|
Defines a <keyAlias> for the <key>. The <keyAlias> must be a
|
|
|
|
prefix (case does not matter) of the <key>. For example, in `git
|
|
|
|
config trailer.ack.key "Acked-by"` the "Acked-by" is the <key> and
|
|
|
|
the "ack" is the <keyAlias>. This configuration allows the shorter
|
|
|
|
`--trailer "ack:..."` invocation on the command line using the "ack"
|
|
|
|
<keyAlias> instead of the longer `--trailer "Acked-by:..."`.
|
|
|
|
+
|
|
|
|
At the end of the <key>, a separator can appear and then some
|
|
|
|
space characters. By default the only valid separator is ':',
|
|
|
|
but this can be changed using the `trailer.separators` config
|
|
|
|
variable.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
2023-09-07 22:20:08 +00:00
|
|
|
If there is a separator in the key, then it overrides the default
|
|
|
|
separator when adding the trailer.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer.<keyAlias>.where::
|
2014-10-13 18:16:33 +00:00
|
|
|
This option takes the same values as the 'trailer.where'
|
|
|
|
configuration variable and it overrides what is specified by
|
2023-09-07 22:20:09 +00:00
|
|
|
that option for trailers with the specified <keyAlias>.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer.<keyAlias>.ifexists::
|
2017-08-01 09:03:33 +00:00
|
|
|
This option takes the same values as the 'trailer.ifexists'
|
2014-10-13 18:16:33 +00:00
|
|
|
configuration variable and it overrides what is specified by
|
2023-09-07 22:20:09 +00:00
|
|
|
that option for trailers with the specified <keyAlias>.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer.<keyAlias>.ifmissing::
|
2014-10-13 18:16:33 +00:00
|
|
|
This option takes the same values as the 'trailer.ifmissing'
|
|
|
|
configuration variable and it overrides what is specified by
|
2023-09-07 22:20:09 +00:00
|
|
|
that option for trailers with the specified <keyAlias>.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer.<keyAlias>.command::
|
|
|
|
Deprecated in favor of 'trailer.<keyAlias>.cmd'.
|
|
|
|
This option behaves in the same way as 'trailer.<keyAlias>.cmd', except
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
that it doesn't pass anything as argument to the specified command.
|
|
|
|
Instead the first occurrence of substring $ARG is replaced by the
|
2023-06-15 02:53:47 +00:00
|
|
|
<value> that would be passed as argument.
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
+
|
2023-06-15 02:53:48 +00:00
|
|
|
Note that $ARG in the user's command is
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
only replaced once and that the original way of replacing $ARG is not safe.
|
|
|
|
+
|
2023-09-07 22:20:09 +00:00
|
|
|
When both 'trailer.<keyAlias>.cmd' and 'trailer.<keyAlias>.command' are given
|
|
|
|
for the same <keyAlias>, 'trailer.<keyAlias>.cmd' is used and
|
|
|
|
'trailer.<keyAlias>.command' is ignored.
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
|
2023-09-07 22:20:09 +00:00
|
|
|
trailer.<keyAlias>.cmd::
|
2023-06-15 02:53:42 +00:00
|
|
|
This option can be used to specify a shell command that will be called
|
2023-09-07 22:20:09 +00:00
|
|
|
once to automatically add a trailer with the specified <keyAlias>, and then
|
|
|
|
called each time a '--trailer <keyAlias>=<value>' argument is specified to
|
2023-06-15 02:53:42 +00:00
|
|
|
modify the <value> of the trailer that this option would produce.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
2021-05-03 15:41:04 +00:00
|
|
|
When the specified command is first called to add a trailer
|
2023-09-07 22:20:09 +00:00
|
|
|
with the specified <keyAlias>, the behavior is as if a special
|
|
|
|
'--trailer <keyAlias>=<value>' argument was added at the beginning
|
2021-05-03 15:41:04 +00:00
|
|
|
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.
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
2023-09-07 22:20:09 +00:00
|
|
|
If some '--trailer <keyAlias>=<value>' arguments are also passed
|
2021-05-03 15:41:04 +00:00
|
|
|
on the command line, the command is called again once for each
|
2023-09-07 22:20:09 +00:00
|
|
|
of these arguments with the same <keyAlias>. And the <value> part
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
of these arguments, if any, will be passed to the command as its
|
|
|
|
first argument. This way the command can produce a <value> computed
|
2023-09-07 22:20:09 +00:00
|
|
|
from the <value> passed in the '--trailer <keyAlias>=<value>' argument.
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
--------
|
|
|
|
|
|
|
|
* Configure a 'sign' trailer with a 'Signed-off-by' key, and then
|
2023-06-15 02:53:45 +00:00
|
|
|
add two of these trailers to a commit message file:
|
2014-10-13 18:16:33 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git config trailer.sign.key "Signed-off-by"
|
|
|
|
$ cat msg.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2023-05-01 20:02:39 +00:00
|
|
|
$ git interpret-trailers --trailer 'sign: Alice <alice@example.com>' --trailer 'sign: Bob <bob@example.com>' <msg.txt
|
2014-10-13 18:16:33 +00:00
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
Signed-off-by: Alice <alice@example.com>
|
|
|
|
Signed-off-by: Bob <bob@example.com>
|
|
|
|
------------
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
* Use the `--in-place` option to edit a commit message file in place:
|
2016-01-14 16:57:55 +00:00
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ cat msg.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2016-01-14 16:57:55 +00:00
|
|
|
|
|
|
|
Signed-off-by: Bob <bob@example.com>
|
|
|
|
$ git interpret-trailers --trailer 'Acked-by: Alice <alice@example.com>' --in-place msg.txt
|
|
|
|
$ cat msg.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2016-01-14 16:57:55 +00:00
|
|
|
|
|
|
|
Signed-off-by: Bob <bob@example.com>
|
|
|
|
Acked-by: Alice <alice@example.com>
|
|
|
|
------------
|
|
|
|
|
2014-10-13 18:16:33 +00:00
|
|
|
* Extract the last commit as a patch, and add a 'Cc' and a
|
|
|
|
'Reviewed-by' trailer to it:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git format-patch -1
|
|
|
|
0001-foo.patch
|
|
|
|
$ git interpret-trailers --trailer 'Cc: Alice <alice@example.com>' --trailer 'Reviewed-by: Bob <bob@example.com>' 0001-foo.patch >0001-bar.patch
|
|
|
|
------------
|
|
|
|
|
|
|
|
* Configure a 'sign' trailer with a command to automatically add a
|
|
|
|
'Signed-off-by: ' with the author information only if there is no
|
|
|
|
'Signed-off-by: ' already, and show how it works:
|
|
|
|
+
|
|
|
|
------------
|
2023-05-01 20:02:41 +00:00
|
|
|
$ cat msg1.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2014-10-13 18:16:33 +00:00
|
|
|
$ git config trailer.sign.key "Signed-off-by: "
|
|
|
|
$ git config trailer.sign.ifmissing add
|
|
|
|
$ git config trailer.sign.ifexists doNothing
|
2023-05-01 20:02:40 +00:00
|
|
|
$ git config trailer.sign.cmd 'echo "$(git config user.name) <$(git config user.email)>"'
|
2023-05-01 20:02:41 +00:00
|
|
|
$ git interpret-trailers --trailer sign <msg1.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
Signed-off-by: Bob <bob@example.com>
|
2023-05-01 20:02:41 +00:00
|
|
|
$ cat msg2.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2023-05-01 20:02:41 +00:00
|
|
|
|
2023-05-01 20:02:38 +00:00
|
|
|
Signed-off-by: Alice <alice@example.com>
|
2023-05-01 20:02:41 +00:00
|
|
|
$ git interpret-trailers --trailer sign <msg2.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
Signed-off-by: Alice <alice@example.com>
|
|
|
|
------------
|
|
|
|
|
|
|
|
* Configure a 'fix' trailer with a key that contains a '#' and no
|
|
|
|
space after this character, and show how it works:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ git config trailer.separators ":#"
|
|
|
|
$ git config trailer.fix.key "Fix #"
|
|
|
|
$ echo "subject" | git interpret-trailers --trailer fix=42
|
|
|
|
subject
|
|
|
|
|
|
|
|
Fix #42
|
|
|
|
------------
|
|
|
|
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
* Configure a 'help' trailer with a cmd use a script `glog-find-author`
|
|
|
|
which search specified author identity from git log in git repository
|
|
|
|
and show how it works:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ cat ~/bin/glog-find-author
|
|
|
|
#!/bin/sh
|
|
|
|
test -n "$1" && git log --author="$1" --pretty="%an <%ae>" -1 || true
|
2023-05-01 20:02:38 +00:00
|
|
|
$ cat msg.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
$ git config trailer.help.key "Helped-by: "
|
|
|
|
$ git config trailer.help.ifExists "addIfDifferentNeighbor"
|
|
|
|
$ git config trailer.help.cmd "~/bin/glog-find-author"
|
2023-05-01 20:02:38 +00:00
|
|
|
$ git interpret-trailers --trailer="help:Junio" --trailer="help:Couder" <msg.txt
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
|
|
|
|
Helped-by: Junio C Hamano <gitster@pobox.com>
|
|
|
|
Helped-by: Christian Couder <christian.couder@gmail.com>
|
|
|
|
------------
|
|
|
|
|
|
|
|
* Configure a 'ref' trailer with a cmd use a script `glog-grep`
|
|
|
|
to grep last relevant commit from git log in the git repository
|
|
|
|
and show how it works:
|
|
|
|
+
|
|
|
|
------------
|
|
|
|
$ cat ~/bin/glog-grep
|
|
|
|
#!/bin/sh
|
|
|
|
test -n "$1" && git log --grep "$1" --pretty=reference -1 || true
|
2023-05-01 20:02:38 +00:00
|
|
|
$ cat msg.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
$ git config trailer.ref.key "Reference-to: "
|
|
|
|
$ git config trailer.ref.ifExists "replace"
|
|
|
|
$ git config trailer.ref.cmd "~/bin/glog-grep"
|
2023-05-01 20:02:38 +00:00
|
|
|
$ git interpret-trailers --trailer="ref:Add copyright notices." <msg.txt
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
trailer: add new .cmd config option
The `trailer.<token>.command` configuration variable
specifies a command (run via the shell, so it does not have
to be a single name or path to the command, but can be a
shell script), and the first occurrence of substring $ARG is
replaced with the value given to the `interpret-trailer`
command for the token in a '--trailer <token>=<value>' argument.
This has three downsides:
* The use of $ARG in the mechanism misleads the users that
the value is passed in the shell variable, and tempt them
to use $ARG more than once, but that would not work, as
the second and subsequent $ARG are not replaced.
* Because $ARG is textually replaced without regard to the
shell language syntax, even '$ARG' (inside a single-quote
pair), which a user would expect to stay intact, would be
replaced, and worse, if the value had an unmatched single
quote (imagine a name like "O'Connor", substituted into
NAME='$ARG' to make it NAME='O'Connor'), it would result in
a broken command that is not syntactically correct (or
worse).
* The first occurrence of substring `$ARG` will be replaced
with the empty string, in the command when the command is
first called to add a trailer with the specified <token>.
This is a bad design, the nature of automatic execution
causes it to add a trailer that we don't expect.
Introduce a new `trailer.<token>.cmd` configuration that
takes higher precedence to deprecate and eventually remove
`trailer.<token>.command`, which passes the value as an
argument to the command. Instead of "$ARG", users can
refer to the value as positional argument, $1, in their
scripts. At the same time, in order to allow
`git interpret-trailers` to better simulate the behavior
of `git command -s`, 'trailer.<token>.cmd' will not
automatically execute.
Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <christian.couder@gmail.com>
Signed-off-by: ZheNing Hu <adlternative@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-03 15:41:05 +00:00
|
|
|
|
|
|
|
Reference-to: 8bc9a0c769 (Add copyright notices., 2005-04-07)
|
|
|
|
------------
|
|
|
|
|
2014-10-13 18:16:33 +00:00
|
|
|
* Configure a 'see' trailer with a command to show the subject of a
|
|
|
|
commit that is related, and show how it works:
|
|
|
|
+
|
|
|
|
------------
|
2023-05-01 20:02:38 +00:00
|
|
|
$ cat msg.txt
|
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2023-05-01 20:02:38 +00:00
|
|
|
|
|
|
|
see: HEAD~2
|
2023-05-01 20:02:40 +00:00
|
|
|
$ cat ~/bin/glog-ref
|
|
|
|
#!/bin/sh
|
|
|
|
git log -1 --oneline --format="%h (%s)" --abbrev-commit --abbrev=14
|
2014-10-13 18:16:33 +00:00
|
|
|
$ git config trailer.see.key "See-also: "
|
|
|
|
$ git config trailer.see.ifExists "replace"
|
|
|
|
$ git config trailer.see.ifMissing "doNothing"
|
2023-05-01 20:02:40 +00:00
|
|
|
$ git config trailer.see.cmd "glog-ref"
|
|
|
|
$ git interpret-trailers --trailer=see <msg.txt
|
2014-10-13 18:16:33 +00:00
|
|
|
subject
|
|
|
|
|
2023-06-15 02:53:45 +00:00
|
|
|
body text
|
2014-10-13 18:16:33 +00:00
|
|
|
|
|
|
|
See-also: fe3187489d69c4 (subject of related commit)
|
|
|
|
------------
|
|
|
|
|
|
|
|
* 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
|
|
|
|
'git interpret-trailers' to remove trailers with empty values and
|
|
|
|
to add a 'git-version' trailer:
|
|
|
|
+
|
|
|
|
------------
|
2023-05-01 20:02:38 +00:00
|
|
|
$ cat temp.txt
|
|
|
|
***subject***
|
|
|
|
|
|
|
|
***message***
|
|
|
|
|
|
|
|
Fixes: Z
|
|
|
|
Cc: Z
|
|
|
|
Reviewed-by: Z
|
|
|
|
Signed-off-by: Z
|
|
|
|
$ sed -e 's/ Z$/ /' temp.txt > commit_template.txt
|
2014-10-13 18:16:33 +00:00
|
|
|
$ git config commit.template commit_template.txt
|
2023-05-01 20:02:38 +00:00
|
|
|
$ cat .git/hooks/commit-msg
|
|
|
|
#!/bin/sh
|
|
|
|
git interpret-trailers --trim-empty --trailer "git-version: \$(git describe)" "\$1" > "\$1.new"
|
|
|
|
mv "\$1.new" "\$1"
|
2014-10-13 18:16:33 +00:00
|
|
|
$ chmod +x .git/hooks/commit-msg
|
|
|
|
------------
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
--------
|
|
|
|
linkgit:git-commit[1], linkgit:git-format-patch[1], linkgit:git-config[1]
|
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
|
|
|
Part of the linkgit:git[1] suite
|