git-notes.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="generator" content="Asciidoctor 2.0.23"/>
<title>git-notes(1)</title>
<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"/>
<style>
/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
/* Uncomment the following line when using as a custom stylesheet */
/* @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"; */
html{font-family:sans-serif;-webkit-text-size-adjust:100%}
a{background:none}
a:focus{outline:thin dotted}
a:active,a:hover{outline:0}
h1{font-size:2em;margin:.67em 0}
b,strong{font-weight:bold}
abbr{font-size:.9em}
abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
dfn{font-style:italic}
hr{height:0}
mark{background:#ff0;color:#000}
code,kbd,pre,samp{font-family:monospace;font-size:1em}
pre{white-space:pre-wrap}
q{quotes:"\201C" "\201D" "\2018" "\2019"}
small{font-size:80%}
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
sup{top:-.5em}
sub{bottom:-.25em}
img{border:0}
svg:not(:root){overflow:hidden}
figure{margin:0}
audio,video{display:inline-block}
audio:not([controls]){display:none;height:0}
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
legend{border:0;padding:0}
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
button,input{line-height:normal}
button,select{text-transform:none}
button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
button[disabled],html input[disabled]{cursor:default}
input[type=checkbox],input[type=radio]{padding:0}
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
textarea{overflow:auto;vertical-align:top}
table{border-collapse:collapse;border-spacing:0}
*,::before,::after{box-sizing:border-box}
html,body{font-size:100%}
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}
a:hover{cursor:pointer}
img,object,embed{max-width:100%;height:auto}
object,embed{height:100%}
img{-ms-interpolation-mode:bicubic}
.left{float:left!important}
.right{float:right!important}
.text-left{text-align:left!important}
.text-right{text-align:right!important}
.text-center{text-align:center!important}
.text-justify{text-align:justify!important}
.hide{display:none}
img,object,svg{display:inline-block;vertical-align:middle}
textarea{height:auto;min-height:50px}
select{width:100%}
.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}
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}
a{color:#2156a5;text-decoration:underline;line-height:inherit}
a:hover,a:focus{color:#1d4b8f}
a img{border:0}
p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
p aside{font-size:.875em;line-height:1.35;font-style:italic}
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}
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}
h1{font-size:2.125em}
h2{font-size:1.6875em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
h4,h5{font-size:1.125em}
h6{font-size:1em}
hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
em,i{font-style:italic;line-height:inherit}
strong,b{font-weight:bold;line-height:inherit}
small{font-size:60%;line-height:inherit}
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.square{list-style-type:square}
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
h1{font-size:2.75em}
h2{font-size:2.3125em}
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
h4{font-size:1.4375em}}
table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
table thead,table tfoot{background:#f7f8f7}
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}
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
table tr.even,table tr.alt{background:#f8f8f7}
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
.center{margin-left:auto;margin-right:auto}
.stretch{width:100%}
.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
.clearfix::after,.float-group::after{clear:both}
:not(pre).nobreak{word-wrap:normal}
:not(pre).nowrap{white-space:nowrap}
:not(pre).pre-wrap{white-space:pre-wrap}
: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}
pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
pre>code{display:block}
pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
em em{font-style:normal}
strong strong{font-weight:400}
.keyseq{color:rgba(51,51,51,.8)}
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}
.keyseq kbd:first-child{margin-left:0}
.keyseq kbd:last-child{margin-right:0}
.menuseq,.menuref{color:#000}
.menuseq b:not(.caret),.menuref{font-weight:inherit}
.menuseq{word-spacing:-.02em}
.menuseq b.caret{font-size:1.25em;line-height:.8}
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
b.button::before{content:"[";padding:0 3px 0 2px}
b.button::after{content:"]";padding:0 2px 0 3px}
p a>code:hover{color:rgba(0,0,0,.9)}
#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
#content{margin-top:1.25em}
#content::before{content:none}
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
#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}
#header .details span:first-child{margin-left:-.125em}
#header .details span.email a{color:rgba(0,0,0,.85)}
#header .details br{display:none}
#header .details br+span::before{content:"\00a0\2013\00a0"}
#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
#header .details br+span#revremark::before{content:"\00a0|\00a0"}
#header #revnumber{text-transform:capitalize}
#header #revnumber::after{content:"\00a0"}
#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}
#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
#toc>ul{margin-left:.125em}
#toc ul.sectlevel0>li>a{font-style:italic}
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
#toc li{line-height:1.3334;margin-top:.3334em}
#toc a{text-decoration:none}
#toc a:active{text-decoration:underline}
#toctitle{color:#7a2518;font-size:1.2em}
@media screen and (min-width:768px){#toctitle{font-size:1.375em}
body.toc2{padding-left:15em;padding-right:0}
body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
#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}
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
body.toc2.toc-right{padding-left:0;padding-right:15em}
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
#toc.toc2{width:20em}
#toc.toc2 #toctitle{font-size:1.375em}
#toc.toc2>ul{font-size:.95em}
#toc.toc2 ul ul{padding-left:1.25em}
body.toc2.toc-right{padding-left:0;padding-right:20em}}
#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
#content #toc>:first-child{margin-top:0}
#content #toc>:last-child{margin-bottom:0}
#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
#content{margin-bottom:.625em}
.sect1{padding-bottom:.625em}
@media screen and (min-width:768px){#content{margin-bottom:1.25em}
.sect1{padding-bottom:1.25em}}
.sect1:last-child{padding-bottom:0}
.sect1+.sect1{border-top:1px solid #e7e7e9}
#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}
#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}
#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}
#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}
#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}
details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
details{margin-left:1.25rem}
details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
details>summary::-webkit-details-marker{display:none}
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%)}
details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
.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}
table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
.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)}
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
.admonitionblock>table td.icon{text-align:center;width:80px}
.admonitionblock>table td.icon img{max-width:none}
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
.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}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
.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}
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
.listingblock>.content{position:relative}
.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}
.listingblock:hover code[data-lang]::before{display:block}
.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
.listingblock pre.highlightjs{padding:0}
.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
.listingblock pre.prettyprint{border-width:0}
.prettyprint{background:#f7f7f8}
pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
pre.prettyprint li code[data-lang]::before{opacity:1}
pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
table.linenotable td.code{padding-left:.75em}
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}
pre.pygments span.linenos{display:inline-block;margin-right:.75em}
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
.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}
.quoteblock blockquote{margin:0;padding:0;border:0}
.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)}
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
.verseblock{margin:0 1em 1.25em}
.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}
.verseblock pre strong{font-weight:400}
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
.quoteblock .attribution br,.verseblock .attribution br{display:none}
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
.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}
.quoteblock.abstract{margin:0 1em 1.25em;display:block}
.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
p.tableblock:last-child{margin-bottom:0}
td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
td.tableblock>.content>:last-child{margin-bottom:-1.25em}
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
table.grid-all>*>tr>*{border-width:1px}
table.grid-cols>*>tr>*{border-width:0 1px}
table.grid-rows>*>tr>*{border-width:1px 0}
table.frame-all{border-width:1px}
table.frame-ends{border-width:1px 0}
table.frame-sides{border-width:0 1px}
table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
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}
th.halign-left,td.halign-left{text-align:left}
th.halign-right,td.halign-right{text-align:right}
th.halign-center,td.halign-center{text-align:center}
th.valign-top,td.valign-top{vertical-align:top}
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
th.valign-middle,td.valign-middle{vertical-align:middle}
table thead th,table tfoot th{font-weight:bold}
tbody tr th{background:#f7f8f7}
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
p.tableblock>code:only-child{background:none;padding:0}
p.tableblock{font-size:1em}
ol{margin-left:1.75em}
ul li ol{margin-left:1.5em}
dl dd{margin-left:1.125em}
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
ul.unstyled,ol.unstyled{margin-left:0}
li>p:empty:only-child::before{content:"";display:inline-block}
ul.checklist>li>p:first-child{margin-left:-1em}
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}
ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
ul.inline>li{margin-left:1.25em}
.unstyled dl dt{font-weight:400;font-style:normal}
ol.arabic{list-style-type:decimal}
ol.decimal{list-style-type:decimal-leading-zero}
ol.loweralpha{list-style-type:lower-alpha}
ol.upperalpha{list-style-type:upper-alpha}
ol.lowerroman{list-style-type:lower-roman}
ol.upperroman{list-style-type:upper-roman}
ol.lowergreek{list-style-type:lower-greek}
.hdlist>table,.colist>table{border:0;background:none}
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
td.hdlist2{word-wrap:anywhere}
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
.colist td:not([class]):first-child img{max-width:none}
.colist td:not([class]):last-child{padding:.25em 0}
.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
.imageblock.left{margin:.25em .625em 1.25em 0}
.imageblock.right{margin:.25em 0 1.25em .625em}
.imageblock>.title{margin-bottom:0}
.imageblock.thumb,.imageblock.th{border-width:6px}
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
.image.left{margin-right:.625em}
.image.right{margin-left:.625em}
a.image{text-decoration:none;display:inline-block}
a.image object{pointer-events:none}
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
sup.footnote a,sup.footnoteref a{text-decoration:none}
sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
#footnotes .footnote:last-of-type{margin-bottom:0}
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
div.unbreakable{page-break-inside:avoid}
.big{font-size:larger}
.small{font-size:smaller}
.underline{text-decoration:underline}
.overline{text-decoration:overline}
.line-through{text-decoration:line-through}
.aqua{color:#00bfbf}
.aqua-background{background:#00fafa}
.black{color:#000}
.black-background{background:#000}
.blue{color:#0000bf}
.blue-background{background:#0000fa}
.fuchsia{color:#bf00bf}
.fuchsia-background{background:#fa00fa}
.gray{color:#606060}
.gray-background{background:#7d7d7d}
.green{color:#006000}
.green-background{background:#007d00}
.lime{color:#00bf00}
.lime-background{background:#00fa00}
.maroon{color:#600000}
.maroon-background{background:#7d0000}
.navy{color:#000060}
.navy-background{background:#00007d}
.olive{color:#606000}
.olive-background{background:#7d7d00}
.purple{color:#600060}
.purple-background{background:#7d007d}
.red{color:#bf0000}
.red-background{background:#fa0000}
.silver{color:#909090}
.silver-background{background:#bcbcbc}
.teal{color:#006060}
.teal-background{background:#007d7d}
.white{color:#bfbfbf}
.white-background{background:#fafafa}
.yellow{color:#bfbf00}
.yellow-background{background:#fafa00}
span.icon>.fa{cursor:default}
a span.icon>.fa{cursor:inherit}
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
.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}
.conum[data-value] *{color:#fff!important}
.conum[data-value]+b{display:none}
.conum[data-value]::after{content:attr(data-value)}
pre .conum[data-value]{position:relative;top:-.125em}
b.conum *{color:inherit!important}
.conum:not([data-value]):empty{display:none}
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
.print-only{display:none!important}
@page{margin:1.25cm .75cm}
@media print{*{box-shadow:none!important;text-shadow:none!important}
html{font-size:80%}
a{color:inherit!important;text-decoration:underline!important}
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
abbr[title]{border-bottom:1px dotted}
abbr[title]::after{content:" (" attr(title) ")"}
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
thead{display:table-header-group}
svg{max-width:100%}
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
#header,#content,#footnotes,#footer{max-width:none}
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
body.book #header{text-align:center}
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
body.book #header .details{border:0!important;display:block;padding:0!important}
body.book #header .details span:first-child{margin-left:0!important}
body.book #header .details br{display:block}
body.book #header .details br+span::before{content:none!important}
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
.listingblock code[data-lang]::before{display:block}
#footer{padding:0 .9375em}
.hide-on-print{display:none!important}
.print-only{display:block!important}
.hide-for-print{display:none!important}
.show-for-print{display:inherit!important}}
@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
.sect1{padding:0!important}
.sect1+.sect1{border:0}
#footer{background:none}
#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
</style>
<style>
pre>code {
   display: inline;
}
</style>
</head>
<body class="manpage">
<div id="header">
<h1>git-notes(1) Manual Page</h1>
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<p>git-notes - Add or inspect object notes</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><code>git</code> <code>notes</code> [<code>list</code> [<em>&lt;object&gt;</em>]]
<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>]
<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>] )
<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>]
<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>]
<code>git</code> <code>notes</code> <code>show</code> [<em>&lt;object&gt;</em>]
<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>
<code>git</code> <code>notes</code> <code>merge</code> <code>--commit</code> [<code>-v</code> | <code>-q</code>]
<code>git</code> <code>notes</code> <code>merge</code> <code>--abort</code> [<code>-v</code> | <code>-q</code>]
<code>git</code> <code>notes</code> <code>remove</code> [<code>--ignore-missing</code>] [<code>--stdin</code>] [<em>&lt;object&gt;</em>&#8230;&#8203;]
<code>git</code> <code>notes</code> <code>prune</code> [<code>-n</code>] [<code>-v</code>]
<code>git</code> <code>notes</code> <code>get-ref</code></pre>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Adds, removes, or reads notes attached to objects, without touching
the objects themselves.</p>
</div>
<div class="paragraph">
<p>By default, notes are saved to and read from <code>refs/notes/commits</code>, but
this default can be overridden.  See the OPTIONS, CONFIGURATION, and
ENVIRONMENT sections below.  If this ref does not exist, it will be
quietly created when it is first needed to store a note.</p>
</div>
<div class="paragraph">
<p>A typical use of notes is to supplement a commit message without
changing the commit itself. Notes can be shown by <code>git</code> <code>log</code> along with
the original commit message. To distinguish these notes from the
message stored in the commit object, the notes are indented like the
message, after an unindented line saying "Notes (<em>&lt;refname&gt;</em>):" (or
"Notes:" for <code>refs/notes/commits</code>).</p>
</div>
<div class="paragraph">
<p>Notes can also be added to patches prepared with <code>git</code> <code>format-patch</code> by
using the <code>--notes</code> option. Such notes are added as a patch commentary
after a three dash separator line.</p>
</div>
<div class="paragraph">
<p>To change which notes are shown by <code>git</code> <code>log</code>, see the
<code>notes.displayRef</code> discussion in <a href="#CONFIGURATION">CONFIGURATION</a>.</p>
</div>
<div class="paragraph">
<p>See the <code>notes.rewrite.</code><em>&lt;command&gt;</em> configuration for a way to carry
notes across commands that rewrite commits.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_subcommands">SUBCOMMANDS</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><code>list</code></dt>
<dd>
<p>List the notes object for a given object. If no object is
given, show a list of all note objects and the objects they
annotate (in the format "<em>&lt;note-object&gt;</em> <em>&lt;annotated-object&gt;</em>").
This is the default subcommand if no subcommand is given.</p>
</dd>
<dt class="hdlist1"><code>add</code></dt>
<dd>
<p>Add notes for a given object (defaults to <code>HEAD</code>). Abort if the
object already has notes (use <code>-f</code> to overwrite existing notes).
However, if you&#8217;re using <code>add</code> interactively (using an editor
to supply the notes contents), then - instead of aborting -
the existing notes will be opened in the editor (like the <code>edit</code>
subcommand). If you specify multiple <code>-m</code> and <code>-F</code>, a blank
line will be inserted between the messages. Use the <code>--separator</code>
option to insert other delimiters. You can use <code>-e</code> to edit and
fine-tune the message(s) supplied from <code>-m</code> and <code>-F</code> options
interactively (using an editor) before adding the note.</p>
</dd>
<dt class="hdlist1"><code>copy</code></dt>
<dd>
<p>Copy the notes for the first object onto the second object (defaults to
<code>HEAD</code>). Abort if the second object already has notes, or if the first
object has none (use <code>-f</code> to overwrite existing notes to the
second object). This subcommand is equivalent to:
<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>
<div class="paragraph">
<p>In <code>--stdin</code> mode, take lines in the format</p>
</div>
<div class="listingblock">
<div class="content">
<pre>&lt;from-object&gt; SP &lt;to-object&gt; [ SP &lt;rest&gt; ] LF</pre>
</div>
</div>
<div class="paragraph">
<p>on standard input, and copy the notes from each <em>&lt;from-object&gt;</em> to its
corresponding <em>&lt;to-object&gt;</em>.  (The optional <em>&lt;rest&gt;</em> is ignored so that
the command can read the input given to the <code>post-rewrite</code> hook.)</p>
</div>
</dd>
<dt class="hdlist1"><code>append</code></dt>
<dd>
<p>Append new message(s) given by <code>-m</code> or <code>-F</code> options to an
existing note, or add them as a new note if one does not
exist, for the object (defaults to <code>HEAD</code>).  When appending to
an existing note, a blank line is added before each new
message as an inter-paragraph separator.  The separator can
be customized with the <code>--separator</code> option.
Edit the notes to be appended given by <code>-m</code> and <code>-F</code> options with
<code>-e</code> interactively (using an editor) before appending the note.</p>
</dd>
<dt class="hdlist1"><code>edit</code></dt>
<dd>
<p>Edit the notes for a given object (defaults to <code>HEAD</code>).</p>
</dd>
<dt class="hdlist1"><code>show</code></dt>
<dd>
<p>Show the notes for a given object (defaults to <code>HEAD</code>).</p>
</dd>
<dt class="hdlist1"><code>merge</code></dt>
<dd>
<p>Merge the given notes ref into the current notes ref.
This will try to merge the changes made by the given
notes ref (called "remote") since the merge-base (if
any) into the current notes ref (called "local").</p>
<div class="paragraph">
<p>If conflicts arise and a strategy for automatically resolving
conflicting notes (see the "NOTES MERGE STRATEGIES" section) is not given,
the <code>manual</code> resolver is used. This resolver checks out the
conflicting notes in a special worktree (.<code>git/NOTES_MERGE_WORKTREE</code>),
and instructs the user to manually resolve the conflicts there.
When done, the user can either finalize the merge with
<code>git</code> <code>notes</code> <code>merge</code> <code>--commit</code>, or abort the merge with
<code>git</code> <code>notes</code> <code>merge</code> <code>--abort</code>.</p>
</div>
</dd>
<dt class="hdlist1"><code>remove</code></dt>
<dd>
<p>Remove the notes for given objects (defaults to <code>HEAD</code>). When
giving zero or one object from the command line, this is
equivalent to specifying an empty note message to
the <code>edit</code> subcommand.</p>
</dd>
<dt class="hdlist1"><code>prune</code></dt>
<dd>
<p>Remove all notes for non-existing/unreachable objects.</p>
</dd>
<dt class="hdlist1"><code>get-ref</code></dt>
<dd>
<p>Print the current notes ref. This provides an easy way to
retrieve the current notes ref (e.g. from scripts).</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><code>-f</code></dt>
<dt class="hdlist1"><code>--force</code></dt>
<dd>
<p>When adding notes to an object that already has notes,
overwrite the existing notes (instead of aborting).</p>
</dd>
<dt class="hdlist1"><code>-m</code> <em>&lt;msg&gt;</em></dt>
<dt class="hdlist1"><code>--message=</code><em>&lt;msg&gt;</em></dt>
<dd>
<p>Use the given note message (instead of prompting).
If multiple <code>-m</code> options are given, their values
are concatenated as separate paragraphs.
Lines starting with # and empty lines other than a
single line between paragraphs will be stripped out.
If you wish to keep them verbatim, use <code>--no-stripspace</code>.</p>
</dd>
<dt class="hdlist1"><code>-F</code> <em>&lt;file&gt;</em></dt>
<dt class="hdlist1"><code>--file=</code><em>&lt;file&gt;</em></dt>
<dd>
<p>Take the note message from the given file.  Use <code>-</code> to
read the note message from the standard input.
Lines starting with # and empty lines other than a
single line between paragraphs will be stripped out.
If you wish to keep them verbatim, use <code>--no-stripspace</code>.</p>
</dd>
<dt class="hdlist1"><code>-C</code> <em>&lt;object&gt;</em></dt>
<dt class="hdlist1"><code>--reuse-message=</code><em>&lt;object&gt;</em></dt>
<dd>
<p>Take the given blob object (for example, another note) as the
note message. (Use <code>git</code> <code>notes</code> <code>copy</code> <em>&lt;object&gt;</em> instead to
copy notes between objects.).  By default, message will be
copied verbatim, but if you wish to strip out the lines
starting with # and empty lines other than a single line
between paragraphs, use with <code>--stripspace</code> option.</p>
</dd>
<dt class="hdlist1"><code>-c</code> <em>&lt;object&gt;</em></dt>
<dt class="hdlist1"><code>--reedit-message=</code><em>&lt;object&gt;</em></dt>
<dd>
<p>Like <code>-C</code>, but with <code>-c</code> the editor is invoked, so that
the user can further edit the note message.</p>
</dd>
<dt class="hdlist1"><code>--allow-empty</code></dt>
<dd>
<p>Allow an empty note object to be stored. The default behavior is
to automatically remove empty notes.</p>
</dd>
<dt class="hdlist1"><code>--</code>[<code>no-</code>]<code>separator</code></dt>
<dt class="hdlist1"><code>--separator=</code><em>&lt;paragraph-break&gt;</em></dt>
<dd>
<p>Specify a string used as a custom inter-paragraph separator
(a newline is added at the end as needed). If <code>--no-separator</code>, no
separators will be added between paragraphs.  Defaults to a blank
line.</p>
</dd>
<dt class="hdlist1"><code>--</code>[<code>no-</code>]<code>stripspace</code></dt>
<dd>
<p>Strip leading and trailing whitespace from the note message.
Also strip out empty lines other than a single line between
paragraphs. Lines starting with # will be stripped out
in non-editor cases like <code>-m</code>, <code>-F</code> and <code>-C</code>, but not in
editor case like <code>git</code> <code>notes</code> <code>edit</code>, <code>-c</code>, etc.</p>
</dd>
<dt class="hdlist1"><code>--ref</code> <em>&lt;ref&gt;</em></dt>
<dd>
<p>Manipulate the notes tree in <em>&lt;ref&gt;</em>.  This overrides
<code>GIT_NOTES_REF</code> and the <code>core.notesRef</code> configuration.  The ref
specifies the full refname when it begins with <code>refs/notes/</code>; when it
begins with <code>notes/</code>, <code>refs/</code> and otherwise <code>refs/notes/</code> is prefixed
to form a full name of the ref.</p>
</dd>
<dt class="hdlist1"><code>--ignore-missing</code></dt>
<dd>
<p>Do not consider it an error to request removing notes from an
object that does not have notes attached to it.</p>
</dd>
<dt class="hdlist1"><code>--stdin</code></dt>
<dd>
<p>Also read the object names to remove notes from the standard
input (there is no reason you cannot combine this with object
names from the command line).</p>
</dd>
<dt class="hdlist1"><code>-n</code></dt>
<dt class="hdlist1"><code>--dry-run</code></dt>
<dd>
<p>Do not remove anything; just report the object names whose notes
would be removed.</p>
</dd>
<dt class="hdlist1"><code>-s</code> <em>&lt;strategy&gt;</em></dt>
<dt class="hdlist1"><code>--strategy=</code><em>&lt;strategy&gt;</em></dt>
<dd>
<p>When merging notes, resolve notes conflicts using the given
strategy. The following strategies are recognized: <code>manual</code>
(default), <code>ours</code>, <code>theirs</code>, <code>union</code> and <code>cat_sort_uniq</code>.
This option overrides the <code>notes.mergeStrategy</code> configuration setting.
See the "NOTES MERGE STRATEGIES" section below for more
information on each notes merge strategy.</p>
</dd>
<dt class="hdlist1"><code>--commit</code></dt>
<dd>
<p>Finalize an in-progress <code>git</code> <code>notes</code> <code>merge</code>. Use this option
when you have resolved the conflicts that <code>git</code> <code>notes</code> <code>merge</code>
stored in .<code>git/NOTES_MERGE_WORKTREE</code>. This amends the partial
merge commit created by <code>git</code> <code>notes</code> <code>merge</code> (stored in
.<code>git/NOTES_MERGE_PARTIAL</code>) by adding the notes in
.<code>git/NOTES_MERGE_WORKTREE</code>. The notes ref stored in the
.<code>git/NOTES_MERGE_REF</code> symref is updated to the resulting commit.</p>
</dd>
<dt class="hdlist1"><code>--abort</code></dt>
<dd>
<p>Abort/reset an in-progress <code>git</code> <code>notes</code> <code>merge</code>, i.e. a notes merge
with conflicts. This simply removes all files related to the
notes merge.</p>
</dd>
<dt class="hdlist1"><code>-q</code></dt>
<dt class="hdlist1"><code>--quiet</code></dt>
<dd>
<p>When merging notes, operate quietly.</p>
</dd>
<dt class="hdlist1"><code>-v</code></dt>
<dt class="hdlist1"><code>--verbose</code></dt>
<dd>
<p>When merging notes, be more verbose.
When pruning notes, report all object names whose notes are
removed.</p>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_discussion">DISCUSSION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Commit notes are blobs containing extra information about an object
(usually information to supplement a commit&#8217;s message).  These blobs
are taken from notes refs.  A notes ref is usually a branch which
contains "files" whose paths are the object names for the objects
they describe, with some directory separators included for performance
reasons <sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>.</p>
</div>
<div class="paragraph">
<p>Every notes change creates a new commit at the specified notes ref.
You can therefore inspect the history of the notes by invoking, e.g.,
<code>git</code> <code>log</code> <code>-p</code> <code>notes/commits</code>.  Currently the commit message only records
which operation triggered the update, and the commit authorship is
determined according to the usual rules (see <a href="git-commit.html">git-commit(1)</a>).
These details may change in the future.</p>
</div>
<div class="paragraph">
<p>It is also permitted for a notes ref to point directly to a tree
object, in which case the history of the notes can be read with
<code>git</code> <code>log</code> <code>-p</code> <code>-g</code> <em>&lt;refname&gt;</em>.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_notes_merge_strategies">NOTES MERGE STRATEGIES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The default notes merge strategy is <code>manual</code>, which checks out
conflicting notes in a special work tree for resolving notes conflicts
(.<code>git/NOTES_MERGE_WORKTREE</code>), and instructs the user to resolve the
conflicts in that work tree.
When done, the user can either finalize the merge with
<code>git</code> <code>notes</code> <code>merge</code> <code>--commit</code>, or abort the merge with
<code>git</code> <code>notes</code> <code>merge</code> <code>--abort</code>.</p>
</div>
<div class="paragraph">
<p>Users may select an automated merge strategy from among the following using
either <code>-s</code>/<code>--strategy</code> option or configuring <code>notes.mergeStrategy</code> accordingly:</p>
</div>
<div class="paragraph">
<p><code>ours</code> automatically resolves conflicting notes in favor of the local
version (i.e. the current notes ref).</p>
</div>
<div class="paragraph">
<p><code>theirs</code> automatically resolves notes conflicts in favor of the remote
version (i.e. the given notes ref being merged into the current notes
ref).</p>
</div>
<div class="paragraph">
<p><code>union</code> automatically resolves notes conflicts by concatenating the
local and remote versions.</p>
</div>
<div class="paragraph">
<p><code>cat_sort_uniq</code> is similar to <code>union</code>, but in addition to concatenating
the local and remote versions, this strategy also sorts the resulting
lines, and removes duplicate lines from the result. This is equivalent
to applying the "cat | sort | uniq" shell pipeline to the local and
remote versions. This strategy is useful if the notes follow a line-based
format where one wants to avoid duplicated lines in the merge result.
Note that if either the local or remote version contain duplicate lines
prior to the merge, these will also be removed by this notes merge
strategy.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can use notes to add annotations with information that was not
available at the time a commit was written.</p>
</div>
<div class="listingblock">
<div class="content">
<pre>$ git notes add -m 'Tested-by: Johannes Sixt &lt;j6t@kdbg.org&gt;' 72a144e2
$ git show -s 72a144e
[...]
    Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;

Notes:
    Tested-by: Johannes Sixt &lt;j6t@kdbg.org&gt;</pre>
</div>
</div>
<div class="paragraph">
<p>In principle, a note is a regular Git blob, and any kind of
(non-)format is accepted.  You can binary-safely create notes from
arbitrary files using <code>git</code> <code>hash-object</code>:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>$ cc *.c
$ blob=$(git hash-object -w a.out)
$ git notes --ref=built add --allow-empty -C "$blob" HEAD</pre>
</div>
</div>
<div class="paragraph">
<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>
because that is not binary-safe.)
Of course, it doesn&#8217;t make much sense to display non-text-format notes
with <code>git</code> <code>log</code>, so if you use such notes, you&#8217;ll probably need to write
some special-purpose tools to do something useful with them.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="CONFIGURATION">CONFIGURATION</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><code>core.notesRef</code></dt>
<dd>
<p>Notes ref to read and manipulate instead of
<code>refs/notes/commits</code>.  Must be an unabbreviated ref name.
This setting can be overridden through the environment and
command line.</p>
</dd>
</dl>
</div>
<div class="paragraph">
<p>Everything above this line in this section isn&#8217;t included from the
<a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
same as what&#8217;s found there:</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>notes.mergeStrategy</code></dt>
<dd>
<p>Which merge strategy to choose by default when resolving notes
conflicts.  Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or
<code>cat_sort_uniq</code>.  Defaults to <code>manual</code>.  See the "NOTES MERGE STRATEGIES"
section of <a href="git-notes.html">git-notes(1)</a> for more information on each strategy.</p>
<div class="paragraph">
<p>This setting can be overridden by passing the <code>--strategy</code> option to
<a href="git-notes.html">git-notes(1)</a>.</p>
</div>
</dd>
<dt class="hdlist1"><code>notes.</code><em>&lt;name&gt;</em><code>.mergeStrategy</code></dt>
<dd>
<p>Which merge strategy to choose when doing a notes merge into
<code>refs/notes/</code><em>&lt;name&gt;</em>.  This overrides the more general
<code>notes.mergeStrategy</code>.  See the "NOTES MERGE STRATEGIES" section in
<a href="git-notes.html">git-notes(1)</a> for more information on the available strategies.</p>
</dd>
<dt class="hdlist1"><code>notes.displayRef</code></dt>
<dd>
<p>Which ref (or refs, if a glob or specified more than once), in
addition to the default set by <code>core.notesRef</code> or
<code>GIT_NOTES_REF</code>, to read notes from when showing commit
messages with the <code>git</code> <code>log</code> family of commands.</p>
<div class="paragraph">
<p>This setting can be overridden with the <code>GIT_NOTES_DISPLAY_REF</code>
environment variable, which must be a colon separated list of refs or
globs.</p>
</div>
<div class="paragraph">
<p>A warning will be issued for refs that do not exist,
but a glob that does not match any refs is silently ignored.</p>
</div>
<div class="paragraph">
<p>This setting can be disabled by the <code>--no-notes</code> option to the <a href="git-log.html">git-log(1)</a>
family of commands, or by the <code>--notes=</code><em>&lt;ref&gt;</em> option accepted by
those commands.</p>
</div>
<div class="paragraph">
<p>The effective value of <code>core.notesRef</code> (possibly overridden by
<code>GIT_NOTES_REF</code>) is also implicitly added to the list of refs to be
displayed.</p>
</div>
</dd>
<dt class="hdlist1"><code>notes.rewrite.</code><em>&lt;command&gt;</em></dt>
<dd>
<p>When rewriting commits with <em>&lt;command&gt;</em> (currently <code>amend</code> or
<code>rebase</code>), if this variable is <code>false</code>, git will not copy
notes from the original to the rewritten commit.  Defaults to
<code>true</code>.  See also <code>notes.rewriteRef</code> below.</p>
<div class="paragraph">
<p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_REF</code>
environment variable, which must be a colon separated list of refs or
globs.</p>
</div>
</dd>
<dt class="hdlist1"><code>notes.rewriteMode</code></dt>
<dd>
<p>When copying notes during a rewrite (see the
<code>notes.rewrite.</code><em>&lt;command&gt;</em> option), determines what to do if
the target commit already has a note.  Must be one of
<code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
Defaults to <code>concatenate</code>.</p>
<div class="paragraph">
<p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code>
environment variable.</p>
</div>
</dd>
<dt class="hdlist1"><code>notes.rewriteRef</code></dt>
<dd>
<p>When copying notes during a rewrite, specifies the (fully
qualified) ref whose notes should be copied.  May be a glob,
in which case notes in all matching refs will be copied.  You
may also specify this configuration several times.</p>
<div class="paragraph">
<p>Does not have a default value; you must configure this variable to
enable note rewriting.  Set it to <code>refs/notes/commits</code> to enable
rewriting for the default commit notes.</p>
</div>
<div class="paragraph">
<p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.
See <code>notes.rewrite.</code><em>&lt;command&gt;</em> above for a further description of its format.</p>
</div>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_environment">ENVIRONMENT</h2>
<div class="sectionbody">
<div class="dlist">
<dl>
<dt class="hdlist1"><code>GIT_NOTES_REF</code></dt>
<dd>
<p>Which ref to manipulate notes from, instead of <code>refs/notes/commits</code>.
This overrides the <code>core.notesRef</code> setting.</p>
</dd>
<dt class="hdlist1"><code>GIT_NOTES_DISPLAY_REF</code></dt>
<dd>
<p>Colon-delimited list of refs or globs indicating which refs,
in addition to the default from <code>core.notesRef</code> or
<code>GIT_NOTES_REF</code>, to read notes from when showing commit
messages.
This overrides the <code>notes.displayRef</code> setting.</p>
<div class="paragraph">
<p>A warning will be issued for refs that do not exist, but a glob that
does not match any refs is silently ignored.</p>
</div>
</dd>
<dt class="hdlist1"><code>GIT_NOTES_REWRITE_MODE</code></dt>
<dd>
<p>When copying notes during a rewrite, what to do if the target
commit already has a note.
Must be one of <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>.
This overrides the <code>core.rewriteMode</code> setting.</p>
</dd>
<dt class="hdlist1"><code>GIT_NOTES_REWRITE_REF</code></dt>
<dd>
<p>When rewriting commits, which notes to copy from the original
to the rewritten commit.  Must be a colon-delimited list of
refs or globs.</p>
<div class="paragraph">
<p>If not set in the environment, the list of notes to copy depends
on the <code>notes.rewrite.</code><em>&lt;command&gt;</em> and <code>notes.rewriteRef</code> settings.</p>
</div>
</dd>
</dl>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Part of the <a href="git.html">git(1)</a> suite</p>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr/>
<div class="footnote" id="_footnotedef_1">
<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.
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-02-14 21:38:14 -0800
</div>
</div>
</body>
</html>