Autogenerated HTML docs for v2.47.0-229-g8f8d6
[git-htmldocs.git] / git-interpret-trailers.html
blobdc124729dcbd090a9aa26a2945e7b9bb1dfddb3a
1 <!DOCTYPE html>
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3 <head>
4 <meta charset="UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
7 <meta name="generator" content="Asciidoctor 2.0.20"/>
8 <title>git-interpret-trailers(1)</title>
9 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10 <style>
11 /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12 /* Uncomment the following line when using as a custom stylesheet */
13 /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15 a{background:none}
16 a:focus{outline:thin dotted}
17 a:active,a:hover{outline:0}
18 h1{font-size:2em;margin:.67em 0}
19 b,strong{font-weight:bold}
20 abbr{font-size:.9em}
21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22 dfn{font-style:italic}
23 hr{height:0}
24 mark{background:#ff0;color:#000}
25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
26 pre{white-space:pre-wrap}
27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
28 small{font-size:80%}
29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30 sup{top:-.5em}
31 sub{bottom:-.25em}
32 img{border:0}
33 svg:not(:root){overflow:hidden}
34 figure{margin:0}
35 audio,video{display:inline-block}
36 audio:not([controls]){display:none;height:0}
37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38 legend{border:0;padding:0}
39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40 button,input{line-height:normal}
41 button,select{text-transform:none}
42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43 button[disabled],html input[disabled]{cursor:default}
44 input[type=checkbox],input[type=radio]{padding:0}
45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46 textarea{overflow:auto;vertical-align:top}
47 table{border-collapse:collapse;border-spacing:0}
48 *,::before,::after{box-sizing:border-box}
49 html,body{font-size:100%}
50 body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51 a:hover{cursor:pointer}
52 img,object,embed{max-width:100%;height:auto}
53 object,embed{height:100%}
54 img{-ms-interpolation-mode:bicubic}
55 .left{float:left!important}
56 .right{float:right!important}
57 .text-left{text-align:left!important}
58 .text-right{text-align:right!important}
59 .text-center{text-align:center!important}
60 .text-justify{text-align:justify!important}
61 .hide{display:none}
62 img,object,svg{display:inline-block;vertical-align:middle}
63 textarea{height:auto;min-height:50px}
64 select{width:100%}
65 .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66 div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
68 a:hover,a:focus{color:#1d4b8f}
69 a img{border:0}
70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
72 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73 h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74 h1{font-size:2.125em}
75 h2{font-size:1.6875em}
76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77 h4,h5{font-size:1.125em}
78 h6{font-size:1em}
79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80 em,i{font-style:italic;line-height:inherit}
81 strong,b{font-weight:bold;line-height:inherit}
82 small{font-size:60%;line-height:inherit}
83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85 ul,ol{margin-left:1.5em}
86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87 ul.circle{list-style-type:circle}
88 ul.disc{list-style-type:disc}
89 ul.square{list-style-type:square}
90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92 dl dt{margin-bottom:.3125em;font-weight:bold}
93 dl dd{margin-bottom:1.25em}
94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95 blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96 @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97 h1{font-size:2.75em}
98 h2{font-size:2.3125em}
99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100 h4{font-size:1.4375em}}
101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102 table thead,table tfoot{background:#f7f8f7}
103 table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105 table tr.even,table tr.alt{background:#f8f8f7}
106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108 h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109 .center{margin-left:auto;margin-right:auto}
110 .stretch{width:100%}
111 .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112 .clearfix::after,.float-group::after{clear:both}
113 :not(pre).nobreak{word-wrap:normal}
114 :not(pre).nowrap{white-space:nowrap}
115 :not(pre).pre-wrap{white-space:pre-wrap}
116 :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119 pre>code{display:block}
120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121 em em{font-style:normal}
122 strong strong{font-weight:400}
123 .keyseq{color:rgba(51,51,51,.8)}
124 kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125 .keyseq kbd:first-child{margin-left:0}
126 .keyseq kbd:last-child{margin-right:0}
127 .menuseq,.menuref{color:#000}
128 .menuseq b:not(.caret),.menuref{font-weight:inherit}
129 .menuseq{word-spacing:-.02em}
130 .menuseq b.caret{font-size:1.25em;line-height:.8}
131 .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133 b.button::before{content:"[";padding:0 3px 0 2px}
134 b.button::after{content:"]";padding:0 2px 0 3px}
135 p a>code:hover{color:rgba(0,0,0,.9)}
136 #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137 #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138 #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139 #content{margin-top:1.25em}
140 #content::before{content:none}
141 #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142 #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
143 #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
144 #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145 #header .details span:first-child{margin-left:-.125em}
146 #header .details span.email a{color:rgba(0,0,0,.85)}
147 #header .details br{display:none}
148 #header .details br+span::before{content:"\00a0\2013\00a0"}
149 #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150 #header .details br+span#revremark::before{content:"\00a0|\00a0"}
151 #header #revnumber{text-transform:capitalize}
152 #header #revnumber::after{content:"\00a0"}
153 #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154 #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155 #toc>ul{margin-left:.125em}
156 #toc ul.sectlevel0>li>a{font-style:italic}
157 #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158 #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159 #toc li{line-height:1.3334;margin-top:.3334em}
160 #toc a{text-decoration:none}
161 #toc a:active{text-decoration:underline}
162 #toctitle{color:#7a2518;font-size:1.2em}
163 @media screen and (min-width:768px){#toctitle{font-size:1.375em}
164 body.toc2{padding-left:15em;padding-right:0}
165 #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
166 #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
167 #toc.toc2>ul{font-size:.9em;margin-bottom:0}
168 #toc.toc2 ul ul{margin-left:0;padding-left:1em}
169 #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
170 body.toc2.toc-right{padding-left:0;padding-right:15em}
171 body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
172 @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
173 #toc.toc2{width:20em}
174 #toc.toc2 #toctitle{font-size:1.375em}
175 #toc.toc2>ul{font-size:.95em}
176 #toc.toc2 ul ul{padding-left:1.25em}
177 body.toc2.toc-right{padding-left:0;padding-right:20em}}
178 #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
179 #content #toc>:first-child{margin-top:0}
180 #content #toc>:last-child{margin-bottom:0}
181 #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
182 #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
183 #content{margin-bottom:.625em}
184 .sect1{padding-bottom:.625em}
185 @media screen and (min-width:768px){#content{margin-bottom:1.25em}
186 .sect1{padding-bottom:1.25em}}
187 .sect1:last-child{padding-bottom:0}
188 .sect1+.sect1{border-top:1px solid #e7e7e9}
189 #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
190 #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
191 #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
192 #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
193 #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
195 details{margin-left:1.25rem}
196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197 details>summary::-webkit-details-marker{display:none}
198 details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
200 details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
201 .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
202 table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
203 .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
204 .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
205 .admonitionblock>table td.icon{text-align:center;width:80px}
206 .admonitionblock>table td.icon img{max-width:none}
207 .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
208 .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
209 .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
210 .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
211 .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
212 .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
213 .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
214 .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
215 .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
216 @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
217 @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
218 .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
219 .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
220 .listingblock>.content{position:relative}
221 .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
222 .listingblock:hover code[data-lang]::before{display:block}
223 .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
224 .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
225 .listingblock pre.highlightjs{padding:0}
226 .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
227 .listingblock pre.prettyprint{border-width:0}
228 .prettyprint{background:#f7f7f8}
229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
231 pre.prettyprint li code[data-lang]::before{opacity:1}
232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
235 table.linenotable td.code{padding-left:.75em}
236 table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
237 pre.pygments span.linenos{display:inline-block;margin-right:.75em}
238 .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
239 .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
240 .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
241 .quoteblock blockquote{margin:0;padding:0;border:0}
242 .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
243 .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
244 .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
245 .verseblock{margin:0 1em 1.25em}
246 .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
247 .verseblock pre strong{font-weight:400}
248 .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
249 .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
250 .quoteblock .attribution br,.verseblock .attribution br{display:none}
251 .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
252 .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
253 .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
254 .quoteblock.abstract{margin:0 1em 1.25em;display:block}
255 .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
256 .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
257 .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
258 .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
259 .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
260 p.tableblock:last-child{margin-bottom:0}
261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
264 table.grid-all>*>tr>*{border-width:1px}
265 table.grid-cols>*>tr>*{border-width:0 1px}
266 table.grid-rows>*>tr>*{border-width:1px 0}
267 table.frame-all{border-width:1px}
268 table.frame-ends{border-width:1px 0}
269 table.frame-sides{border-width:0 1px}
270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
274 table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
275 th.halign-left,td.halign-left{text-align:left}
276 th.halign-right,td.halign-right{text-align:right}
277 th.halign-center,td.halign-center{text-align:center}
278 th.valign-top,td.valign-top{vertical-align:top}
279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280 th.valign-middle,td.valign-middle{vertical-align:middle}
281 table thead th,table tfoot th{font-weight:bold}
282 tbody tr th{background:#f7f8f7}
283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
284 p.tableblock>code:only-child{background:none;padding:0}
285 p.tableblock{font-size:1em}
286 ol{margin-left:1.75em}
287 ul li ol{margin-left:1.5em}
288 dl dd{margin-left:1.125em}
289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
293 ul.unstyled,ol.unstyled{margin-left:0}
294 li>p:empty:only-child::before{content:"";display:inline-block}
295 ul.checklist>li>p:first-child{margin-left:-1em}
296 ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
299 ul.inline>li{margin-left:1.25em}
300 .unstyled dl dt{font-weight:400;font-style:normal}
301 ol.arabic{list-style-type:decimal}
302 ol.decimal{list-style-type:decimal-leading-zero}
303 ol.loweralpha{list-style-type:lower-alpha}
304 ol.upperalpha{list-style-type:upper-alpha}
305 ol.lowerroman{list-style-type:lower-roman}
306 ol.upperroman{list-style-type:upper-roman}
307 ol.lowergreek{list-style-type:lower-greek}
308 .hdlist>table,.colist>table{border:0;background:none}
309 .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
312 td.hdlist2{word-wrap:anywhere}
313 .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
314 .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
315 .colist td:not([class]):first-child img{max-width:none}
316 .colist td:not([class]):last-child{padding:.25em 0}
317 .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
318 .imageblock.left{margin:.25em .625em 1.25em 0}
319 .imageblock.right{margin:.25em 0 1.25em .625em}
320 .imageblock>.title{margin-bottom:0}
321 .imageblock.thumb,.imageblock.th{border-width:6px}
322 .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
323 .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
324 .image.left{margin-right:.625em}
325 .image.right{margin-left:.625em}
326 a.image{text-decoration:none;display:inline-block}
327 a.image object{pointer-events:none}
328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
329 sup.footnote a,sup.footnoteref a{text-decoration:none}
330 sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
331 #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
332 #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
333 #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
334 #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
335 #footnotes .footnote:last-of-type{margin-bottom:0}
336 #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
337 div.unbreakable{page-break-inside:avoid}
338 .big{font-size:larger}
339 .small{font-size:smaller}
340 .underline{text-decoration:underline}
341 .overline{text-decoration:overline}
342 .line-through{text-decoration:line-through}
343 .aqua{color:#00bfbf}
344 .aqua-background{background:#00fafa}
345 .black{color:#000}
346 .black-background{background:#000}
347 .blue{color:#0000bf}
348 .blue-background{background:#0000fa}
349 .fuchsia{color:#bf00bf}
350 .fuchsia-background{background:#fa00fa}
351 .gray{color:#606060}
352 .gray-background{background:#7d7d7d}
353 .green{color:#006000}
354 .green-background{background:#007d00}
355 .lime{color:#00bf00}
356 .lime-background{background:#00fa00}
357 .maroon{color:#600000}
358 .maroon-background{background:#7d0000}
359 .navy{color:#000060}
360 .navy-background{background:#00007d}
361 .olive{color:#606000}
362 .olive-background{background:#7d7d00}
363 .purple{color:#600060}
364 .purple-background{background:#7d007d}
365 .red{color:#bf0000}
366 .red-background{background:#fa0000}
367 .silver{color:#909090}
368 .silver-background{background:#bcbcbc}
369 .teal{color:#006060}
370 .teal-background{background:#007d7d}
371 .white{color:#bfbfbf}
372 .white-background{background:#fafafa}
373 .yellow{color:#bfbf00}
374 .yellow-background{background:#fafa00}
375 span.icon>.fa{cursor:default}
376 a span.icon>.fa{cursor:inherit}
377 .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
378 .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
379 .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
380 .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
381 .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
382 .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
383 .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
384 .conum[data-value] *{color:#fff!important}
385 .conum[data-value]+b{display:none}
386 .conum[data-value]::after{content:attr(data-value)}
387 pre .conum[data-value]{position:relative;top:-.125em}
388 b.conum *{color:inherit!important}
389 .conum:not([data-value]):empty{display:none}
390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
394 p{margin-bottom:1.25rem}
395 .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
396 .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
397 .print-only{display:none!important}
398 @page{margin:1.25cm .75cm}
399 @media print{*{box-shadow:none!important;text-shadow:none!important}
400 html{font-size:80%}
401 a{color:inherit!important;text-decoration:underline!important}
402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
404 abbr[title]{border-bottom:1px dotted}
405 abbr[title]::after{content:" (" attr(title) ")"}
406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407 thead{display:table-header-group}
408 svg{max-width:100%}
409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
410 h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
411 #header,#content,#footnotes,#footer{max-width:none}
412 #toc,.sidebarblock,.exampleblock>.content{background:none!important}
413 #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
414 body.book #header{text-align:center}
415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
416 body.book #header .details{border:0!important;display:block;padding:0!important}
417 body.book #header .details span:first-child{margin-left:0!important}
418 body.book #header .details br{display:block}
419 body.book #header .details br+span::before{content:none!important}
420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
421 body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
422 .listingblock code[data-lang]::before{display:block}
423 #footer{padding:0 .9375em}
424 .hide-on-print{display:none!important}
425 .print-only{display:block!important}
426 .hide-for-print{display:none!important}
427 .show-for-print{display:inherit!important}}
428 @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
429 .sect1{padding:0!important}
430 .sect1+.sect1{border:0}
431 #footer{background:none}
432 #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
433 @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
434 </style>
435 <style>
436 pre>code {
437 display: inline;
439 </style>
440 </head>
441 <body class="manpage">
442 <div id="header">
443 <h1>git-interpret-trailers(1) Manual Page</h1>
444 <h2 id="_name">NAME</h2>
445 <div class="sectionbody">
446 <p>git-interpret-trailers - Add or parse structured information in commit messages</p>
447 </div>
448 </div>
449 <div id="content">
450 <div class="sect1">
451 <h2 id="_synopsis">SYNOPSIS</h2>
452 <div class="sectionbody">
453 <div class="verseblock">
454 <pre class="content"><em>git interpret-trailers</em> [--in-place] [--trim-empty]
455 [(--trailer (&lt;key&gt;|&lt;key-alias&gt;)[(=|:)&lt;value&gt;])&#8230;&#8203;]
456 [--parse] [&lt;file&gt;&#8230;&#8203;]</pre>
457 </div>
458 </div>
459 </div>
460 <div class="sect1">
461 <h2 id="_description">DESCRIPTION</h2>
462 <div class="sectionbody">
463 <div class="paragraph">
464 <p>Add or parse <em>trailer</em> lines that look similar to RFC 822 e-mail
465 headers, at the end of the otherwise free-form part of a commit
466 message. For example, in the following commit message</p>
467 </div>
468 <div class="listingblock">
469 <div class="content">
470 <pre>subject
472 Lorem ipsum dolor sit amet, consectetur adipiscing elit.
474 Signed-off-by: Alice &lt;alice@example.com&gt;
475 Signed-off-by: Bob &lt;bob@example.com&gt;</pre>
476 </div>
477 </div>
478 <div class="paragraph">
479 <p>the last two lines starting with "Signed-off-by" are trailers.</p>
480 </div>
481 <div class="paragraph">
482 <p>This command reads commit messages from either the
483 &lt;file&gt; arguments or the standard input if no &lt;file&gt; is specified.
484 If <code>--parse</code> is specified, the output consists of the parsed trailers
485 coming from the input, without influencing them with any command line
486 options or configuration variables.</p>
487 </div>
488 <div class="paragraph">
489 <p>Otherwise, this command applies <code>trailer.</code>* configuration variables
490 (which could potentially add new trailers, as well as reposition them),
491 as well as any command line arguments that can override configuration
492 variables (such as <code>--trailer=..</code>. which could also add new trailers),
493 to each input file. The result is emitted on the standard output.</p>
494 </div>
495 <div class="paragraph">
496 <p>This command can also operate on the output of <a href="git-format-patch.html">git-format-patch(1)</a>,
497 which is more elaborate than a plain commit message. Namely, such output
498 includes a commit message (as above), a "---" divider line, and a patch part.
499 For these inputs, the divider and patch parts are not modified by
500 this command and are emitted as is on the output, unless
501 <code>--no-divider</code> is specified.</p>
502 </div>
503 <div class="paragraph">
504 <p>Some configuration variables control the way the <code>--trailer</code> arguments
505 are applied to each input and the way any existing trailer in
506 the input is changed. They also make it possible to
507 automatically add some trailers.</p>
508 </div>
509 <div class="paragraph">
510 <p>By default, a <em>&lt;key&gt;=&lt;value&gt;</em> or <em>&lt;key&gt;:&lt;value&gt;</em> argument given
511 using <code>--trailer</code> will be appended after the existing trailers only if
512 the last trailer has a different (&lt;key&gt;, &lt;value&gt;) pair (or if there
513 is no existing trailer). The &lt;key&gt; and &lt;value&gt; parts will be trimmed
514 to remove starting and trailing whitespace, and the resulting trimmed
515 &lt;key&gt; and &lt;value&gt; will appear in the output like this:</p>
516 </div>
517 <div class="listingblock">
518 <div class="content">
519 <pre>key: value</pre>
520 </div>
521 </div>
522 <div class="paragraph">
523 <p>This means that the trimmed &lt;key&gt; and &lt;value&gt; will be separated by
524 ': ' (one colon followed by one space).</p>
525 </div>
526 <div class="paragraph">
527 <p>For convenience, a &lt;key-alias&gt; can be configured to make using <code>--trailer</code>
528 shorter to type on the command line. This can be configured using the
529 <em>trailer.&lt;key-alias&gt;.key</em> configuration variable. The &lt;keyAlias&gt; must be a prefix
530 of the full &lt;key&gt; string, although case sensitivity does not matter. For
531 example, if you have</p>
532 </div>
533 <div class="listingblock">
534 <div class="content">
535 <pre>trailer.sign.key "Signed-off-by: "</pre>
536 </div>
537 </div>
538 <div class="paragraph">
539 <p>in your configuration, you only need to specify <code>--trailer=</code>"sign: <code>foo</code>"
540 on the command line instead of <code>--trailer=</code>"Signed-off-by: <code>foo</code>".</p>
541 </div>
542 <div class="paragraph">
543 <p>By default the new trailer will appear at the end of all the existing
544 trailers. If there is no existing trailer, the new trailer will appear
545 at the end of the input. A blank line will be added before the new
546 trailer if there isn&#8217;t one already.</p>
547 </div>
548 <div class="paragraph">
549 <p>Existing trailers are extracted from the input by looking for
550 a group of one or more lines that (i) is all trailers, or (ii) contains at
551 least one Git-generated or user-configured trailer and consists of at
552 least 25% trailers.
553 The group must be preceded by one or more empty (or whitespace-only) lines.
554 The group must either be at the end of the input or be the last
555 non-whitespace lines before a line that starts with <em>---</em> (followed by a
556 space or the end of the line).</p>
557 </div>
558 <div class="paragraph">
559 <p>When reading trailers, there can be no whitespace before or inside the
560 &lt;key&gt;, but any number of regular space and tab characters are allowed
561 between the &lt;key&gt; and the separator. There can be whitespaces before,
562 inside or after the &lt;value&gt;. The &lt;value&gt; may be split over multiple lines
563 with each subsequent line starting with at least one whitespace, like
564 the "folding" in RFC 822. Example:</p>
565 </div>
566 <div class="listingblock">
567 <div class="content">
568 <pre>key: This is a very long value, with spaces and
569 newlines in it.</pre>
570 </div>
571 </div>
572 <div class="paragraph">
573 <p>Note that trailers do not follow (nor are they intended to follow) many of the
574 rules for RFC 822 headers. For example they do not follow the encoding rule.</p>
575 </div>
576 </div>
577 </div>
578 <div class="sect1">
579 <h2 id="_options">OPTIONS</h2>
580 <div class="sectionbody">
581 <div class="dlist">
582 <dl>
583 <dt class="hdlist1">--in-place</dt>
584 <dd>
585 <p>Edit the files in place.</p>
586 </dd>
587 <dt class="hdlist1">--trim-empty</dt>
588 <dd>
589 <p>If the &lt;value&gt; part of any trailer contains only whitespace,
590 the whole trailer will be removed from the output.
591 This applies to existing trailers as well as new trailers.</p>
592 </dd>
593 <dt class="hdlist1">--trailer &lt;key&gt;[(=|:)&lt;value&gt;]</dt>
594 <dd>
595 <p>Specify a (&lt;key&gt;, &lt;value&gt;) pair that should be applied as a
596 trailer to the inputs. See the description of this
597 command.</p>
598 </dd>
599 <dt class="hdlist1">--where &lt;placement&gt;</dt>
600 <dt class="hdlist1">--no-where</dt>
601 <dd>
602 <p>Specify where all new trailers will be added. A setting
603 provided with <em>--where</em> overrides the <code>trailer.where</code> and any
604 applicable <code>trailer.</code><em>&lt;keyAlias&gt;</em><code>.where</code> configuration variables
605 and applies to all <em>--trailer</em> options until the next occurrence of
606 <em>--where</em> or <em>--no-where</em>. Upon encountering <em>--no-where</em>, clear the
607 effect of any previous use of <em>--where</em>, such that the relevant configuration
608 variables are no longer overridden. Possible placements are <code>after</code>,
609 <code>before</code>, <code>end</code> or <code>start</code>.</p>
610 </dd>
611 <dt class="hdlist1">--if-exists &lt;action&gt;</dt>
612 <dt class="hdlist1">--no-if-exists</dt>
613 <dd>
614 <p>Specify what action will be performed when there is already at
615 least one trailer with the same &lt;key&gt; in the input. A setting
616 provided with <em>--if-exists</em> overrides the <code>trailer.ifExists</code> and any
617 applicable <code>trailer.</code><em>&lt;keyAlias&gt;</em><code>.ifExists</code> configuration variables
618 and applies to all <em>--trailer</em> options until the next occurrence of
619 <em>--if-exists</em> or <em>--no-if-exists</em>. Upon encountering '--no-if-exists, clear the
620 effect of any previous use of '--if-exists, such that the relevant configuration
621 variables are no longer overridden. Possible actions are <code>addIfDifferent</code>,
622 <code>addIfDifferentNeighbor</code>, <code>add</code>, <code>replace</code> and <code>doNothing</code>.</p>
623 </dd>
624 <dt class="hdlist1">--if-missing &lt;action&gt;</dt>
625 <dt class="hdlist1">--no-if-missing</dt>
626 <dd>
627 <p>Specify what action will be performed when there is no other
628 trailer with the same &lt;key&gt; in the input. A setting
629 provided with <em>--if-missing</em> overrides the <code>trailer.ifMissing</code> and any
630 applicable <code>trailer.</code><em>&lt;keyAlias&gt;</em><code>.ifMissing</code> configuration variables
631 and applies to all <em>--trailer</em> options until the next occurrence of
632 <em>--if-missing</em> or <em>--no-if-missing</em>. Upon encountering '--no-if-missing,
633 clear the effect of any previous use of '--if-missing, such that the relevant
634 configuration variables are no longer overridden. Possible actions are <code>doNothing</code>
635 or <code>add</code>.</p>
636 </dd>
637 <dt class="hdlist1">--only-trailers</dt>
638 <dd>
639 <p>Output only the trailers, not any other parts of the input.</p>
640 </dd>
641 <dt class="hdlist1">--only-input</dt>
642 <dd>
643 <p>Output only trailers that exist in the input; do not add any
644 from the command-line or by applying <code>trailer.</code>* configuration
645 variables.</p>
646 </dd>
647 <dt class="hdlist1">--unfold</dt>
648 <dd>
649 <p>If a trailer has a value that runs over multiple lines (aka "folded"),
650 reformat the value into a single line.</p>
651 </dd>
652 <dt class="hdlist1">--parse</dt>
653 <dd>
654 <p>A convenience alias for <code>--only-trailers</code> <code>--only-input</code>
655 <code>--unfold</code>. This makes it easier to only see the trailers coming from the
656 input without influencing them with any command line options or
657 configuration variables, while also making the output machine-friendly with
658 --unfold.</p>
659 </dd>
660 <dt class="hdlist1">--no-divider</dt>
661 <dd>
662 <p>Do not treat <code>---</code> as the end of the commit message. Use this
663 when you know your input contains just the commit message itself
664 (and not an email or the output of <code>git</code> <code>format-patch</code>).</p>
665 </dd>
666 </dl>
667 </div>
668 </div>
669 </div>
670 <div class="sect1">
671 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
672 <div class="sectionbody">
673 <div class="dlist">
674 <dl>
675 <dt class="hdlist1">trailer.separators</dt>
676 <dd>
677 <p>This option tells which characters are recognized as trailer
678 separators. By default only <em>:</em> is recognized as a trailer
679 separator, except that <em>=</em> is always accepted on the command
680 line for compatibility with other git commands.</p>
681 <div class="paragraph">
682 <p>The first character given by this option will be the default character
683 used when another separator is not specified in the config for this
684 trailer.</p>
685 </div>
686 <div class="paragraph">
687 <p>For example, if the value for this option is "%=$", then only lines
688 using the format <em>&lt;key&gt;&lt;sep&gt;&lt;value&gt;</em> with &lt;sep&gt; containing <em>%</em>, <em>=</em>
689 or <em>$</em> and then spaces will be considered trailers. And <em>%</em> will be
690 the default separator used, so by default trailers will appear like:
691 <em>&lt;key&gt;% &lt;value&gt;</em> (one percent sign and one space will appear between
692 the key and the value).</p>
693 </div>
694 </dd>
695 <dt class="hdlist1">trailer.where</dt>
696 <dd>
697 <p>This option tells where a new trailer will be added.</p>
698 <div class="paragraph">
699 <p>This can be <code>end</code>, which is the default, <code>start</code>, <code>after</code> or <code>before</code>.</p>
700 </div>
701 <div class="paragraph">
702 <p>If it is <code>end</code>, then each new trailer will appear at the end of the
703 existing trailers.</p>
704 </div>
705 <div class="paragraph">
706 <p>If it is <code>start</code>, then each new trailer will appear at the start,
707 instead of the end, of the existing trailers.</p>
708 </div>
709 <div class="paragraph">
710 <p>If it is <code>after</code>, then each new trailer will appear just after the
711 last trailer with the same &lt;key&gt;.</p>
712 </div>
713 <div class="paragraph">
714 <p>If it is <code>before</code>, then each new trailer will appear just before the
715 first trailer with the same &lt;key&gt;.</p>
716 </div>
717 </dd>
718 <dt class="hdlist1">trailer.ifexists</dt>
719 <dd>
720 <p>This option makes it possible to choose what action will be
721 performed when there is already at least one trailer with the
722 same &lt;key&gt; in the input.</p>
723 <div class="paragraph">
724 <p>The valid values for this option are: <code>addIfDifferentNeighbor</code> (this
725 is the default), <code>addIfDifferent</code>, <code>add</code>, <code>replace</code> or <code>doNothing</code>.</p>
726 </div>
727 <div class="paragraph">
728 <p>With <code>addIfDifferentNeighbor</code>, a new trailer will be added only if no
729 trailer with the same (&lt;key&gt;, &lt;value&gt;) pair is above or below the line
730 where the new trailer will be added.</p>
731 </div>
732 <div class="paragraph">
733 <p>With <code>addIfDifferent</code>, a new trailer will be added only if no trailer
734 with the same (&lt;key&gt;, &lt;value&gt;) pair is already in the input.</p>
735 </div>
736 <div class="paragraph">
737 <p>With <code>add</code>, a new trailer will be added, even if some trailers with
738 the same (&lt;key&gt;, &lt;value&gt;) pair are already in the input.</p>
739 </div>
740 <div class="paragraph">
741 <p>With <code>replace</code>, an existing trailer with the same &lt;key&gt; will be
742 deleted and the new trailer will be added. The deleted trailer will be
743 the closest one (with the same &lt;key&gt;) to the place where the new one
744 will be added.</p>
745 </div>
746 <div class="paragraph">
747 <p>With <code>doNothing</code>, nothing will be done; that is no new trailer will be
748 added if there is already one with the same &lt;key&gt; in the input.</p>
749 </div>
750 </dd>
751 <dt class="hdlist1">trailer.ifmissing</dt>
752 <dd>
753 <p>This option makes it possible to choose what action will be
754 performed when there is not yet any trailer with the same
755 &lt;key&gt; in the input.</p>
756 <div class="paragraph">
757 <p>The valid values for this option are: <code>add</code> (this is the default) and
758 <code>doNothing</code>.</p>
759 </div>
760 <div class="paragraph">
761 <p>With <code>add</code>, a new trailer will be added.</p>
762 </div>
763 <div class="paragraph">
764 <p>With <code>doNothing</code>, nothing will be done.</p>
765 </div>
766 </dd>
767 <dt class="hdlist1">trailer.&lt;keyAlias&gt;.key</dt>
768 <dd>
769 <p>Defines a &lt;keyAlias&gt; for the &lt;key&gt;. The &lt;keyAlias&gt; must be a
770 prefix (case does not matter) of the &lt;key&gt;. For example, in <code>git</code>
771 <code>config</code> <code>trailer.ack.key</code> "Acked-by" the "Acked-by" is the &lt;key&gt; and
772 the "ack" is the &lt;keyAlias&gt;. This configuration allows the shorter
773 <code>--trailer</code> "ack:<code>...</code>" invocation on the command line using the "ack"
774 &lt;keyAlias&gt; instead of the longer <code>--trailer</code> "Acked-by:<code>...</code>".</p>
775 <div class="paragraph">
776 <p>At the end of the &lt;key&gt;, a separator can appear and then some
777 space characters. By default the only valid separator is <em>:</em>,
778 but this can be changed using the <code>trailer.separators</code> config
779 variable.</p>
780 </div>
781 <div class="paragraph">
782 <p>If there is a separator in the key, then it overrides the default
783 separator when adding the trailer.</p>
784 </div>
785 </dd>
786 <dt class="hdlist1">trailer.&lt;keyAlias&gt;.where</dt>
787 <dd>
788 <p>This option takes the same values as the <em>trailer.where</em>
789 configuration variable and it overrides what is specified by
790 that option for trailers with the specified &lt;keyAlias&gt;.</p>
791 </dd>
792 <dt class="hdlist1">trailer.&lt;keyAlias&gt;.ifexists</dt>
793 <dd>
794 <p>This option takes the same values as the <em>trailer.ifexists</em>
795 configuration variable and it overrides what is specified by
796 that option for trailers with the specified &lt;keyAlias&gt;.</p>
797 </dd>
798 <dt class="hdlist1">trailer.&lt;keyAlias&gt;.ifmissing</dt>
799 <dd>
800 <p>This option takes the same values as the <em>trailer.ifmissing</em>
801 configuration variable and it overrides what is specified by
802 that option for trailers with the specified &lt;keyAlias&gt;.</p>
803 </dd>
804 <dt class="hdlist1">trailer.&lt;keyAlias&gt;.command</dt>
805 <dd>
806 <p>Deprecated in favor of <em>trailer.&lt;keyAlias&gt;.cmd</em>.
807 This option behaves in the same way as <em>trailer.&lt;keyAlias&gt;.cmd</em>, except
808 that it doesn&#8217;t pass anything as argument to the specified command.
809 Instead the first occurrence of substring $ARG is replaced by the
810 &lt;value&gt; that would be passed as argument.</p>
811 <div class="paragraph">
812 <p>Note that $ARG in the user&#8217;s command is
813 only replaced once and that the original way of replacing $ARG is not safe.</p>
814 </div>
815 <div class="paragraph">
816 <p>When both <em>trailer.&lt;keyAlias&gt;.cmd</em> and <em>trailer.&lt;keyAlias&gt;.command</em> are given
817 for the same &lt;keyAlias&gt;, <em>trailer.&lt;keyAlias&gt;.cmd</em> is used and
818 <em>trailer.&lt;keyAlias&gt;.command</em> is ignored.</p>
819 </div>
820 </dd>
821 <dt class="hdlist1">trailer.&lt;keyAlias&gt;.cmd</dt>
822 <dd>
823 <p>This option can be used to specify a shell command that will be called
824 once to automatically add a trailer with the specified &lt;keyAlias&gt;, and then
825 called each time a <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> argument is specified to
826 modify the &lt;value&gt; of the trailer that this option would produce.</p>
827 <div class="paragraph">
828 <p>When the specified command is first called to add a trailer
829 with the specified &lt;keyAlias&gt;, the behavior is as if a special
830 <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> argument was added at the beginning
831 of the "git interpret-trailers" command, where &lt;value&gt;
832 is taken to be the standard output of the command with any
833 leading and trailing whitespace trimmed off.</p>
834 </div>
835 <div class="paragraph">
836 <p>If some <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> arguments are also passed
837 on the command line, the command is called again once for each
838 of these arguments with the same &lt;keyAlias&gt;. And the &lt;value&gt; part
839 of these arguments, if any, will be passed to the command as its
840 first argument. This way the command can produce a &lt;value&gt; computed
841 from the &lt;value&gt; passed in the <em>--trailer &lt;keyAlias&gt;=&lt;value&gt;</em> argument.</p>
842 </div>
843 </dd>
844 </dl>
845 </div>
846 </div>
847 </div>
848 <div class="sect1">
849 <h2 id="_examples">EXAMPLES</h2>
850 <div class="sectionbody">
851 <div class="ulist">
852 <ul>
853 <li>
854 <p>Configure a <em>sign</em> trailer with a <em>Signed-off-by</em> key, and then
855 add two of these trailers to a commit message file:</p>
856 <div class="listingblock">
857 <div class="content">
858 <pre>$ git config trailer.sign.key "Signed-off-by"
859 $ cat msg.txt
860 subject
862 body text
863 $ git interpret-trailers --trailer 'sign: Alice &lt;alice@example.com&gt;' --trailer 'sign: Bob &lt;bob@example.com&gt;' &lt;msg.txt
864 subject
866 body text
868 Signed-off-by: Alice &lt;alice@example.com&gt;
869 Signed-off-by: Bob &lt;bob@example.com&gt;</pre>
870 </div>
871 </div>
872 </li>
873 <li>
874 <p>Use the <code>--in-place</code> option to edit a commit message file in place:</p>
875 <div class="listingblock">
876 <div class="content">
877 <pre>$ cat msg.txt
878 subject
880 body text
882 Signed-off-by: Bob &lt;bob@example.com&gt;
883 $ git interpret-trailers --trailer 'Acked-by: Alice &lt;alice@example.com&gt;' --in-place msg.txt
884 $ cat msg.txt
885 subject
887 body text
889 Signed-off-by: Bob &lt;bob@example.com&gt;
890 Acked-by: Alice &lt;alice@example.com&gt;</pre>
891 </div>
892 </div>
893 </li>
894 <li>
895 <p>Extract the last commit as a patch, and add a <em>Cc</em> and a
896 <em>Reviewed-by</em> trailer to it:</p>
897 <div class="listingblock">
898 <div class="content">
899 <pre>$ git format-patch -1
900 0001-foo.patch
901 $ git interpret-trailers --trailer 'Cc: Alice &lt;alice@example.com&gt;' --trailer 'Reviewed-by: Bob &lt;bob@example.com&gt;' 0001-foo.patch &gt;0001-bar.patch</pre>
902 </div>
903 </div>
904 </li>
905 <li>
906 <p>Configure a <em>sign</em> trailer with a command to automatically add a
907 'Signed-off-by: ' with the author information only if there is no
908 'Signed-off-by: ' already, and show how it works:</p>
909 <div class="listingblock">
910 <div class="content">
911 <pre>$ cat msg1.txt
912 subject
914 body text
915 $ git config trailer.sign.key "Signed-off-by: "
916 $ git config trailer.sign.ifmissing add
917 $ git config trailer.sign.ifexists doNothing
918 $ git config trailer.sign.cmd 'echo "$(git config user.name) &lt;$(git config user.email)&gt;"'
919 $ git interpret-trailers --trailer sign &lt;msg1.txt
920 subject
922 body text
924 Signed-off-by: Bob &lt;bob@example.com&gt;
925 $ cat msg2.txt
926 subject
928 body text
930 Signed-off-by: Alice &lt;alice@example.com&gt;
931 $ git interpret-trailers --trailer sign &lt;msg2.txt
932 subject
934 body text
936 Signed-off-by: Alice &lt;alice@example.com&gt;</pre>
937 </div>
938 </div>
939 </li>
940 <li>
941 <p>Configure a <em>fix</em> trailer with a key that contains a <em>#</em> and no
942 space after this character, and show how it works:</p>
943 <div class="listingblock">
944 <div class="content">
945 <pre>$ git config trailer.separators ":#"
946 $ git config trailer.fix.key "Fix #"
947 $ echo "subject" | git interpret-trailers --trailer fix=42
948 subject
950 Fix #42</pre>
951 </div>
952 </div>
953 </li>
954 <li>
955 <p>Configure a <em>help</em> trailer with a cmd use a script <code>glog-find-author</code>
956 which search specified author identity from git log in git repository
957 and show how it works:</p>
958 <div class="listingblock">
959 <div class="content">
960 <pre>$ cat ~/bin/glog-find-author
961 #!/bin/sh
962 test -n "$1" &amp;&amp; git log --author="$1" --pretty="%an &lt;%ae&gt;" -1 || true
963 $ cat msg.txt
964 subject
966 body text
967 $ git config trailer.help.key "Helped-by: "
968 $ git config trailer.help.ifExists "addIfDifferentNeighbor"
969 $ git config trailer.help.cmd "~/bin/glog-find-author"
970 $ git interpret-trailers --trailer="help:Junio" --trailer="help:Couder" &lt;msg.txt
971 subject
973 body text
975 Helped-by: Junio C Hamano &lt;gitster@pobox.com&gt;
976 Helped-by: Christian Couder &lt;christian.couder@gmail.com&gt;</pre>
977 </div>
978 </div>
979 </li>
980 <li>
981 <p>Configure a <em>ref</em> trailer with a cmd use a script <code>glog-grep</code>
982 to grep last relevant commit from git log in the git repository
983 and show how it works:</p>
984 <div class="listingblock">
985 <div class="content">
986 <pre>$ cat ~/bin/glog-grep
987 #!/bin/sh
988 test -n "$1" &amp;&amp; git log --grep "$1" --pretty=reference -1 || true
989 $ cat msg.txt
990 subject
992 body text
993 $ git config trailer.ref.key "Reference-to: "
994 $ git config trailer.ref.ifExists "replace"
995 $ git config trailer.ref.cmd "~/bin/glog-grep"
996 $ git interpret-trailers --trailer="ref:Add copyright notices." &lt;msg.txt
997 subject
999 body text
1001 Reference-to: 8bc9a0c769 (Add copyright notices., 2005-04-07)</pre>
1002 </div>
1003 </div>
1004 </li>
1005 <li>
1006 <p>Configure a <em>see</em> trailer with a command to show the subject of a
1007 commit that is related, and show how it works:</p>
1008 <div class="listingblock">
1009 <div class="content">
1010 <pre>$ cat msg.txt
1011 subject
1013 body text
1015 see: HEAD~2
1016 $ cat ~/bin/glog-ref
1017 #!/bin/sh
1018 git log -1 --oneline --format="%h (%s)" --abbrev-commit --abbrev=14
1019 $ git config trailer.see.key "See-also: "
1020 $ git config trailer.see.ifExists "replace"
1021 $ git config trailer.see.ifMissing "doNothing"
1022 $ git config trailer.see.cmd "glog-ref"
1023 $ git interpret-trailers --trailer=see &lt;msg.txt
1024 subject
1026 body text
1028 See-also: fe3187489d69c4 (subject of related commit)</pre>
1029 </div>
1030 </div>
1031 </li>
1032 <li>
1033 <p>Configure a commit template with some trailers with empty values
1034 (using sed to show and keep the trailing spaces at the end of the
1035 trailers), then configure a commit-msg hook that uses
1036 <em>git interpret-trailers</em> to remove trailers with empty values and
1037 to add a <em>git-version</em> trailer:</p>
1038 <div class="listingblock">
1039 <div class="content">
1040 <pre>$ cat temp.txt
1041 ***subject***
1043 ***message***
1045 Fixes: Z
1046 Cc: Z
1047 Reviewed-by: Z
1048 Signed-off-by: Z
1049 $ sed -e 's/ Z$/ /' temp.txt &gt; commit_template.txt
1050 $ git config commit.template commit_template.txt
1051 $ cat .git/hooks/commit-msg
1052 #!/bin/sh
1053 git interpret-trailers --trim-empty --trailer "git-version: \$(git describe)" "\$1" &gt; "\$1.new"
1054 mv "\$1.new" "\$1"
1055 $ chmod +x .git/hooks/commit-msg</pre>
1056 </div>
1057 </div>
1058 </li>
1059 </ul>
1060 </div>
1061 </div>
1062 </div>
1063 <div class="sect1">
1064 <h2 id="_see_also">SEE ALSO</h2>
1065 <div class="sectionbody">
1066 <div class="paragraph">
1067 <p><a href="git-commit.html">git-commit(1)</a>, <a href="git-format-patch.html">git-format-patch(1)</a>, <a href="git-config.html">git-config(1)</a></p>
1068 </div>
1069 </div>
1070 </div>
1071 <div class="sect1">
1072 <h2 id="_git">GIT</h2>
1073 <div class="sectionbody">
1074 <div class="paragraph">
1075 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1076 </div>
1077 </div>
1078 </div>
1079 </div>
1080 <div id="footer">
1081 <div id="footer-text">
1082 Last updated 2024-03-25 17:24:49 -0700
1083 </div>
1084 </div>
1085 </body>
1086 </html>