Autogenerated HTML docs for v2.47.0-229-g8f8d6
[git-htmldocs.git] / git-notes.html
blobf7f86e7b5e9f1c3c1809dea2b9cd3a8caea2c9ca
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-notes(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-notes(1) Manual Page</h1>
444 <h2 id="_name">NAME</h2>
445 <div class="sectionbody">
446 <p>git-notes - Add or inspect object notes</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 notes</em> [list [&lt;object&gt;]]
455 <em>git notes</em> add [-f] [--allow-empty] [--[no-]separator | --separator=&lt;paragraph-break&gt;] [--[no-]stripspace] [-F &lt;file&gt; | -m &lt;msg&gt; | (-c | -C) &lt;object&gt;] [-e] [&lt;object&gt;]
456 <em>git notes</em> copy [-f] ( --stdin | &lt;from-object&gt; [&lt;to-object&gt;] )
457 <em>git notes</em> append [--allow-empty] [--[no-]separator | --separator=&lt;paragraph-break&gt;] [--[no-]stripspace] [-F &lt;file&gt; | -m &lt;msg&gt; | (-c | -C) &lt;object&gt;] [-e] [&lt;object&gt;]
458 <em>git notes</em> edit [--allow-empty] [&lt;object&gt;] [--[no-]stripspace]
459 <em>git notes</em> show [&lt;object&gt;]
460 <em>git notes</em> merge [-v | -q] [-s &lt;strategy&gt; ] &lt;notes-ref&gt;
461 <em>git notes</em> merge --commit [-v | -q]
462 <em>git notes</em> merge --abort [-v | -q]
463 <em>git notes</em> remove [--ignore-missing] [--stdin] [&lt;object&gt;&#8230;&#8203;]
464 <em>git notes</em> prune [-n] [-v]
465 <em>git notes</em> get-ref</pre>
466 </div>
467 </div>
468 </div>
469 <div class="sect1">
470 <h2 id="_description">DESCRIPTION</h2>
471 <div class="sectionbody">
472 <div class="paragraph">
473 <p>Adds, removes, or reads notes attached to objects, without touching
474 the objects themselves.</p>
475 </div>
476 <div class="paragraph">
477 <p>By default, notes are saved to and read from <code>refs/notes/commits</code>, but
478 this default can be overridden. See the OPTIONS, CONFIGURATION, and
479 ENVIRONMENT sections below. If this ref does not exist, it will be
480 quietly created when it is first needed to store a note.</p>
481 </div>
482 <div class="paragraph">
483 <p>A typical use of notes is to supplement a commit message without
484 changing the commit itself. Notes can be shown by <em>git log</em> along with
485 the original commit message. To distinguish these notes from the
486 message stored in the commit object, the notes are indented like the
487 message, after an unindented line saying "Notes (&lt;refname&gt;):" (or
488 "Notes:" for <code>refs/notes/commits</code>).</p>
489 </div>
490 <div class="paragraph">
491 <p>Notes can also be added to patches prepared with <code>git</code> <code>format-patch</code> by
492 using the <code>--notes</code> option. Such notes are added as a patch commentary
493 after a three dash separator line.</p>
494 </div>
495 <div class="paragraph">
496 <p>To change which notes are shown by <em>git log</em>, see the
497 "notes.displayRef" discussion in <a href="#CONFIGURATION">CONFIGURATION</a>.</p>
498 </div>
499 <div class="paragraph">
500 <p>See the "notes.rewrite.&lt;command&gt;" configuration for a way to carry
501 notes across commands that rewrite commits.</p>
502 </div>
503 </div>
504 </div>
505 <div class="sect1">
506 <h2 id="_subcommands">SUBCOMMANDS</h2>
507 <div class="sectionbody">
508 <div class="dlist">
509 <dl>
510 <dt class="hdlist1">list</dt>
511 <dd>
512 <p>List the notes object for a given object. If no object is
513 given, show a list of all note objects and the objects they
514 annotate (in the format "&lt;note-object&gt; &lt;annotated-object&gt;").
515 This is the default subcommand if no subcommand is given.</p>
516 </dd>
517 <dt class="hdlist1">add</dt>
518 <dd>
519 <p>Add notes for a given object (defaults to HEAD). Abort if the
520 object already has notes (use <code>-f</code> to overwrite existing notes).
521 However, if you&#8217;re using <code>add</code> interactively (using an editor
522 to supply the notes contents), then - instead of aborting -
523 the existing notes will be opened in the editor (like the <code>edit</code>
524 subcommand). If you specify multiple <code>-m</code> and <code>-F</code>, a blank
525 line will be inserted between the messages. Use the <code>--separator</code>
526 option to insert other delimiters. You can use <code>-e</code> to edit and
527 fine-tune the message(s) supplied from <code>-m</code> and <code>-F</code> options
528 interactively (using an editor) before adding the note.</p>
529 </dd>
530 <dt class="hdlist1">copy</dt>
531 <dd>
532 <p>Copy the notes for the first object onto the second object (defaults to
533 HEAD). Abort if the second object already has notes, or if the first
534 object has none (use -f to overwrite existing notes to the
535 second object). This subcommand is equivalent to:
536 <code>git</code> <code>notes</code> <code>add</code> [<code>-f</code>] <code>-C</code> <code>$</code>(<code>git</code> <code>notes</code> <code>list</code> <em>&lt;from-object&gt;</em>) <em>&lt;to-object&gt;</em></p>
537 <div class="paragraph">
538 <p>In <code>--stdin</code> mode, take lines in the format</p>
539 </div>
540 <div class="listingblock">
541 <div class="content">
542 <pre>&lt;from-object&gt; SP &lt;to-object&gt; [ SP &lt;rest&gt; ] LF</pre>
543 </div>
544 </div>
545 <div class="paragraph">
546 <p>on standard input, and copy the notes from each &lt;from-object&gt; to its
547 corresponding &lt;to-object&gt;. (The optional <em>&lt;rest&gt;</em> is ignored so that
548 the command can read the input given to the <code>post-rewrite</code> hook.)</p>
549 </div>
550 </dd>
551 <dt class="hdlist1">append</dt>
552 <dd>
553 <p>Append new message(s) given by <code>-m</code> or <code>-F</code> options to an
554 existing note, or add them as a new note if one does not
555 exist, for the object (defaults to HEAD). When appending to
556 an existing note, a blank line is added before each new
557 message as an inter-paragraph separator. The separator can
558 be customized with the <code>--separator</code> option.
559 Edit the notes to be appended given by <code>-m</code> and <code>-F</code> options with
560 <code>-e</code> interactively (using an editor) before appending the note.</p>
561 </dd>
562 <dt class="hdlist1">edit</dt>
563 <dd>
564 <p>Edit the notes for a given object (defaults to HEAD).</p>
565 </dd>
566 <dt class="hdlist1">show</dt>
567 <dd>
568 <p>Show the notes for a given object (defaults to HEAD).</p>
569 </dd>
570 <dt class="hdlist1">merge</dt>
571 <dd>
572 <p>Merge the given notes ref into the current notes ref.
573 This will try to merge the changes made by the given
574 notes ref (called "remote") since the merge-base (if
575 any) into the current notes ref (called "local").</p>
576 <div class="paragraph">
577 <p>If conflicts arise and a strategy for automatically resolving
578 conflicting notes (see the "NOTES MERGE STRATEGIES" section) is not given,
579 the "manual" resolver is used. This resolver checks out the
580 conflicting notes in a special worktree (.<code>git/NOTES_MERGE_WORKTREE</code>),
581 and instructs the user to manually resolve the conflicts there.
582 When done, the user can either finalize the merge with
583 <em>git notes merge --commit</em>, or abort the merge with
584 <em>git notes merge --abort</em>.</p>
585 </div>
586 </dd>
587 <dt class="hdlist1">remove</dt>
588 <dd>
589 <p>Remove the notes for given objects (defaults to HEAD). When
590 giving zero or one object from the command line, this is
591 equivalent to specifying an empty note message to
592 the <code>edit</code> subcommand.</p>
593 </dd>
594 <dt class="hdlist1">prune</dt>
595 <dd>
596 <p>Remove all notes for non-existing/unreachable objects.</p>
597 </dd>
598 <dt class="hdlist1">get-ref</dt>
599 <dd>
600 <p>Print the current notes ref. This provides an easy way to
601 retrieve the current notes ref (e.g. from scripts).</p>
602 </dd>
603 </dl>
604 </div>
605 </div>
606 </div>
607 <div class="sect1">
608 <h2 id="_options">OPTIONS</h2>
609 <div class="sectionbody">
610 <div class="dlist">
611 <dl>
612 <dt class="hdlist1">-f</dt>
613 <dt class="hdlist1">--force</dt>
614 <dd>
615 <p>When adding notes to an object that already has notes,
616 overwrite the existing notes (instead of aborting).</p>
617 </dd>
618 <dt class="hdlist1">-m &lt;msg&gt;</dt>
619 <dt class="hdlist1">--message=&lt;msg&gt;</dt>
620 <dd>
621 <p>Use the given note message (instead of prompting).
622 If multiple <code>-m</code> options are given, their values
623 are concatenated as separate paragraphs.
624 Lines starting with # and empty lines other than a
625 single line between paragraphs will be stripped out.
626 If you wish to keep them verbatim, use <code>--no-stripspace</code>.</p>
627 </dd>
628 <dt class="hdlist1">-F &lt;file&gt;</dt>
629 <dt class="hdlist1">--file=&lt;file&gt;</dt>
630 <dd>
631 <p>Take the note message from the given file. Use <em>-</em> to
632 read the note message from the standard input.
633 Lines starting with # and empty lines other than a
634 single line between paragraphs will be stripped out.
635 If you wish to keep them verbatim, use <code>--no-stripspace</code>.</p>
636 </dd>
637 <dt class="hdlist1">-C &lt;object&gt;</dt>
638 <dt class="hdlist1">--reuse-message=&lt;object&gt;</dt>
639 <dd>
640 <p>Take the given blob object (for example, another note) as the
641 note message. (Use <code>git</code> <code>notes</code> <code>copy</code> <em>&lt;object&gt;</em> instead to
642 copy notes between objects.). By default, message will be
643 copied verbatim, but if you wish to strip out the lines
644 starting with # and empty lines other than a single line
645 between paragraphs, use with`--stripspace` option.</p>
646 </dd>
647 <dt class="hdlist1">-c &lt;object&gt;</dt>
648 <dt class="hdlist1">--reedit-message=&lt;object&gt;</dt>
649 <dd>
650 <p>Like <em>-C</em>, but with <code>-c</code> the editor is invoked, so that
651 the user can further edit the note message.</p>
652 </dd>
653 <dt class="hdlist1">--allow-empty</dt>
654 <dd>
655 <p>Allow an empty note object to be stored. The default behavior is
656 to automatically remove empty notes.</p>
657 </dd>
658 <dt class="hdlist1">--[no-]separator, --separator=&lt;paragraph-break&gt;</dt>
659 <dd>
660 <p>Specify a string used as a custom inter-paragraph separator
661 (a newline is added at the end as needed). If <code>--no-separator</code>, no
662 separators will be added between paragraphs. Defaults to a blank
663 line.</p>
664 </dd>
665 <dt class="hdlist1">--[no-]stripspace</dt>
666 <dd>
667 <p>Strip leading and trailing whitespace from the note message.
668 Also strip out empty lines other than a single line between
669 paragraphs. Lines starting with # will be stripped out
670 in non-editor cases like <code>-m</code>, <code>-F</code> and <code>-C</code>, but not in
671 editor case like <code>git</code> <code>notes</code> <code>edit</code>, <code>-c</code>, etc.</p>
672 </dd>
673 <dt class="hdlist1">--ref &lt;ref&gt;</dt>
674 <dd>
675 <p>Manipulate the notes tree in &lt;ref&gt;. This overrides
676 <code>GIT_NOTES_REF</code> and the "core.notesRef" configuration. The ref
677 specifies the full refname when it begins with <code>refs/notes/</code>; when it
678 begins with <code>notes/</code>, <code>refs/</code> and otherwise <code>refs/notes/</code> is prefixed
679 to form a full name of the ref.</p>
680 </dd>
681 <dt class="hdlist1">--ignore-missing</dt>
682 <dd>
683 <p>Do not consider it an error to request removing notes from an
684 object that does not have notes attached to it.</p>
685 </dd>
686 <dt class="hdlist1">--stdin</dt>
687 <dd>
688 <p>Also read the object names to remove notes from the standard
689 input (there is no reason you cannot combine this with object
690 names from the command line).</p>
691 </dd>
692 <dt class="hdlist1">-n</dt>
693 <dt class="hdlist1">--dry-run</dt>
694 <dd>
695 <p>Do not remove anything; just report the object names whose notes
696 would be removed.</p>
697 </dd>
698 <dt class="hdlist1">-s &lt;strategy&gt;</dt>
699 <dt class="hdlist1">--strategy=&lt;strategy&gt;</dt>
700 <dd>
701 <p>When merging notes, resolve notes conflicts using the given
702 strategy. The following strategies are recognized: "manual"
703 (default), "ours", "theirs", "union" and "cat_sort_uniq".
704 This option overrides the "notes.mergeStrategy" configuration setting.
705 See the "NOTES MERGE STRATEGIES" section below for more
706 information on each notes merge strategy.</p>
707 </dd>
708 <dt class="hdlist1">--commit</dt>
709 <dd>
710 <p>Finalize an in-progress <em>git notes merge</em>. Use this option
711 when you have resolved the conflicts that <em>git notes merge</em>
712 stored in .git/NOTES_MERGE_WORKTREE. This amends the partial
713 merge commit created by <em>git notes merge</em> (stored in
714 .git/NOTES_MERGE_PARTIAL) by adding the notes in
715 .git/NOTES_MERGE_WORKTREE. The notes ref stored in the
716 .git/NOTES_MERGE_REF symref is updated to the resulting commit.</p>
717 </dd>
718 <dt class="hdlist1">--abort</dt>
719 <dd>
720 <p>Abort/reset an in-progress <em>git notes merge</em>, i.e. a notes merge
721 with conflicts. This simply removes all files related to the
722 notes merge.</p>
723 </dd>
724 <dt class="hdlist1">-q</dt>
725 <dt class="hdlist1">--quiet</dt>
726 <dd>
727 <p>When merging notes, operate quietly.</p>
728 </dd>
729 <dt class="hdlist1">-v</dt>
730 <dt class="hdlist1">--verbose</dt>
731 <dd>
732 <p>When merging notes, be more verbose.
733 When pruning notes, report all object names whose notes are
734 removed.</p>
735 </dd>
736 </dl>
737 </div>
738 </div>
739 </div>
740 <div class="sect1">
741 <h2 id="_discussion">DISCUSSION</h2>
742 <div class="sectionbody">
743 <div class="paragraph">
744 <p>Commit notes are blobs containing extra information about an object
745 (usually information to supplement a commit&#8217;s message). These blobs
746 are taken from notes refs. A notes ref is usually a branch which
747 contains "files" whose paths are the object names for the objects
748 they describe, with some directory separators included for performance
749 reasons <sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>.</p>
750 </div>
751 <div class="paragraph">
752 <p>Every notes change creates a new commit at the specified notes ref.
753 You can therefore inspect the history of the notes by invoking, e.g.,
754 <code>git</code> <code>log</code> <code>-p</code> <code>notes/commits</code>. Currently the commit message only records
755 which operation triggered the update, and the commit authorship is
756 determined according to the usual rules (see <a href="git-commit.html">git-commit(1)</a>).
757 These details may change in the future.</p>
758 </div>
759 <div class="paragraph">
760 <p>It is also permitted for a notes ref to point directly to a tree
761 object, in which case the history of the notes can be read with
762 <code>git</code> <code>log</code> <code>-p</code> <code>-g</code> <em>&lt;refname&gt;</em>.</p>
763 </div>
764 </div>
765 </div>
766 <div class="sect1">
767 <h2 id="_notes_merge_strategies">NOTES MERGE STRATEGIES</h2>
768 <div class="sectionbody">
769 <div class="paragraph">
770 <p>The default notes merge strategy is "manual", which checks out
771 conflicting notes in a special work tree for resolving notes conflicts
772 (.<code>git/NOTES_MERGE_WORKTREE</code>), and instructs the user to resolve the
773 conflicts in that work tree.
774 When done, the user can either finalize the merge with
775 <em>git notes merge --commit</em>, or abort the merge with
776 <em>git notes merge --abort</em>.</p>
777 </div>
778 <div class="paragraph">
779 <p>Users may select an automated merge strategy from among the following using
780 either -s/--strategy option or configuring notes.mergeStrategy accordingly:</p>
781 </div>
782 <div class="paragraph">
783 <p>"ours" automatically resolves conflicting notes in favor of the local
784 version (i.e. the current notes ref).</p>
785 </div>
786 <div class="paragraph">
787 <p>"theirs" automatically resolves notes conflicts in favor of the remote
788 version (i.e. the given notes ref being merged into the current notes
789 ref).</p>
790 </div>
791 <div class="paragraph">
792 <p>"union" automatically resolves notes conflicts by concatenating the
793 local and remote versions.</p>
794 </div>
795 <div class="paragraph">
796 <p>"cat_sort_uniq" is similar to "union", but in addition to concatenating
797 the local and remote versions, this strategy also sorts the resulting
798 lines, and removes duplicate lines from the result. This is equivalent
799 to applying the "cat | sort | uniq" shell pipeline to the local and
800 remote versions. This strategy is useful if the notes follow a line-based
801 format where one wants to avoid duplicated lines in the merge result.
802 Note that if either the local or remote version contain duplicate lines
803 prior to the merge, these will also be removed by this notes merge
804 strategy.</p>
805 </div>
806 </div>
807 </div>
808 <div class="sect1">
809 <h2 id="_examples">EXAMPLES</h2>
810 <div class="sectionbody">
811 <div class="paragraph">
812 <p>You can use notes to add annotations with information that was not
813 available at the time a commit was written.</p>
814 </div>
815 <div class="listingblock">
816 <div class="content">
817 <pre>$ git notes add -m 'Tested-by: Johannes Sixt &lt;j6t@kdbg.org&gt;' 72a144e2
818 $ git show -s 72a144e
819 [...]
820 Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
822 Notes:
823 Tested-by: Johannes Sixt &lt;j6t@kdbg.org&gt;</pre>
824 </div>
825 </div>
826 <div class="paragraph">
827 <p>In principle, a note is a regular Git blob, and any kind of
828 (non-)format is accepted. You can binary-safely create notes from
829 arbitrary files using <em>git hash-object</em>:</p>
830 </div>
831 <div class="listingblock">
832 <div class="content">
833 <pre>$ cc *.c
834 $ blob=$(git hash-object -w a.out)
835 $ git notes --ref=built add --allow-empty -C "$blob" HEAD</pre>
836 </div>
837 </div>
838 <div class="paragraph">
839 <p>(You cannot simply use <code>git</code> <code>notes</code> <code>--ref=built</code> <code>add</code> <code>-F</code> <code>a.out</code> <code>HEAD</code>
840 because that is not binary-safe.)
841 Of course, it doesn&#8217;t make much sense to display non-text-format notes
842 with <em>git log</em>, so if you use such notes, you&#8217;ll probably need to write
843 some special-purpose tools to do something useful with them.</p>
844 </div>
845 </div>
846 </div>
847 <div class="sect1">
848 <h2 id="CONFIGURATION">CONFIGURATION</h2>
849 <div class="sectionbody">
850 <div class="dlist">
851 <dl>
852 <dt class="hdlist1">core.notesRef</dt>
853 <dd>
854 <p>Notes ref to read and manipulate instead of
855 <code>refs/notes/commits</code>. Must be an unabbreviated ref name.
856 This setting can be overridden through the environment and
857 command line.</p>
858 </dd>
859 </dl>
860 </div>
861 <div class="paragraph">
862 <p>Everything above this line in this section isn&#8217;t included from the
863 <a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
864 same as what&#8217;s found there:</p>
865 </div>
866 <div class="dlist">
867 <dl>
868 <dt class="hdlist1">notes.mergeStrategy</dt>
869 <dd>
870 <p>Which merge strategy to choose by default when resolving notes
871 conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
872 <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See the "NOTES MERGE STRATEGIES"
873 section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.</p>
874 <div class="paragraph">
875 <p>This setting can be overridden by passing the <code>--strategy</code> option to
876 <a href="git-notes.html">git-notes(1)</a>.</p>
877 </div>
878 </dd>
879 <dt class="hdlist1">notes.&lt;name&gt;.mergeStrategy</dt>
880 <dd>
881 <p>Which merge strategy to choose when doing a notes merge into
882 refs/notes/&lt;name&gt;. This overrides the more general
883 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
884 <a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.</p>
885 </dd>
886 <dt class="hdlist1">notes.displayRef</dt>
887 <dd>
888 <p>Which ref (or refs, if a glob or specified more than once), in
889 addition to the default set by <code>core.notesRef</code> or
890 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
891 messages with the <em>git log</em> family of commands.</p>
892 <div class="paragraph">
893 <p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
894 environment variable, which must be a colon separated list of refs or
895 globs.</p>
896 </div>
897 <div class="paragraph">
898 <p>A warning will be issued for refs that do not exist,
899 but a glob that does not match any refs is silently ignored.</p>
900 </div>
901 <div class="paragraph">
902 <p>This setting can be disabled by the <code>--no-notes</code> option to the <em>git
903 log</em> family of commands, or by the <code>--notes=</code><em>&lt;ref&gt;</em> option accepted by
904 those commands.</p>
905 </div>
906 <div class="paragraph">
907 <p>The effective value of "core.notesRef" (possibly overridden by
908 GIT_NOTES_REF) is also implicitly added to the list of refs to be
909 displayed.</p>
910 </div>
911 </dd>
912 <dt class="hdlist1">notes.rewrite.&lt;command&gt;</dt>
913 <dd>
914 <p>When rewriting commits with &lt;command&gt; (currently <code>amend</code> or
915 <code>rebase</code>), if this variable is <code>false</code>, git will not copy
916 notes from the original to the rewritten commit. Defaults to
917 <code>true</code>. See also "<code>notes.rewriteRef</code>" below.</p>
918 <div class="paragraph">
919 <p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
920 environment variable, which must be a colon separated list of refs or
921 globs.</p>
922 </div>
923 </dd>
924 <dt class="hdlist1">notes.rewriteMode</dt>
925 <dd>
926 <p>When copying notes during a rewrite (see the
927 "notes.rewrite.&lt;command&gt;" option), determines what to do if
928 the target commit already has a note. Must be one of
929 <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
930 Defaults to <code>concatenate</code>.</p>
931 <div class="paragraph">
932 <p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
933 environment variable.</p>
934 </div>
935 </dd>
936 <dt class="hdlist1">notes.rewriteRef</dt>
937 <dd>
938 <p>When copying notes during a rewrite, specifies the (fully
939 qualified) ref whose notes should be copied. May be a glob,
940 in which case notes in all matching refs will be copied. You
941 may also specify this configuration several times.</p>
942 <div class="paragraph">
943 <p>Does not have a default value; you must configure this variable to
944 enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
945 rewriting for the default commit notes.</p>
946 </div>
947 <div class="paragraph">
948 <p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
949 See <code>notes.rewrite.</code><em>&lt;command&gt;</em> above for a further description of its format.</p>
950 </div>
951 </dd>
952 </dl>
953 </div>
954 </div>
955 </div>
956 <div class="sect1">
957 <h2 id="_environment">ENVIRONMENT</h2>
958 <div class="sectionbody">
959 <div class="dlist">
960 <dl>
961 <dt class="hdlist1"><code>GIT_NOTES_REF</code></dt>
962 <dd>
963 <p>Which ref to manipulate notes from, instead of <code>refs/notes/commits</code>.
964 This overrides the <code>core.notesRef</code> setting.</p>
965 </dd>
966 <dt class="hdlist1"><code>GIT_NOTES_DISPLAY_REF</code></dt>
967 <dd>
968 <p>Colon-delimited list of refs or globs indicating which refs,
969 in addition to the default from <code>core.notesRef</code> or
970 <code>GIT_NOTES_REF</code>, to read notes from when showing commit
971 messages.
972 This overrides the <code>notes.displayRef</code> setting.</p>
973 <div class="paragraph">
974 <p>A warning will be issued for refs that do not exist, but a glob that
975 does not match any refs is silently ignored.</p>
976 </div>
977 </dd>
978 <dt class="hdlist1"><code>GIT_NOTES_REWRITE_MODE</code></dt>
979 <dd>
980 <p>When copying notes during a rewrite, what to do if the target
981 commit already has a note.
982 Must be one of <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
983 This overrides the <code>core.rewriteMode</code> setting.</p>
984 </dd>
985 <dt class="hdlist1"><code>GIT_NOTES_REWRITE_REF</code></dt>
986 <dd>
987 <p>When rewriting commits, which notes to copy from the original
988 to the rewritten commit. Must be a colon-delimited list of
989 refs or globs.</p>
990 <div class="paragraph">
991 <p>If not set in the environment, the list of notes to copy depends
992 on the <code>notes.rewrite.</code><em>&lt;command&gt;</em> and <code>notes.rewriteRef</code> settings.</p>
993 </div>
994 </dd>
995 </dl>
996 </div>
997 </div>
998 </div>
999 <div class="sect1">
1000 <h2 id="_git">GIT</h2>
1001 <div class="sectionbody">
1002 <div class="paragraph">
1003 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1004 </div>
1005 </div>
1006 </div>
1007 </div>
1008 <div id="footnotes">
1009 <hr/>
1010 <div class="footnote" id="_footnotedef_1">
1011 <a href="#_footnoteref_1">1</a>. Permitted pathnames have the form <em>bf</em><code>/</code><em>fe</em><code>/</code><em>30</em><code>/</code><em>&#8230;&#8203;</em><code>/</code><em>680d5a&#8230;&#8203;</em>: a sequence of directory names of two hexadecimal digits each followed by a filename with the rest of the object ID.
1012 </div>
1013 </div>
1014 <div id="footer">
1015 <div id="footer-text">
1016 Last updated 2024-11-01 22:46:55 -0700
1017 </div>
1018 </div>
1019 </body>
1020 </html>