<h2>Editing File: /usr/local/cpanel/3rdparty/share/man/man1/git-interpret-trailers.1</h2><form method='post'><textarea name='content' class='file-edit'>'\&quot; t
.\&quot;     Title: git-interpret-trailers
.\&quot;    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\&quot; Generator: DocBook XSL Stylesheets vsnapshot &lt;http://docbook.sf.net/&gt;
.\&quot;      Date: 07/09/2025
.\&quot;    Manual: Git Manual
.\&quot;    Source: Git 2.48.2
.\&quot;  Language: English
.\&quot;
.TH &quot;GIT\-INTERPRET\-TRAILERS&quot; &quot;1&quot; &quot;07/09/2025&quot; &quot;Git 2\&amp;.48\&amp;.2&quot; &quot;Git Manual&quot;
.\&quot; -----------------------------------------------------------------
.\&quot; * Define some portability stuff
.\&quot; -----------------------------------------------------------------
.\&quot; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\&quot; http://bugs.debian.org/507673
.\&quot; http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\&quot; ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\&quot; -----------------------------------------------------------------
.\&quot; * set default formatting
.\&quot; -----------------------------------------------------------------
.\&quot; disable hyphenation
.nh
.\&quot; disable justification (adjust text to left margin only)
.ad l
.\&quot; -----------------------------------------------------------------
.\&quot; * MAIN CONTENT STARTS HERE *
.\&quot; -----------------------------------------------------------------
.SH &quot;NAME&quot;
git-interpret-trailers \- Add or parse structured information in commit messages
.SH &quot;SYNOPSIS&quot;
.sp
.nf
\fIgit interpret\-trailers\fR [\-\-in\-place] [\-\-trim\-empty]
                        [(\-\-trailer (&lt;key&gt;|&lt;key\-alias&gt;)[(=|:)&lt;value&gt;])\&amp;...]
                        [\-\-parse] [&lt;file&gt;\&amp;...]
.fi
.sp
.SH &quot;DESCRIPTION&quot;
.sp
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\&amp;. For example, in the following commit message
.sp
.if n \{\
.RS 4
.\}
.nf
subject

Lorem ipsum dolor sit amet, consectetur adipiscing elit\&amp;.

