Google Git
Sign in
chromium / external / gitster / git-htmldocs / b358e217ee50e22d66a3a5ababe7e84c41d553c4 / . / git-notes.html
blob: ff6ee15df92438b360e1b793f4624bf7d2cb4ed5 [file] [log] [blame]
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]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"/>
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]7<meta name="generator" content="Asciidoctor 2.0.23"/>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]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"; */
14html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15a{background:none}
16a:focus{outline:thin dotted}
17a:active,a:hover{outline:0}
18h1{font-size:2em;margin:.67em 0}
19b,strong{font-weight:bold}
20abbr{font-size:.9em}
21abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22dfn{font-style:italic}
23hr{height:0}
24mark{background:#ff0;color:#000}
25code,kbd,pre,samp{font-family:monospace;font-size:1em}
26pre{white-space:pre-wrap}
27q{quotes:"\201C" "\201D" "\2018" "\2019"}
28small{font-size:80%}
29sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30sup{top:-.5em}
31sub{bottom:-.25em}
32img{border:0}
33svg:not(:root){overflow:hidden}
34figure{margin:0}
35audio,video{display:inline-block}
36audio:not([controls]){display:none;height:0}
37fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38legend{border:0;padding:0}
39button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40button,input{line-height:normal}
41button,select{text-transform:none}
42button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43button[disabled],html input[disabled]{cursor:default}
44input[type=checkbox],input[type=radio]{padding:0}
45button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46textarea{overflow:auto;vertical-align:top}
47table{border-collapse:collapse;border-spacing:0}
48*,::before,::after{box-sizing:border-box}
49html,body{font-size:100%}
50body{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}
51a:hover{cursor:pointer}
52img,object,embed{max-width:100%;height:auto}
53object,embed{height:100%}
54img{-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}
62img,object,svg{display:inline-block;vertical-align:middle}
63textarea{height:auto;min-height:50px}
64select{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}
66div,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}
67a{color:#2156a5;text-decoration:underline;line-height:inherit}
68a:hover,a:focus{color:#1d4b8f}
69a img{border:0}
70p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71p aside{font-size:.875em;line-height:1.35;font-style:italic}
72h1,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}
73h1 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}
74h1{font-size:2.125em}
75h2{font-size:1.6875em}
76h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77h4,h5{font-size:1.125em}
78h6{font-size:1em}
79hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80em,i{font-style:italic;line-height:inherit}
81strong,b{font-weight:bold;line-height:inherit}
82small{font-size:60%;line-height:inherit}
83code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85ul,ol{margin-left:1.5em}
86ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87ul.circle{list-style-type:circle}
88ul.disc{list-style-type:disc}
89ul.square{list-style-type:square}
90ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92dl dt{margin-bottom:.3125em;font-weight:bold}
93dl dd{margin-bottom:1.25em}
94blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95blockquote,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}
97h1{font-size:2.75em}
98h2{font-size:2.3125em}
99h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100h4{font-size:1.4375em}}
101table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102table thead,table tfoot{background:#f7f8f7}
103table 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}
104table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105table tr.even,table tr.alt{background:#f8f8f7}
106table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108h1 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}
117pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119pre>code{display:block}
120pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121em em{font-style:normal}
122strong strong{font-weight:400}
123.keyseq{color:rgba(51,51,51,.8)}
124kbd{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}
132b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133b.button::before{content:"[";padding:0 3px 0 2px}
134b.button::after{content:"]";padding:0 2px 0 3px}
135p 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}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]143#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]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}
164body.toc2{padding-left:15em;padding-right:0}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]165body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]166#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}
167#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168#toc.toc2>ul{font-size:.9em;margin-bottom:0}
169#toc.toc2 ul ul{margin-left:0;padding-left:1em}
170#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171body.toc2.toc-right{padding-left:0;padding-right:15em}
172body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174#toc.toc2{width:20em}
175#toc.toc2 #toctitle{font-size:1.375em}
176#toc.toc2>ul{font-size:.95em}
177#toc.toc2 ul ul{padding-left:1.25em}
178body.toc2.toc-right{padding-left:0;padding-right:20em}}
179#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180#content #toc>:first-child{margin-top:0}
181#content #toc>:last-child{margin-bottom:0}
182#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184#content{margin-bottom:.625em}
185.sect1{padding-bottom:.625em}
186@media screen and (min-width:768px){#content{margin-bottom:1.25em}
187.sect1{padding-bottom:1.25em}}
188.sect1:last-child{padding-bottom:0}
189.sect1+.sect1{border-top:1px solid #e7e7e9}
190#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}
191#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}
192#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}
193#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}
194#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}
195details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196details{margin-left:1.25rem}
197details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198details>summary::-webkit-details-marker{display:none}
199details>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%)}
200details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202.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}
203table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204.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)}
205.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206.admonitionblock>table td.icon{text-align:center;width:80px}
207.admonitionblock>table td.icon img{max-width:none}
208.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209.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}
210.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
213.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
215.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}
216.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
217@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
218@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
219.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
220.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
221.listingblock>.content{position:relative}
222.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}
223.listingblock:hover code[data-lang]::before{display:block}
224.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
225.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
226.listingblock pre.highlightjs{padding:0}
227.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
228.listingblock pre.prettyprint{border-width:0}
229.prettyprint{background:#f7f7f8}
230pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
231pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
232pre.prettyprint li code[data-lang]::before{opacity:1}
233pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
234table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
235table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
236table.linenotable td.code{padding-left:.75em}
237table.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}
238pre.pygments span.linenos{display:inline-block;margin-right:.75em}
239.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
240.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
241.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}
242.quoteblock blockquote{margin:0;padding:0;border:0}
243.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)}
244.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
245.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
246.verseblock{margin:0 1em 1.25em}
247.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}
248.verseblock pre strong{font-weight:400}
249.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251.quoteblock .attribution br,.verseblock .attribution br{display:none}
252.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
254.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}
255.quoteblock.abstract{margin:0 1em 1.25em;display:block}
256.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
257.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
258.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
259.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
260.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
261p.tableblock:last-child{margin-bottom:0}
262td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
263td.tableblock>.content>:last-child{margin-bottom:-1.25em}
264table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
265table.grid-all>*>tr>*{border-width:1px}
266table.grid-cols>*>tr>*{border-width:0 1px}
267table.grid-rows>*>tr>*{border-width:1px 0}
268table.frame-all{border-width:1px}
269table.frame-ends{border-width:1px 0}
270table.frame-sides{border-width:0 1px}
271table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
272table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
273table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
274table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
275table.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}
276th.halign-left,td.halign-left{text-align:left}
277th.halign-right,td.halign-right{text-align:right}
278th.halign-center,td.halign-center{text-align:center}
279th.valign-top,td.valign-top{vertical-align:top}
280th.valign-bottom,td.valign-bottom{vertical-align:bottom}
281th.valign-middle,td.valign-middle{vertical-align:middle}
282table thead th,table tfoot th{font-weight:bold}
283tbody tr th{background:#f7f8f7}
284tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
285p.tableblock>code:only-child{background:none;padding:0}
286p.tableblock{font-size:1em}
287ol{margin-left:1.75em}
288ul li ol{margin-left:1.5em}
289dl dd{margin-left:1.125em}
290dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
291li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
292ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
293ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
294ul.unstyled,ol.unstyled{margin-left:0}
295li>p:empty:only-child::before{content:"";display:inline-block}
296ul.checklist>li>p:first-child{margin-left:-1em}
297ul.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}
298ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
299ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
300ul.inline>li{margin-left:1.25em}
301.unstyled dl dt{font-weight:400;font-style:normal}
302ol.arabic{list-style-type:decimal}
303ol.decimal{list-style-type:decimal-leading-zero}
304ol.loweralpha{list-style-type:lower-alpha}
305ol.upperalpha{list-style-type:upper-alpha}
306ol.lowerroman{list-style-type:lower-roman}
307ol.upperroman{list-style-type:upper-roman}
308ol.lowergreek{list-style-type:lower-greek}
309.hdlist>table,.colist>table{border:0;background:none}
310.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
311td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
312td.hdlist1{font-weight:bold;padding-bottom:1.25em}
313td.hdlist2{word-wrap:anywhere}
314.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
315.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
316.colist td:not([class]):first-child img{max-width:none}
317.colist td:not([class]):last-child{padding:.25em 0}
318.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
319.imageblock.left{margin:.25em .625em 1.25em 0}
320.imageblock.right{margin:.25em 0 1.25em .625em}
321.imageblock>.title{margin-bottom:0}
322.imageblock.thumb,.imageblock.th{border-width:6px}
323.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
324.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
325.image.left{margin-right:.625em}
326.image.right{margin-left:.625em}
327a.image{text-decoration:none;display:inline-block}
328a.image object{pointer-events:none}
329sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
330sup.footnote a,sup.footnoteref a{text-decoration:none}
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]331sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]332#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
333#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
334#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
335#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
336#footnotes .footnote:last-of-type{margin-bottom:0}
337#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
338div.unbreakable{page-break-inside:avoid}
339.big{font-size:larger}
340.small{font-size:smaller}
341.underline{text-decoration:underline}
342.overline{text-decoration:overline}
343.line-through{text-decoration:line-through}
344.aqua{color:#00bfbf}
345.aqua-background{background:#00fafa}
346.black{color:#000}
347.black-background{background:#000}
348.blue{color:#0000bf}
349.blue-background{background:#0000fa}
350.fuchsia{color:#bf00bf}
351.fuchsia-background{background:#fa00fa}
352.gray{color:#606060}
353.gray-background{background:#7d7d7d}
354.green{color:#006000}
355.green-background{background:#007d00}
356.lime{color:#00bf00}
357.lime-background{background:#00fa00}
358.maroon{color:#600000}
359.maroon-background{background:#7d0000}
360.navy{color:#000060}
361.navy-background{background:#00007d}
362.olive{color:#606000}
363.olive-background{background:#7d7d00}
364.purple{color:#600060}
365.purple-background{background:#7d007d}
366.red{color:#bf0000}
367.red-background{background:#fa0000}
368.silver{color:#909090}
369.silver-background{background:#bcbcbc}
370.teal{color:#006060}
371.teal-background{background:#007d7d}
372.white{color:#bfbfbf}
373.white-background{background:#fafafa}
374.yellow{color:#bfbf00}
375.yellow-background{background:#fafa00}
376span.icon>.fa{cursor:default}
377a span.icon>.fa{cursor:inherit}
378.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
379.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
380.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
381.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
382.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
383.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
384.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}
385.conum[data-value] *{color:#fff!important}
386.conum[data-value]+b{display:none}
387.conum[data-value]::after{content:attr(data-value)}
388pre .conum[data-value]{position:relative;top:-.125em}
389b.conum *{color:inherit!important}
390.conum:not([data-value]):empty{display:none}
391dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
392h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
393p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
394p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
395p{margin-bottom:1.25rem}
396.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
397.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
398.print-only{display:none!important}
399@page{margin:1.25cm .75cm}
400@media print{*{box-shadow:none!important;text-shadow:none!important}
401html{font-size:80%}
402a{color:inherit!important;text-decoration:underline!important}
403a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
404a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
405abbr[title]{border-bottom:1px dotted}
406abbr[title]::after{content:" (" attr(title) ")"}
407pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
408thead{display:table-header-group}
409svg{max-width:100%}
410p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
411h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
412#header,#content,#footnotes,#footer{max-width:none}
413#toc,.sidebarblock,.exampleblock>.content{background:none!important}
414#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
415body.book #header{text-align:center}
416body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
417body.book #header .details{border:0!important;display:block;padding:0!important}
418body.book #header .details span:first-child{margin-left:0!important}
419body.book #header .details br{display:block}
420body.book #header .details br+span::before{content:none!important}
421body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
422body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
423.listingblock code[data-lang]::before{display:block}
424#footer{padding:0 .9375em}
425.hide-on-print{display:none!important}
426.print-only{display:block!important}
427.hide-for-print{display:none!important}
428.show-for-print{display:inherit!important}}
429@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
430.sect1{padding:0!important}
431.sect1+.sect1{border:0}
432#footer{background:none}
433#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
434@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
435</style>
436<style>
437pre>code {
438 display: inline;
439}
440</style>
441</head>
442<body class="manpage">
443<div id="header">
444<h1>git-notes(1) Manual Page</h1>
445<h2 id="_name">NAME</h2>
446<div class="sectionbody">
447<p>git-notes - Add or inspect object notes</p>
448</div>
449</div>
450<div id="content">
451<div class="sect1">
452<h2 id="_synopsis">SYNOPSIS</h2>
453<div class="sectionbody">
454<div class="verseblock">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]455<pre class="content"><code>git</code> <code>notes</code> [<code>list</code> [<em>&lt;object&gt;</em>]]
456<code>git</code> <code>notes</code> <code>add</code> [<code>-f</code>] [<code>--allow-empty</code>] [<code>--</code>[<code>no-</code>]<code>separator</code> | <code>--separator=</code><em>&lt;paragraph-break&gt;</em>] [<code>--</code>[<code>no-</code>]<code>stripspace</code>] [<code>-F</code> <em>&lt;file&gt;</em> | <code>-m</code> <em>&lt;msg&gt;</em> | (<code>-c</code> | <code>-C</code>) <em>&lt;object&gt;</em>] [<code>-e</code>] [<em>&lt;object&gt;</em>]
457<code>git</code> <code>notes</code> <code>copy</code> [<code>-f</code>] ( <code>--stdin</code> | <em>&lt;from-object&gt;</em> [<em>&lt;to-object&gt;</em>] )
458<code>git</code> <code>notes</code> <code>append</code> [<code>--allow-empty</code>] [<code>--</code>[<code>no-</code>]<code>separator</code> | <code>--separator=</code><em>&lt;paragraph-break&gt;</em>] [<code>--</code>[<code>no-</code>]<code>stripspace</code>] [<code>-F</code> <em>&lt;file&gt;</em> | <code>-m</code> <em>&lt;msg&gt;</em> | (<code>-c</code> | <code>-C</code>) <em>&lt;object&gt;</em>] [<code>-e</code>] [<em>&lt;object&gt;</em>]
459<code>git</code> <code>notes</code> <code>edit</code> [<code>--allow-empty</code>] [<em>&lt;object&gt;</em>] [<code>--</code>[<code>no-</code>]<code>stripspace</code>]
460<code>git</code> <code>notes</code> <code>show</code> [<em>&lt;object&gt;</em>]
461<code>git</code> <code>notes</code> <code>merge</code> [<code>-v</code> | <code>-q</code>] [<code>-s</code> <em>&lt;strategy&gt;</em> ] <em>&lt;notes-ref&gt;</em>
462<code>git</code> <code>notes</code> <code>merge</code> <code>--commit</code> [<code>-v</code> | <code>-q</code>]
463<code>git</code> <code>notes</code> <code>merge</code> <code>--abort</code> [<code>-v</code> | <code>-q</code>]
464<code>git</code> <code>notes</code> <code>remove</code> [<code>--ignore-missing</code>] [<code>--stdin</code>] [<em>&lt;object&gt;</em>&#8230;&#8203;]
465<code>git</code> <code>notes</code> <code>prune</code> [<code>-n</code>] [<code>-v</code>]
466<code>git</code> <code>notes</code> <code>get-ref</code></pre>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]467</div>
468</div>
469</div>
470<div class="sect1">
471<h2 id="_description">DESCRIPTION</h2>
472<div class="sectionbody">
473<div class="paragraph">
474<p>Adds, removes, or reads notes attached to objects, without touching
475the objects themselves.</p>
476</div>
477<div class="paragraph">
478<p>By default, notes are saved to and read from <code>refs/notes/commits</code>, but
479this default can be overridden. See the OPTIONS, CONFIGURATION, and
480ENVIRONMENT sections below. If this ref does not exist, it will be
481quietly created when it is first needed to store a note.</p>
482</div>
483<div class="paragraph">
484<p>A typical use of notes is to supplement a commit message without
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]485changing the commit itself. Notes can be shown by <code>git</code> <code>log</code> along with
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]486the original commit message. To distinguish these notes from the
487message stored in the commit object, the notes are indented like the
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]488message, after an unindented line saying "Notes (<em>&lt;refname&gt;</em>):" (or
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]489"Notes:" for <code>refs/notes/commits</code>).</p>
490</div>
491<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]492<p>Notes can also be added to patches prepared with <code>git</code> <code>format-patch</code> by
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]493using the <code>--notes</code> option. Such notes are added as a patch commentary
494after a three dash separator line.</p>
495</div>
496<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]497<p>To change which notes are shown by <code>git</code> <code>log</code>, see the
498<code>notes.displayRef</code> discussion in <a href="#CONFIGURATION">CONFIGURATION</a>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]499</div>
500<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]501<p>See the <code>notes.rewrite.</code><em>&lt;command&gt;</em> configuration for a way to carry
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]502notes across commands that rewrite commits.</p>
503</div>
504</div>
505</div>
506<div class="sect1">
507<h2 id="_subcommands">SUBCOMMANDS</h2>
508<div class="sectionbody">
509<div class="dlist">
510<dl>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]511<dt class="hdlist1"><code>list</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]512<dd>
513<p>List the notes object for a given object. If no object is
514given, show a list of all note objects and the objects they
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]515annotate (in the format "<em>&lt;note-object&gt;</em> <em>&lt;annotated-object&gt;</em>").
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]516This is the default subcommand if no subcommand is given.</p>
517</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]518<dt class="hdlist1"><code>add</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]519<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]520<p>Add notes for a given object (defaults to <code>HEAD</code>). Abort if the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]521object already has notes (use <code>-f</code> to overwrite existing notes).
522However, if you&#8217;re using <code>add</code> interactively (using an editor
523to supply the notes contents), then - instead of aborting -
524the existing notes will be opened in the editor (like the <code>edit</code>
525subcommand). If you specify multiple <code>-m</code> and <code>-F</code>, a blank
526line will be inserted between the messages. Use the <code>--separator</code>
Junio C Hamanof4e4f532024-11-02 05:48:11[diff] [blame]527option to insert other delimiters. You can use <code>-e</code> to edit and
528fine-tune the message(s) supplied from <code>-m</code> and <code>-F</code> options
529interactively (using an editor) before adding the note.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]530</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]531<dt class="hdlist1"><code>copy</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]532<dd>
533<p>Copy the notes for the first object onto the second object (defaults to
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]534<code>HEAD</code>). Abort if the second object already has notes, or if the first
535object has none (use <code>-f</code> to overwrite existing notes to the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]536second object). This subcommand is equivalent to:
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]537<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>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]538<div class="paragraph">
539<p>In <code>--stdin</code> mode, take lines in the format</p>
540</div>
541<div class="listingblock">
542<div class="content">
543<pre>&lt;from-object&gt; SP &lt;to-object&gt; [ SP &lt;rest&gt; ] LF</pre>
544</div>
545</div>
546<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]547<p>on standard input, and copy the notes from each <em>&lt;from-object&gt;</em> to its
548corresponding <em>&lt;to-object&gt;</em>. (The optional <em>&lt;rest&gt;</em> is ignored so that
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]549the command can read the input given to the <code>post-rewrite</code> hook.)</p>
550</div>
551</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]552<dt class="hdlist1"><code>append</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]553<dd>
554<p>Append new message(s) given by <code>-m</code> or <code>-F</code> options to an
555existing note, or add them as a new note if one does not
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]556exist, for the object (defaults to <code>HEAD</code>). When appending to
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]557an existing note, a blank line is added before each new
558message as an inter-paragraph separator. The separator can
Junio C Hamanof4e4f532024-11-02 05:48:11[diff] [blame]559be customized with the <code>--separator</code> option.
560Edit the notes to be appended given by <code>-m</code> and <code>-F</code> options with
561<code>-e</code> interactively (using an editor) before appending the note.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]562</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]563<dt class="hdlist1"><code>edit</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]564<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]565<p>Edit the notes for a given object (defaults to <code>HEAD</code>).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]566</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]567<dt class="hdlist1"><code>show</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]568<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]569<p>Show the notes for a given object (defaults to <code>HEAD</code>).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]570</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]571<dt class="hdlist1"><code>merge</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]572<dd>
573<p>Merge the given notes ref into the current notes ref.
574This will try to merge the changes made by the given
575notes ref (called "remote") since the merge-base (if
576any) into the current notes ref (called "local").</p>
577<div class="paragraph">
578<p>If conflicts arise and a strategy for automatically resolving
579conflicting notes (see the "NOTES MERGE STRATEGIES" section) is not given,
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]580the <code>manual</code> resolver is used. This resolver checks out the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]581conflicting notes in a special worktree (.<code>git/NOTES_MERGE_WORKTREE</code>),
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]582and instructs the user to manually resolve the conflicts there.
583When done, the user can either finalize the merge with
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]584<code>git</code> <code>notes</code> <code>merge</code> <code>--commit</code>, or abort the merge with
585<code>git</code> <code>notes</code> <code>merge</code> <code>--abort</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]586</div>
587</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]588<dt class="hdlist1"><code>remove</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]589<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]590<p>Remove the notes for given objects (defaults to <code>HEAD</code>). When
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]591giving zero or one object from the command line, this is
592equivalent to specifying an empty note message to
593the <code>edit</code> subcommand.</p>
594</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]595<dt class="hdlist1"><code>prune</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]596<dd>
597<p>Remove all notes for non-existing/unreachable objects.</p>
598</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]599<dt class="hdlist1"><code>get-ref</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]600<dd>
601<p>Print the current notes ref. This provides an easy way to
602retrieve the current notes ref (e.g. from scripts).</p>
603</dd>
604</dl>
605</div>
606</div>
607</div>
608<div class="sect1">
609<h2 id="_options">OPTIONS</h2>
610<div class="sectionbody">
611<div class="dlist">
612<dl>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]613<dt class="hdlist1"><code>-f</code></dt>
614<dt class="hdlist1"><code>--force</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]615<dd>
616<p>When adding notes to an object that already has notes,
617overwrite the existing notes (instead of aborting).</p>
618</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]619<dt class="hdlist1"><code>-m</code> <em>&lt;msg&gt;</em></dt>
620<dt class="hdlist1"><code>--message=</code><em>&lt;msg&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]621<dd>
622<p>Use the given note message (instead of prompting).
623If multiple <code>-m</code> options are given, their values
624are concatenated as separate paragraphs.
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]625Lines starting with # and empty lines other than a
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]626single line between paragraphs will be stripped out.
627If you wish to keep them verbatim, use <code>--no-stripspace</code>.</p>
628</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]629<dt class="hdlist1"><code>-F</code> <em>&lt;file&gt;</em></dt>
630<dt class="hdlist1"><code>--file=</code><em>&lt;file&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]631<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]632<p>Take the note message from the given file. Use <code>-</code> to
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]633read the note message from the standard input.
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]634Lines starting with # and empty lines other than a
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]635single line between paragraphs will be stripped out.
636If you wish to keep them verbatim, use <code>--no-stripspace</code>.</p>
637</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]638<dt class="hdlist1"><code>-C</code> <em>&lt;object&gt;</em></dt>
639<dt class="hdlist1"><code>--reuse-message=</code><em>&lt;object&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]640<dd>
641<p>Take the given blob object (for example, another note) as the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]642note message. (Use <code>git</code> <code>notes</code> <code>copy</code> <em>&lt;object&gt;</em> instead to
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]643copy notes between objects.). By default, message will be
644copied verbatim, but if you wish to strip out the lines
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]645starting with # and empty lines other than a single line
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]646between paragraphs, use with <code>--stripspace</code> option.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]647</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]648<dt class="hdlist1"><code>-c</code> <em>&lt;object&gt;</em></dt>
649<dt class="hdlist1"><code>--reedit-message=</code><em>&lt;object&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]650<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]651<p>Like <code>-C</code>, but with <code>-c</code> the editor is invoked, so that
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]652the user can further edit the note message.</p>
653</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]654<dt class="hdlist1"><code>--allow-empty</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]655<dd>
656<p>Allow an empty note object to be stored. The default behavior is
657to automatically remove empty notes.</p>
658</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]659<dt class="hdlist1"><code>--</code>[<code>no-</code>]<code>separator</code></dt>
660<dt class="hdlist1"><code>--separator=</code><em>&lt;paragraph-break&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]661<dd>
662<p>Specify a string used as a custom inter-paragraph separator
663(a newline is added at the end as needed). If <code>--no-separator</code>, no
664separators will be added between paragraphs. Defaults to a blank
665line.</p>
666</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]667<dt class="hdlist1"><code>--</code>[<code>no-</code>]<code>stripspace</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]668<dd>
669<p>Strip leading and trailing whitespace from the note message.
670Also strip out empty lines other than a single line between
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]671paragraphs. Lines starting with # will be stripped out
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]672in non-editor cases like <code>-m</code>, <code>-F</code> and <code>-C</code>, but not in
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]673editor case like <code>git</code> <code>notes</code> <code>edit</code>, <code>-c</code>, etc.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]674</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]675<dt class="hdlist1"><code>--ref</code> <em>&lt;ref&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]676<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]677<p>Manipulate the notes tree in <em>&lt;ref&gt;</em>. This overrides
678<code>GIT_NOTES_REF</code> and the <code>core.notesRef</code> configuration. The ref
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]679specifies the full refname when it begins with <code>refs/notes/</code>; when it
680begins with <code>notes/</code>, <code>refs/</code> and otherwise <code>refs/notes/</code> is prefixed
681to form a full name of the ref.</p>
682</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]683<dt class="hdlist1"><code>--ignore-missing</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]684<dd>
685<p>Do not consider it an error to request removing notes from an
686object that does not have notes attached to it.</p>
687</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]688<dt class="hdlist1"><code>--stdin</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]689<dd>
690<p>Also read the object names to remove notes from the standard
691input (there is no reason you cannot combine this with object
692names from the command line).</p>
693</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]694<dt class="hdlist1"><code>-n</code></dt>
695<dt class="hdlist1"><code>--dry-run</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]696<dd>
697<p>Do not remove anything; just report the object names whose notes
698would be removed.</p>
699</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]700<dt class="hdlist1"><code>-s</code> <em>&lt;strategy&gt;</em></dt>
701<dt class="hdlist1"><code>--strategy=</code><em>&lt;strategy&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]702<dd>
703<p>When merging notes, resolve notes conflicts using the given
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]704strategy. The following strategies are recognized: <code>manual</code>
705(default), <code>ours</code>, <code>theirs</code>, <code>union</code> and <code>cat_sort_uniq</code>.
706This option overrides the <code>notes.mergeStrategy</code> configuration setting.
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]707See the "NOTES MERGE STRATEGIES" section below for more
708information on each notes merge strategy.</p>
709</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]710<dt class="hdlist1"><code>--commit</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]711<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]712<p>Finalize an in-progress <code>git</code> <code>notes</code> <code>merge</code>. Use this option
713when you have resolved the conflicts that <code>git</code> <code>notes</code> <code>merge</code>
714stored in .<code>git/NOTES_MERGE_WORKTREE</code>. This amends the partial
715merge commit created by <code>git</code> <code>notes</code> <code>merge</code> (stored in
716.<code>git/NOTES_MERGE_PARTIAL</code>) by adding the notes in
717.<code>git/NOTES_MERGE_WORKTREE</code>. The notes ref stored in the
718.<code>git/NOTES_MERGE_REF</code> symref is updated to the resulting commit.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]719</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]720<dt class="hdlist1"><code>--abort</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]721<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]722<p>Abort/reset an in-progress <code>git</code> <code>notes</code> <code>merge</code>, i.e. a notes merge
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]723with conflicts. This simply removes all files related to the
724notes merge.</p>
725</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]726<dt class="hdlist1"><code>-q</code></dt>
727<dt class="hdlist1"><code>--quiet</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]728<dd>
729<p>When merging notes, operate quietly.</p>
730</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]731<dt class="hdlist1"><code>-v</code></dt>
732<dt class="hdlist1"><code>--verbose</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]733<dd>
734<p>When merging notes, be more verbose.
735When pruning notes, report all object names whose notes are
736removed.</p>
737</dd>
738</dl>
739</div>
740</div>
741</div>
742<div class="sect1">
743<h2 id="_discussion">DISCUSSION</h2>
744<div class="sectionbody">
745<div class="paragraph">
746<p>Commit notes are blobs containing extra information about an object
747(usually information to supplement a commit&#8217;s message). These blobs
748are taken from notes refs. A notes ref is usually a branch which
749contains "files" whose paths are the object names for the objects
750they describe, with some directory separators included for performance
751reasons <sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>.</p>
752</div>
753<div class="paragraph">
754<p>Every notes change creates a new commit at the specified notes ref.
755You can therefore inspect the history of the notes by invoking, e.g.,
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]756<code>git</code> <code>log</code> <code>-p</code> <code>notes/commits</code>. Currently the commit message only records
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]757which operation triggered the update, and the commit authorship is
758determined according to the usual rules (see <a href="git-commit.html">git-commit(1)</a>).
759These details may change in the future.</p>
760</div>
761<div class="paragraph">
762<p>It is also permitted for a notes ref to point directly to a tree
763object, in which case the history of the notes can be read with
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]764<code>git</code> <code>log</code> <code>-p</code> <code>-g</code> <em>&lt;refname&gt;</em>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]765</div>
766</div>
767</div>
768<div class="sect1">
769<h2 id="_notes_merge_strategies">NOTES MERGE STRATEGIES</h2>
770<div class="sectionbody">
771<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]772<p>The default notes merge strategy is <code>manual</code>, which checks out
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]773conflicting notes in a special work tree for resolving notes conflicts
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]774(.<code>git/NOTES_MERGE_WORKTREE</code>), and instructs the user to resolve the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]775conflicts in that work tree.
776When done, the user can either finalize the merge with
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]777<code>git</code> <code>notes</code> <code>merge</code> <code>--commit</code>, or abort the merge with
778<code>git</code> <code>notes</code> <code>merge</code> <code>--abort</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]779</div>
780<div class="paragraph">
781<p>Users may select an automated merge strategy from among the following using
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]782either <code>-s</code>/<code>--strategy</code> option or configuring <code>notes.mergeStrategy</code> accordingly:</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]783</div>
784<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]785<p><code>ours</code> automatically resolves conflicting notes in favor of the local
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]786version (i.e. the current notes ref).</p>
787</div>
788<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]789<p><code>theirs</code> automatically resolves notes conflicts in favor of the remote
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]790version (i.e. the given notes ref being merged into the current notes
791ref).</p>
792</div>
793<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]794<p><code>union</code> automatically resolves notes conflicts by concatenating the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]795local and remote versions.</p>
796</div>
797<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]798<p><code>cat_sort_uniq</code> is similar to <code>union</code>, but in addition to concatenating
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]799the local and remote versions, this strategy also sorts the resulting
800lines, and removes duplicate lines from the result. This is equivalent
801to applying the "cat | sort | uniq" shell pipeline to the local and
802remote versions. This strategy is useful if the notes follow a line-based
803format where one wants to avoid duplicated lines in the merge result.
804Note that if either the local or remote version contain duplicate lines
805prior to the merge, these will also be removed by this notes merge
806strategy.</p>
807</div>
808</div>
809</div>
810<div class="sect1">
811<h2 id="_examples">EXAMPLES</h2>
812<div class="sectionbody">
813<div class="paragraph">
814<p>You can use notes to add annotations with information that was not
815available at the time a commit was written.</p>
816</div>
817<div class="listingblock">
818<div class="content">
819<pre>$ git notes add -m 'Tested-by: Johannes Sixt &lt;j6t@kdbg.org&gt;' 72a144e2
820$ git show -s 72a144e
821[...]
822 Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
823
824Notes:
825 Tested-by: Johannes Sixt &lt;j6t@kdbg.org&gt;</pre>
826</div>
827</div>
828<div class="paragraph">
829<p>In principle, a note is a regular Git blob, and any kind of
830(non-)format is accepted. You can binary-safely create notes from
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]831arbitrary files using <code>git</code> <code>hash-object</code>:</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]832</div>
833<div class="listingblock">
834<div class="content">
835<pre>$ cc *.c
836$ blob=$(git hash-object -w a.out)
837$ git notes --ref=built add --allow-empty -C "$blob" HEAD</pre>
838</div>
839</div>
840<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]841<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>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]842because that is not binary-safe.)
843Of course, it doesn&#8217;t make much sense to display non-text-format notes
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]844with <code>git</code> <code>log</code>, so if you use such notes, you&#8217;ll probably need to write
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]845some special-purpose tools to do something useful with them.</p>
846</div>
847</div>
848</div>
849<div class="sect1">
850<h2 id="CONFIGURATION">CONFIGURATION</h2>
851<div class="sectionbody">
852<div class="dlist">
853<dl>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]854<dt class="hdlist1"><code>core.notesRef</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]855<dd>
856<p>Notes ref to read and manipulate instead of
857<code>refs/notes/commits</code>. Must be an unabbreviated ref name.
858This setting can be overridden through the environment and
859command line.</p>
860</dd>
861</dl>
862</div>
863<div class="paragraph">
864<p>Everything above this line in this section isn&#8217;t included from the
865<a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
866same as what&#8217;s found there:</p>
867</div>
868<div class="dlist">
869<dl>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]870<dt class="hdlist1"><code>notes.mergeStrategy</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]871<dd>
872<p>Which merge strategy to choose by default when resolving notes
873conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
874<code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See the "NOTES MERGE STRATEGIES"
875section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.</p>
876<div class="paragraph">
877<p>This setting can be overridden by passing the <code>--strategy</code> option to
878<a href="git-notes.html">git-notes(1)</a>.</p>
879</div>
880</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]881<dt class="hdlist1"><code>notes.</code><em>&lt;name&gt;</em><code>.mergeStrategy</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]882<dd>
883<p>Which merge strategy to choose when doing a notes merge into
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]884<code>refs/notes/</code><em>&lt;name&gt;</em>. This overrides the more general
885<code>notes.mergeStrategy</code>. See the "NOTES MERGE STRATEGIES" section in
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]886<a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.</p>
887</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]888<dt class="hdlist1"><code>notes.displayRef</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]889<dd>
890<p>Which ref (or refs, if a glob or specified more than once), in
891addition to the default set by <code>core.notesRef</code> or
892<code>GIT_NOTES_REF</code>, to read notes from when showing commit
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]893messages with the <code>git</code> <code>log</code> family of commands.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]894<div class="paragraph">
895<p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
896environment variable, which must be a colon separated list of refs or
897globs.</p>
898</div>
899<div class="paragraph">
900<p>A warning will be issued for refs that do not exist,
901but a glob that does not match any refs is silently ignored.</p>
902</div>
903<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]904<p>This setting can be disabled by the <code>--no-notes</code> option to the <a href="git-log.html">git-log(1)</a>
905family of commands, or by the <code>--notes=</code><em>&lt;ref&gt;</em> option accepted by
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]906those commands.</p>
907</div>
908<div class="paragraph">
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]909<p>The effective value of <code>core.notesRef</code> (possibly overridden by
910<code>GIT_NOTES_REF</code>) is also implicitly added to the list of refs to be
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]911displayed.</p>
912</div>
913</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]914<dt class="hdlist1"><code>notes.rewrite.</code><em>&lt;command&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]915<dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]916<p>When rewriting commits with <em>&lt;command&gt;</em> (currently <code>amend</code> or
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]917<code>rebase</code>), if this variable is <code>false</code>, git will not copy
918notes from the original to the rewritten commit. Defaults to
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]919<code>true</code>. See also <code>notes.rewriteRef</code> below.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]920<div class="paragraph">
921<p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
922environment variable, which must be a colon separated list of refs or
923globs.</p>
924</div>
925</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]926<dt class="hdlist1"><code>notes.rewriteMode</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]927<dd>
928<p>When copying notes during a rewrite (see the
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]929<code>notes.rewrite.</code><em>&lt;command&gt;</em> option), determines what to do if
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]930the target commit already has a note. Must be one of
931<code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
932Defaults to <code>concatenate</code>.</p>
933<div class="paragraph">
934<p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
935environment variable.</p>
936</div>
937</dd>
Junio C Hamanofd039e92025-01-31 19:35:27[diff] [blame]938<dt class="hdlist1"><code>notes.rewriteRef</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]939<dd>
940<p>When copying notes during a rewrite, specifies the (fully
941qualified) ref whose notes should be copied. May be a glob,
942in which case notes in all matching refs will be copied. You
943may also specify this configuration several times.</p>
944<div class="paragraph">
945<p>Does not have a default value; you must configure this variable to
946enable note rewriting. Set it to <code>refs/notes/commits</code> to enable
947rewriting for the default commit notes.</p>
948</div>
949<div class="paragraph">
950<p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]951See <code>notes.rewrite.</code><em>&lt;command&gt;</em> above for a further description of its format.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]952</div>
953</dd>
954</dl>
955</div>
956</div>
957</div>
958<div class="sect1">
959<h2 id="_environment">ENVIRONMENT</h2>
960<div class="sectionbody">
961<div class="dlist">
962<dl>
963<dt class="hdlist1"><code>GIT_NOTES_REF</code></dt>
964<dd>
965<p>Which ref to manipulate notes from, instead of <code>refs/notes/commits</code>.
966This overrides the <code>core.notesRef</code> setting.</p>
967</dd>
968<dt class="hdlist1"><code>GIT_NOTES_DISPLAY_REF</code></dt>
969<dd>
970<p>Colon-delimited list of refs or globs indicating which refs,
971in addition to the default from <code>core.notesRef</code> or
972<code>GIT_NOTES_REF</code>, to read notes from when showing commit
973messages.
974This overrides the <code>notes.displayRef</code> setting.</p>
975<div class="paragraph">
976<p>A warning will be issued for refs that do not exist, but a glob that
977does not match any refs is silently ignored.</p>
978</div>
979</dd>
980<dt class="hdlist1"><code>GIT_NOTES_REWRITE_MODE</code></dt>
981<dd>
982<p>When copying notes during a rewrite, what to do if the target
983commit already has a note.
984Must be one of <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
985This overrides the <code>core.rewriteMode</code> setting.</p>
986</dd>
987<dt class="hdlist1"><code>GIT_NOTES_REWRITE_REF</code></dt>
988<dd>
989<p>When rewriting commits, which notes to copy from the original
990to the rewritten commit. Must be a colon-delimited list of
991refs or globs.</p>
992<div class="paragraph">
993<p>If not set in the environment, the list of notes to copy depends
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]994on the <code>notes.rewrite.</code><em>&lt;command&gt;</em> and <code>notes.rewriteRef</code> settings.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]995</div>
996</dd>
997</dl>
998</div>
999</div>
1000</div>
1001<div class="sect1">
1002<h2 id="_git">GIT</h2>
1003<div class="sectionbody">
1004<div class="paragraph">
1005<p>Part of the <a href="git.html">git(1)</a> suite</p>
1006</div>
1007</div>
1008</div>
1009</div>
1010<div id="footnotes">
1011<hr/>
1012<div class="footnote" id="_footnotedef_1">
1013<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.
1014</div>
1015</div>
1016<div id="footer">
1017<div id="footer-text">
Junio C Hamanod6a33e42025-02-18 23:45:11[diff] [blame]1018Last updated 2025-02-14 21:38:14 -0800
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1019</div>
1020</div>
1021</body>
1022</html>