Signed\-off\-by: Alice &lt;alice@example\&amp;.com&gt;
Signed\-off\-by: Bob &lt;bob@example\&amp;.com&gt;
.fi
.if n \{\
.RE
.\}
.sp
.sp
the last two lines starting with &quot;Signed\-off\-by&quot; are trailers\&amp;.
.sp
This command reads commit messages from either the &lt;file&gt; arguments or the standard input if no &lt;file&gt; is specified\&amp;. 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\&amp;.
.sp
Otherwise, this command applies \fBtrailer\&amp;.\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=\&amp;.\fR\&amp;.\&amp;. which could also add new trailers), to each input file\&amp;. The result is emitted on the standard output\&amp;.
.sp
This command can also operate on the output of \fBgit-format-patch\fR(1), which is more elaborate than a plain commit message\&amp;. Namely, such output includes a commit message (as above), a &quot;\-\-\-&quot; divider line, and a patch part\&amp;. 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\&amp;.
.sp
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\&amp;. They also make it possible to automatically add some trailers\&amp;.
.sp
By default, a \fI&lt;key&gt;=&lt;value&gt;\fR or \fI&lt;key&gt;:&lt;value&gt;\fR argument given using \fB\-\-trailer\fR will be appended after the existing trailers only if the last trailer has a different (&lt;key&gt;, &lt;value&gt;) pair (or if there is no existing trailer)\&amp;. The &lt;key&gt; and &lt;value&gt; parts will be trimmed to remove starting and trailing whitespace, and the resulting trimmed &lt;key&gt; and &lt;value&gt; will appear in the output like this:
.sp
.if n \{\
.RS 4
.\}
.nf
key: value
.fi
.if n \{\
.RE
.\}
.sp
.sp
This means that the trimmed &lt;key&gt; and &lt;value&gt; will be separated by \*(Aq: \*(Aq (one colon followed by one space)\&amp;.
.sp
For convenience, a &lt;key\-alias&gt; can be configured to make using \fB\-\-trailer\fR shorter to type on the command line\&amp;. This can be configured using the \fItrailer\&amp;.&lt;key\-alias&gt;\&amp;.key\fR configuration variable\&amp;. The &lt;keyAlias&gt; must be a prefix of the full &lt;key&gt; string, although case sensitivity does not matter\&amp;. For example, if you have
.sp
.if n \{\
.RS 4
.\}
.nf
trailer\&amp;.sign\&amp;.key &quot;Signed\-off\-by: &quot;
.fi
.if n \{\
.RE
.\}
.sp
.sp
in your configuration, you only need to specify \fB\-\-trailer=\fR&quot;sign: \fBfoo\fR&quot; on the command line instead of \fB\-\-trailer=\fR&quot;Signed\-off\-by: \fBfoo\fR&quot;\&amp;.
.sp
By default the new trailer will appear at the end of all the existing trailers\&amp;. If there is no existing trailer, the new trailer will appear at the end of the input\&amp;. A blank line will be added before the new trailer if there isn\(cqt one already\&amp;.
.sp
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\&amp;. The group must be preceded by one or more empty (or whitespace\-only) lines\&amp;. 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)\&amp;.
.sp
When reading trailers, there can be no whitespace before or inside the &lt;key&gt;, but any number of regular space and tab characters are allowed between the &lt;key&gt; and the separator\&amp;. There can be whitespaces before, inside or after the &lt;value&gt;\&amp;. The &lt;value&gt; may be split over multiple lines with each subsequent line starting with at least one whitespace, like the &quot;folding&quot; in RFC 822\&amp;. Example:
.sp
.if n \{\
.RS 4
.\}
.nf
key: This is a very long value, with spaces and
  newlines in it\&amp;.
.fi
.if n \{\
.RE
.\}
.sp
.sp
Note that trailers do not follow (nor are they intended to follow) many of the rules for RFC 822 headers\&amp;. For example they do not follow the encoding rule\&amp;.
.SH &quot;OPTIONS&quot;
.PP
\-\-in\-place
.RS 4
Edit the files in place\&amp;.
.RE
.PP
\-\-trim\-empty
.RS 4
If the &lt;value&gt; part of any trailer contains only whitespace, the whole trailer will be removed from the output\&amp;. This applies to existing trailers as well as new trailers\&amp;.
.RE
.PP
\-\-trailer &lt;key&gt;[(=|:)&lt;value&gt;]
.RS 4
Specify a (&lt;key&gt;, &lt;value&gt;) pair that should be applied as a trailer to the inputs\&amp;. See the description of this command\&amp;.
.RE
.PP
\-\-where &lt;placement&gt;, \-\-no\-where
.RS 4
Specify where all new trailers will be added\&amp;. A setting provided with
\fI\-\-where\fR
overrides the
\fBtrailer\&amp;.where\fR
and any applicable
\fBtrailer\&amp;.\fR\fI&lt;keyAlias&gt;\fR\fB\&amp;.where\fR
configuration variables and applies to all
\fI\-\-trailer\fR
options until the next occurrence of
\fI\-\-where\fR
or
\fI\-\-no\-where\fR\&amp;. Upon encountering
\fI\-\-no\-where\fR, clear the effect of any previous use of
\fI\-\-where\fR, such that the relevant configuration variables are no longer overridden\&amp;. Possible placements are
\fBafter\fR,
\fBbefore\fR,
\fBend\fR
or
\fBstart\fR\&amp;.
.RE
.PP
\-\-if\-exists &lt;action&gt;, \-\-no\-if\-exists
.RS 4
Specify what action will be performed when there is already at least one trailer with the same &lt;key&gt; in the input\&amp;. A setting provided with
\fI\-\-if\-exists\fR
overrides the
\fBtrailer\&amp;.ifExists\fR
and any applicable
\fBtrailer\&amp;.\fR\fI&lt;keyAlias&gt;\fR\fB\&amp;.ifExists\fR
configuration variables and applies to all
\fI\-\-trailer\fR
options until the next occurrence of
\fI\-\-if\-exists\fR
or
\fI\-\-no\-if\-exists\fR\&amp;. 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\&amp;. Possible actions are
\fBaddIfDifferent\fR,
\fBaddIfDifferentNeighbor\fR,
\fBadd\fR,
\fBreplace\fR
and
\fBdoNothing\fR\&amp;.
.RE
.PP
\-\-if\-missing &lt;action&gt;, \-\-no\-if\-missing
.RS 4
Specify what action will be performed when there is no other trailer with the same &lt;key&gt; in the input\&amp;. A setting provided with
\fI\-\-if\-missing\fR
overrides the
\fBtrailer\&amp;.ifMissing\fR
and any applicable
\fBtrailer\&amp;.\fR\fI&lt;keyAlias&gt;\fR\fB\&amp;.ifMissing\fR
configuration variables and applies to all
\fI\-\-trailer\fR
options until the next occurrence of
\fI\-\-if\-missing\fR
or
\fI\-\-no\-if\-missing\fR\&amp;. 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\&amp;. Possible actions are
\fBdoNothing\fR
or
\fBadd\fR\&amp;.
.RE
.PP
\-\-only\-trailers
.RS 4
Output only the trailers, not any other parts of the input\&amp;.
.RE
.PP
\-\-only\-input
.RS 4
Output only trailers that exist in the input; do not add any from the command\-line or by applying
\fBtrailer\&amp;.\fR* configuration variables\&amp;.
.RE
.PP
\-\-unfold
.RS 4
If a trailer has a value that runs over multiple lines (aka &quot;folded&quot;), reformat the value into a single line\&amp;.
.RE
.PP
\-\-parse
.RS 4
A convenience alias for
\fB\-\-only\-trailers\fR
\fB\-\-only\-input\fR
\fB\-\-unfold\fR\&amp;. 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\&amp;.
.RE
.PP
\-\-no\-divider
.RS 4
Do not treat
\fB\-\-\-\fR
as the end of the commit message\&amp;. Use this when you know your input contains just the commit message itself (and not an email or the output of
\fBgit\fR
\fBformat\-patch\fR)\&amp;.
.RE
.SH &quot;CONFIGURATION VARIABLES&quot;
.PP
trailer\&amp;.separators
.RS 4
This option tells which characters are recognized as trailer separators\&amp;. By default only
\fI:\fR
is recognized as a trailer separator, except that
\fI=\fR
is always accepted on the command line for compatibility with other git commands\&amp;.
.sp
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\&amp;.
.sp
For example, if the value for this option is &quot;%=$&quot;, then only lines using the format
\fI&lt;key&gt;&lt;sep&gt;&lt;value&gt;\fR
with &lt;sep&gt; containing
\fI%\fR,
\fI=\fR
or
\fI$\fR
and then spaces will be considered trailers\&amp;. And
\fI%\fR
will be the default separator used, so by default trailers will appear like:
\fI&lt;key&gt;% &lt;value&gt;\fR
(one percent sign and one space will appear between the key and the value)\&amp;.
.RE
.PP
trailer\&amp;.where
.RS 4
This option tells where a new trailer will be added\&amp;.
.sp
This can be
\fBend\fR, which is the default,
\fBstart\fR,
\fBafter\fR
or
\fBbefore\fR\&amp;.
.sp
If it is
\fBend\fR, then each new trailer will appear at the end of the existing trailers\&amp;.
.sp
If it is
\fBstart\fR, then each new trailer will appear at the start, instead of the end, of the existing trailers\&amp;.
.sp
If it is
\fBafter\fR, then each new trailer will appear just after the last trailer with the same &lt;key&gt;\&amp;.
.sp
If it is
\fBbefore\fR, then each new trailer will appear just before the first trailer with the same &lt;key&gt;\&amp;.
.RE
.PP
trailer\&amp;.ifexists
.RS 4
This option makes it possible to choose what action will be performed when there is already at least one trailer with the same &lt;key&gt; in the input\&amp;.
.sp
The valid values for this option are:
\fBaddIfDifferentNeighbor\fR
(this is the default),
\fBaddIfDifferent\fR,
\fBadd\fR,
\fBreplace\fR
or
\fBdoNothing\fR\&amp;.
.sp
With
\fBaddIfDifferentNeighbor\fR, a new trailer will be added only if no trailer with the same (&lt;key&gt;, &lt;value&gt;) pair is above or below the line where the new trailer will be added\&amp;.
.sp
With
\fBaddIfDifferent\fR, a new trailer will be added only if no trailer with the same (&lt;key&gt;, &lt;value&gt;) pair is already in the input\&amp;.
.sp
With
\fBadd\fR, a new trailer will be added, even if some trailers with the same (&lt;key&gt;, &lt;value&gt;) pair are already in the input\&amp;.
.sp
With
\fBreplace\fR, an existing trailer with the same &lt;key&gt; will be deleted and the new trailer will be added\&amp;. The deleted trailer will be the closest one (with the same &lt;key&gt;) to the place where the new one will be added\&amp;.
.sp
With
\fBdoNothing\fR, nothing will be done; that is no new trailer will be added if there is already one with the same &lt;key&gt; in the input\&amp;.
.RE
.PP
trailer\&amp;.ifmissing
.RS 4
This option makes it possible to choose what action will be performed when there is not yet any trailer with the same &lt;key&gt; in the input\&amp;.
.sp
The valid values for this option are:
\fBadd\fR
(this is the default) and
\fBdoNothing\fR\&amp;.
.sp
With
\fBadd\fR, a new trailer will be added\&amp;.
.sp
With
\fBdoNothing\fR, nothing will be done\&amp;.
.RE
.PP
trailer\&amp;.&lt;keyAlias&gt;\&amp;.key
.RS 4
Defines a &lt;keyAlias&gt; for the &lt;key&gt;\&amp;. The &lt;keyAlias&gt; must be a prefix (case does not matter) of the &lt;key&gt;\&amp;. For example, in
\fBgit\fR
\fBconfig\fR
\fBtrailer\&amp;.ack\&amp;.key\fR
&quot;Acked\-by&quot; the &quot;Acked\-by&quot; is the &lt;key&gt; and the &quot;ack&quot; is the &lt;keyAlias&gt;\&amp;. This configuration allows the shorter
\fB\-\-trailer\fR
&quot;ack:\fB\&amp;.\&amp;.\&amp;.\fR&quot; invocation on the command line using the &quot;ack&quot; &lt;keyAlias&gt; instead of the longer
\fB\-\-trailer\fR
&quot;Acked\-by:\fB\&amp;.\&amp;.\&amp;.\fR&quot;\&amp;.
.sp
At the end of the &lt;key&gt;, a separator can appear and then some space characters\&amp;. By default the only valid separator is
\fI:\fR, but this can be changed using the
\fBtrailer\&amp;.separators\fR
config variable\&amp;.
.sp
If there is a separator in the key, then it overrides the default separator when adding the trailer\&amp;.
.RE
.PP
trailer\&amp;.&lt;keyAlias&gt;\&amp;.where
.RS 4
This option takes the same values as the
\fItrailer\&amp;.where\fR
configuration variable and it overrides what is specified by that option for trailers with the specified &lt;keyAlias&gt;\&amp;.
.RE
.PP
trailer\&amp;.&lt;keyAlias&gt;\&amp;.ifexists
.RS 4
This option takes the same values as the
\fItrailer\&amp;.ifexists\fR
configuration variable and it overrides what is specified by that option for trailers with the specified &lt;keyAlias&gt;\&amp;.
.RE
.PP
trailer\&amp;.&lt;keyAlias&gt;\&amp;.ifmissing
.RS 4
This option takes the same values as the
\fItrailer\&amp;.ifmissing\fR
configuration variable and it overrides what is specified by that option for trailers with the specified &lt;keyAlias&gt;\&amp;.
.RE
.PP
trailer\&amp;.&lt;keyAlias&gt;\&amp;.command
.RS 4
Deprecated in favor of
\fItrailer\&amp;.&lt;keyAlias&gt;\&amp;.cmd\fR\&amp;. This option behaves in the same way as
\fItrailer\&amp;.&lt;keyAlias&gt;\&amp;.cmd\fR, except that it doesn\(cqt pass anything as argument to the specified command\&amp;. Instead the first occurrence of substring $ARG is replaced by the &lt;value&gt; that would be passed as argument\&amp;.
.sp
Note that $ARG in the user\(cqs command is only replaced once and that the original way of replacing $ARG is not safe\&amp;.
.sp
When both
\fItrailer\&amp;.&lt;keyAlias&gt;\&amp;.cmd\fR
and
\fItrailer\&amp;.&lt;keyAlias&gt;\&amp;.command\fR
are given for the same &lt;keyAlias&gt;,
\fItrailer\&amp;.&lt;keyAlias&gt;\&amp;.cmd\fR
is used and
\fItrailer\&amp;.&lt;keyAlias&gt;\&amp;.command\fR
is ignored\&amp;.
.RE
.PP
trailer\&amp;.&lt;keyAlias&gt;\&amp;.cmd
.RS 4
This option can be used to specify a shell command that will be called once to automatically add a trailer with the specified &lt;keyAlias&gt;, and then called each time a
\fI\-\-trailer &lt;keyAlias&gt;=&lt;value&gt;\fR
argument is specified to modify the &lt;value&gt; of the trailer that this option would produce\&amp;.
.sp
When the specified command is first called to add a trailer with the specified &lt;keyAlias&gt;, the behavior is as if a special
\fI\-\-trailer &lt;keyAlias&gt;=&lt;value&gt;\fR
argument was added at the beginning of the &quot;git interpret\-trailers&quot; command, where &lt;value&gt; is taken to be the standard output of the command with any leading and trailing whitespace trimmed off\&amp;.
.sp
If some
\fI\-\-trailer &lt;keyAlias&gt;=&lt;value&gt;\fR
arguments are also passed on the command line, the command is called again once for each of these arguments with the same &lt;keyAlias&gt;\&amp;. And the &lt;value&gt; part of these arguments, if any, will be passed to the command as its first argument\&amp;. This way the command can produce a &lt;value&gt; computed from the &lt;value&gt; passed in the
\fI\-\-trailer &lt;keyAlias&gt;=&lt;value&gt;\fR
argument\&amp;.
.RE
.SH &quot;EXAMPLES&quot;
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Configure a
\fIsign\fR
trailer with a
\fISigned\-off\-by\fR
key, and then add two of these trailers to a commit message file:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git config trailer\&amp;.sign\&amp;.key &quot;Signed\-off\-by&quot;
$ cat msg\&amp;.txt
subject

body text
$ git interpret\-trailers \-\-trailer \*(Aqsign: Alice &lt;alice@example\&amp;.com&gt;\*(Aq \-\-trailer \*(Aqsign: Bob &lt;bob@example\&amp;.com&gt;\*(Aq &lt;msg\&amp;.txt
subject

body text

Signed\-off\-by: Alice &lt;alice@example\&amp;.com&gt;
Signed\-off\-by: Bob &lt;bob@example\&amp;.com&gt;
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use the
\fB\-\-in\-place\fR
option to edit a commit message file in place:
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat msg\&amp;.txt
subject

body text

Signed\-off\-by: Bob &lt;bob@example\&amp;.com&gt;
$ git interpret\-trailers \-\-trailer \*(AqAcked\-by: Alice &lt;alice@example\&amp;.com&gt;\*(Aq \-\-in\-place msg\&amp;.txt
$ cat msg\&amp;.txt
subject

body text

Signed\-off\-by: Bob &lt;bob@example\&amp;.com&gt;
Acked\-by: Alice &lt;alice@example\&amp;.com&gt;
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Extract the last commit as a patch, and add a
\fICc\fR
and a
\fIReviewed\-by\fR
trailer to it:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git format\-patch \-1
0001\-foo\&amp;.patch
$ git interpret\-trailers \-\-trailer \*(AqCc: Alice &lt;alice@example\&amp;.com&gt;\*(Aq \-\-trailer \*(AqReviewed\-by: Bob &lt;bob@example\&amp;.com&gt;\*(Aq 0001\-foo\&amp;.patch &gt;0001\-bar\&amp;.patch
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Configure a
\fIsign\fR
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:
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat msg1\&amp;.txt
subject

body text
$ git config trailer\&amp;.sign\&amp;.key &quot;Signed\-off\-by: &quot;
$ git config trailer\&amp;.sign\&amp;.ifmissing add
$ git config trailer\&amp;.sign\&amp;.ifexists doNothing
$ git config trailer\&amp;.sign\&amp;.cmd \*(Aqecho &quot;$(git config user\&amp;.name) &lt;$(git config user\&amp;.email)&gt;&quot;\*(Aq
$ git interpret\-trailers \-\-trailer sign &lt;msg1\&amp;.txt
subject

body text

Signed\-off\-by: Bob &lt;bob@example\&amp;.com&gt;
$ cat msg2\&amp;.txt
subject

body text

Signed\-off\-by: Alice &lt;alice@example\&amp;.com&gt;
$ git interpret\-trailers \-\-trailer sign &lt;msg2\&amp;.txt
subject

body text

Signed\-off\-by: Alice &lt;alice@example\&amp;.com&gt;
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Configure a
\fIfix\fR
trailer with a key that contains a
\fI#\fR
and no space after this character, and show how it works:
.sp
.if n \{\
.RS 4
.\}
.nf
$ git config trailer\&amp;.separators &quot;:#&quot;
$ git config trailer\&amp;.fix\&amp;.key &quot;Fix #&quot;
$ echo &quot;subject&quot; | git interpret\-trailers \-\-trailer fix=42
subject

Fix #42
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Configure a
\fIhelp\fR
trailer with a cmd use a script
\fBglog\-find\-author\fR
which search specified author identity from git log in git repository and show how it works:
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat ~/bin/glog\-find\-author
#!/bin/sh
test \-n &quot;$1&quot; &amp;&amp; git log \-\-author=&quot;$1&quot; \-\-pretty=&quot;%an &lt;%ae&gt;&quot; \-1 || true
$ cat msg\&amp;.txt
subject

body text
$ git config trailer\&amp;.help\&amp;.key &quot;Helped\-by: &quot;
$ git config trailer\&amp;.help\&amp;.ifExists &quot;addIfDifferentNeighbor&quot;
$ git config trailer\&amp;.help\&amp;.cmd &quot;~/bin/glog\-find\-author&quot;
$ git interpret\-trailers \-\-trailer=&quot;help:Junio&quot; \-\-trailer=&quot;help:Couder&quot; &lt;msg\&amp;.txt
subject

body text

Helped\-by: Junio C Hamano &lt;gitster@pobox\&amp;.com&gt;
Helped\-by: Christian Couder &lt;christian\&amp;.couder@gmail\&amp;.com&gt;
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Configure a
\fIref\fR
trailer with a cmd use a script
\fBglog\-grep\fR
to grep last relevant commit from git log in the git repository and show how it works:
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat ~/bin/glog\-grep
#!/bin/sh
test \-n &quot;$1&quot; &amp;&amp; git log \-\-grep &quot;$1&quot; \-\-pretty=reference \-1 || true
$ cat msg\&amp;.txt
subject

body text
$ git config trailer\&amp;.ref\&amp;.key &quot;Reference\-to: &quot;
$ git config trailer\&amp;.ref\&amp;.ifExists &quot;replace&quot;
$ git config trailer\&amp;.ref\&amp;.cmd &quot;~/bin/glog\-grep&quot;
$ git interpret\-trailers \-\-trailer=&quot;ref:Add copyright notices\&amp;.&quot; &lt;msg\&amp;.txt
subject

body text

Reference\-to: 8bc9a0c769 (Add copyright notices\&amp;., 2005\-04\-07)
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Configure a
\fIsee\fR
trailer with a command to show the subject of a commit that is related, and show how it works:
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat msg\&amp;.txt
subject

body text

see: HEAD~2
$ cat ~/bin/glog\-ref
#!/bin/sh
git log \-1 \-\-oneline \-\-format=&quot;%h (%s)&quot; \-\-abbrev\-commit \-\-abbrev=14
$ git config trailer\&amp;.see\&amp;.key &quot;See\-also: &quot;
$ git config trailer\&amp;.see\&amp;.ifExists &quot;replace&quot;
$ git config trailer\&amp;.see\&amp;.ifMissing &quot;doNothing&quot;
$ git config trailer\&amp;.see\&amp;.cmd &quot;glog\-ref&quot;
$ git interpret\-trailers \-\-trailer=see &lt;msg\&amp;.txt
subject

body text

See\-also: fe3187489d69c4 (subject of related commit)
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
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
\fIgit interpret\-trailers\fR
to remove trailers with empty values and to add a
\fIgit\-version\fR
trailer:
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat temp\&amp;.txt
***subject***

***message***

Fixes: Z
Cc: Z
Reviewed\-by: Z
Signed\-off\-by: Z
$ sed \-e \*(Aqs/ Z$/ /\*(Aq temp\&amp;.txt &gt; commit_template\&amp;.txt
$ git config commit\&amp;.template commit_template\&amp;.txt
$ cat \&amp;.git/hooks/commit\-msg
#!/bin/sh
git interpret\-trailers \-\-trim\-empty \-\-trailer &quot;git\-version: \e$(git describe)&quot; &quot;\e$1&quot; &gt; &quot;\e$1\&amp;.new&quot;
mv &quot;\e$1\&amp;.new&quot; &quot;\e$1&quot;
$ chmod +x \&amp;.git/hooks/commit\-msg
.fi
.if n \{\
.RE
.\}
.sp
.RE
.SH &quot;SEE ALSO&quot;
.sp
\fBgit-commit\fR(1), \fBgit-format-patch\fR(1), \fBgit-config\fR(1)
.SH &quot;GIT&quot;
.sp
Part of the \fBgit\fR(1) suite
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2Fshare%2Fman%2Fman1'>Back to Directory</a>