| <!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-read-tree(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-read-tree(1) Manual Page</h1> |
| <h2 id="_name">NAME</h2> |
| <div class="sectionbody"> |
| <p>git-read-tree - Reads tree information into the index</p> |
| </div> |
| </div> |
| <div id="content"> |
| <div class="sect1"> |
| <h2 id="_synopsis">SYNOPSIS</h2> |
| <div class="sectionbody"> |
| <div class="verseblock"> |
| <pre class="content"><em>git read-tree</em> [(-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>) |
| [-u | -i]] [--index-output=<file>] [--no-sparse-checkout] |
| (--empty | <tree-ish1> [<tree-ish2> [<tree-ish3>]])</pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_description">DESCRIPTION</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Reads the tree information given by <tree-ish> into the index, |
| but does not actually <strong>update</strong> any of the files it "caches". (see: |
| <a href="git-checkout-index.html">git-checkout-index(1)</a>)</p> |
| </div> |
| <div class="paragraph"> |
| <p>Optionally, it can merge a tree into the index, perform a |
| fast-forward (i.e. 2-way) merge, or a 3-way merge, with the <code>-m</code> |
| flag. When used with <code>-m</code>, the <code>-u</code> flag causes it to also update |
| the files in the work tree with the result of the merge.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Only trivial merges are done by <em>git read-tree</em> itself. Only conflicting paths |
| will be in an unmerged state when <em>git read-tree</em> returns.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_options">OPTIONS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">-m</dt> |
| <dd> |
| <p>Perform a merge, not just a read. The command will |
| refuse to run if your index file has unmerged entries, |
| indicating that you have not finished a previous merge you |
| started.</p> |
| </dd> |
| <dt class="hdlist1">--reset</dt> |
| <dd> |
| <p>Same as -m, except that unmerged entries are discarded instead |
| of failing. When used with <code>-u</code>, updates leading to loss of |
| working tree changes or untracked files or directories will not |
| abort the operation.</p> |
| </dd> |
| <dt class="hdlist1">-u</dt> |
| <dd> |
| <p>After a successful merge, update the files in the work |
| tree with the result of the merge.</p> |
| </dd> |
| <dt class="hdlist1">-i</dt> |
| <dd> |
| <p>Usually a merge requires the index file as well as the |
| files in the working tree to be up to date with the |
| current head commit, in order not to lose local |
| changes. This flag disables the check with the working |
| tree and is meant to be used when creating a merge of |
| trees that are not directly related to the current |
| working tree status into a temporary index file.</p> |
| </dd> |
| <dt class="hdlist1">-n</dt> |
| <dt class="hdlist1">--dry-run</dt> |
| <dd> |
| <p>Check if the command would error out, without updating the index |
| or the files in the working tree for real.</p> |
| </dd> |
| <dt class="hdlist1">-v</dt> |
| <dd> |
| <p>Show the progress of checking files out.</p> |
| </dd> |
| <dt class="hdlist1">--trivial</dt> |
| <dd> |
| <p>Restrict three-way merge by <em>git read-tree</em> to happen |
| only if there is no file-level merging required, instead |
| of resolving merge for trivial cases and leaving |
| conflicting files unresolved in the index.</p> |
| </dd> |
| <dt class="hdlist1">--aggressive</dt> |
| <dd> |
| <p>Usually a three-way merge by <em>git read-tree</em> resolves |
| the merge for really trivial cases and leaves other |
| cases unresolved in the index, so that porcelains can |
| implement different merge policies. This flag makes the |
| command resolve a few more cases internally:</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>when one side removes a path and the other side leaves the path |
| unmodified. The resolution is to remove that path.</p> |
| </li> |
| <li> |
| <p>when both sides remove a path. The resolution is to remove that path.</p> |
| </li> |
| <li> |
| <p>when both sides add a path identically. The resolution |
| is to add that path.</p> |
| </li> |
| </ul> |
| </div> |
| </dd> |
| <dt class="hdlist1">--prefix=<prefix></dt> |
| <dd> |
| <p>Keep the current index contents, and read the contents |
| of the named tree-ish under the directory at <em><prefix></em>. |
| The command will refuse to overwrite entries that already |
| existed in the original index file.</p> |
| </dd> |
| <dt class="hdlist1">--index-output=<file></dt> |
| <dd> |
| <p>Instead of writing the results out to <code>$GIT_INDEX_FILE</code>, |
| write the resulting index in the named file. While the |
| command is operating, the original index file is locked |
| with the same mechanism as usual. The file must allow |
| to be rename(2)ed into from a temporary file that is |
| created next to the usual index file; typically this |
| means it needs to be on the same filesystem as the index |
| file itself, and you need write permission to the |
| directories the index file and index output file are |
| located in.</p> |
| </dd> |
| <dt class="hdlist1">--[no-]recurse-submodules</dt> |
| <dd> |
| <p>Using --recurse-submodules will update the content of all active |
| submodules according to the commit recorded in the superproject by |
| calling read-tree recursively, also setting the submodules' HEAD to be |
| detached at that commit.</p> |
| </dd> |
| <dt class="hdlist1">--no-sparse-checkout</dt> |
| <dd> |
| <p>Disable sparse checkout support even if <code>core.sparseCheckout</code> |
| is true.</p> |
| </dd> |
| <dt class="hdlist1">--empty</dt> |
| <dd> |
| <p>Instead of reading tree object(s) into the index, just empty |
| it.</p> |
| </dd> |
| <dt class="hdlist1">-q</dt> |
| <dt class="hdlist1">--quiet</dt> |
| <dd> |
| <p>Quiet, suppress feedback messages.</p> |
| </dd> |
| <dt class="hdlist1"><tree-ish#></dt> |
| <dd> |
| <p>The id of the tree object(s) to be read/merged.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_merging">MERGING</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>If <code>-m</code> is specified, <em>git read-tree</em> can perform 3 kinds of |
| merge, a single tree merge if only 1 tree is given, a |
| fast-forward merge with 2 trees, or a 3-way merge if 3 or more trees are |
| provided.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_single_tree_merge">Single Tree Merge</h3> |
| <div class="paragraph"> |
| <p>If only 1 tree is specified, <em>git read-tree</em> operates as if the user did not |
| specify <code>-m</code>, except that if the original index has an entry for a |
| given pathname, and the contents of the path match with the tree |
| being read, the stat info from the index is used. (In other words, the |
| index’s stat()s take precedence over the merged tree’s).</p> |
| </div> |
| <div class="paragraph"> |
| <p>That means that if you do a <code>git</code> <code>read-tree</code> <code>-m</code> <em><newtree></em> followed by a |
| <code>git</code> <code>checkout-index</code> <code>-f</code> <code>-u</code> <code>-a</code>, the <em>git checkout-index</em> only checks out |
| the stuff that really changed.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This is used to avoid unnecessary false hits when <em>git diff-files</em> is |
| run after <em>git read-tree</em>.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_two_tree_merge">Two Tree Merge</h3> |
| <div class="paragraph"> |
| <p>Typically, this is invoked as <code>git</code> <code>read-tree</code> <code>-m</code> <code>$H</code> <code>$M</code>, where $H |
| is the head commit of the current repository, and $M is the head |
| of a foreign tree, which is simply ahead of $H (i.e. we are in a |
| fast-forward situation).</p> |
| </div> |
| <div class="paragraph"> |
| <p>When two trees are specified, the user is telling <em>git read-tree</em> |
| the following:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>The current index and work tree is derived from $H, but |
| the user may have local changes in them since $H.</p> |
| </li> |
| <li> |
| <p>The user wants to fast-forward to $M.</p> |
| </li> |
| </ol> |
| </div> |
| <div class="paragraph"> |
| <p>In this case, the <code>git</code> <code>read-tree</code> <code>-m</code> <code>$H</code> <code>$M</code> command makes sure |
| that no local change is lost as the result of this "merge". |
| Here are the "carry forward" rules, where "I" denotes the index, |
| "clean" means that index and work tree coincide, and "exists"/"nothing" |
| refer to the presence of a path in the specified commit:</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre> I H M Result |
| ------------------------------------------------------- |
| 0 nothing nothing nothing (does not happen) |
| 1 nothing nothing exists use M |
| 2 nothing exists nothing remove path from index |
| 3 nothing exists exists, use M if "initial checkout", |
| H == M keep index otherwise |
| exists, fail |
| H != M |
| |
| clean I==H I==M |
| ------------------ |
| 4 yes N/A N/A nothing nothing keep index |
| 5 no N/A N/A nothing nothing keep index |
| |
| 6 yes N/A yes nothing exists keep index |
| 7 no N/A yes nothing exists keep index |
| 8 yes N/A no nothing exists fail |
| 9 no N/A no nothing exists fail |
| |
| 10 yes yes N/A exists nothing remove path from index |
| 11 no yes N/A exists nothing fail |
| 12 yes no N/A exists nothing fail |
| 13 no no N/A exists nothing fail |
| |
| clean (H==M) |
| ------ |
| 14 yes exists exists keep index |
| 15 no exists exists keep index |
| |
| clean I==H I==M (H!=M) |
| ------------------ |
| 16 yes no no exists exists fail |
| 17 no no no exists exists fail |
| 18 yes no yes exists exists keep index |
| 19 no no yes exists exists keep index |
| 20 yes yes no exists exists use M |
| 21 no yes no exists exists fail</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>In all "keep index" cases, the index entry stays as in the |
| original index file. If the entry is not up to date, |
| <em>git read-tree</em> keeps the copy in the work tree intact when |
| operating under the -u flag.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When this form of <em>git read-tree</em> returns successfully, you can |
| see which of the "local changes" that you made were carried forward by running |
| <code>git</code> <code>diff-index</code> <code>--cached</code> <code>$M</code>. Note that this does not |
| necessarily match what <code>git</code> <code>diff-index</code> <code>--cached</code> <code>$H</code> would have |
| produced before such a two tree merge. This is because of cases |
| 18 and 19 — if you already had the changes in $M (e.g. maybe |
| you picked it up via e-mail in a patch form), <code>git</code> <code>diff-index</code> |
| <code>--cached</code> <code>$H</code> would have told you about the change before this |
| merge, but it would not show in <code>git</code> <code>diff-index</code> <code>--cached</code> <code>$M</code> |
| output after the two-tree merge.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Case 3 is slightly tricky and needs explanation. The result from this |
| rule logically should be to remove the path if the user staged the removal |
| of the path and then switching to a new branch. That however will prevent |
| the initial checkout from happening, so the rule is modified to use M (new |
| tree) only when the content of the index is empty. Otherwise the removal |
| of the path is kept as long as $H and $M are the same.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_3_way_merge">3-Way Merge</h3> |
| <div class="paragraph"> |
| <p>Each "index" entry has two bits worth of "stage" state. stage 0 is the |
| normal one, and is the only one you’d see in any kind of normal use.</p> |
| </div> |
| <div class="paragraph"> |
| <p>However, when you do <em>git read-tree</em> with three trees, the "stage" |
| starts out at 1.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This means that you can do</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git read-tree -m <tree1> <tree2> <tree3></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>and you will end up with an index with all of the <tree1> entries in |
| "stage1", all of the <tree2> entries in "stage2" and all of the |
| <tree3> entries in "stage3". When performing a merge of another |
| branch into the current branch, we use the common ancestor tree |
| as <tree1>, the current branch head as <tree2>, and the other |
| branch head as <tree3>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Furthermore, <em>git read-tree</em> has special-case logic that says: if you see |
| a file that matches in all respects in the following states, it |
| "collapses" back to "stage0":</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>stage 2 and 3 are the same; take one or the other (it makes no |
| difference - the same work has been done on our branch in |
| stage 2 and their branch in stage 3)</p> |
| </li> |
| <li> |
| <p>stage 1 and stage 2 are the same and stage 3 is different; take |
| stage 3 (our branch in stage 2 did not do anything since the |
| ancestor in stage 1 while their branch in stage 3 worked on |
| it)</p> |
| </li> |
| <li> |
| <p>stage 1 and stage 3 are the same and stage 2 is different take |
| stage 2 (we did something while they did nothing)</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>The <em>git write-tree</em> command refuses to write a nonsensical tree, and it |
| will complain about unmerged entries if it sees a single entry that is not |
| stage 0.</p> |
| </div> |
| <div class="paragraph"> |
| <p>OK, this all sounds like a collection of totally nonsensical rules, |
| but it’s actually exactly what you want in order to do a fast |
| merge. The different stages represent the "result tree" (stage 0, aka |
| "merged"), the original tree (stage 1, aka "orig"), and the two trees |
| you are trying to merge (stage 2 and 3 respectively).</p> |
| </div> |
| <div class="paragraph"> |
| <p>The order of stages 1, 2 and 3 (hence the order of three |
| <tree-ish> command-line arguments) are significant when you |
| start a 3-way merge with an index file that is already |
| populated. Here is an outline of how the algorithm works:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>if a file exists in identical format in all three trees, it will |
| automatically collapse to "merged" state by <em>git read-tree</em>.</p> |
| </li> |
| <li> |
| <p>a file that has <em>any</em> difference what-so-ever in the three trees |
| will stay as separate entries in the index. It’s up to "porcelain |
| policy" to determine how to remove the non-0 stages, and insert a |
| merged version.</p> |
| </li> |
| <li> |
| <p>the index file saves and restores with all this information, so you |
| can merge things incrementally, but as long as it has entries in |
| stages 1/2/3 (i.e., "unmerged entries") you can’t write the result. So |
| now the merge algorithm ends up being really simple:</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>you walk the index in order, and ignore all entries of stage 0, |
| since they’ve already been done.</p> |
| </li> |
| <li> |
| <p>if you find a "stage1", but no matching "stage2" or "stage3", you |
| know it’s been removed from both trees (it only existed in the |
| original tree), and you remove that entry.</p> |
| </li> |
| <li> |
| <p>if you find a matching "stage2" and "stage3" tree, you remove one |
| of them, and turn the other into a "stage0" entry. Remove any |
| matching "stage1" entry if it exists too. .. all the normal |
| trivial rules ..</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>You would normally use <em>git merge-index</em> with supplied |
| <em>git merge-one-file</em> to do this last step. The script updates |
| the files in the working tree as it merges each path and at the |
| end of a successful merge.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When you start a 3-way merge with an index file that is already |
| populated, it is assumed that it represents the state of the |
| files in your work tree, and you can even have files with |
| changes unrecorded in the index file. It is further assumed |
| that this state is "derived" from the stage 2 tree. The 3-way |
| merge refuses to run if it finds an entry in the original index |
| file that does not match stage 2.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This is done to prevent you from losing your work-in-progress |
| changes, and mixing your random changes in an unrelated merge |
| commit. To illustrate, suppose you start from what has been |
| committed last to your repository:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ JC=`git rev-parse --verify "HEAD^0"` |
| $ git checkout-index -f -u -a $JC</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>You do random edits, without running <em>git update-index</em>. And then |
| you notice that the tip of your "upstream" tree has advanced |
| since you pulled from him:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git fetch git://.... linus |
| $ LT=`git rev-parse FETCH_HEAD`</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Your work tree is still based on your HEAD ($JC), but you have |
| some edits since. Three-way merge makes sure that you have not |
| added or modified index entries since $JC, and if you haven’t, |
| then does the right thing. So with the following sequence:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git read-tree -m -u `git merge-base $JC $LT` $JC $LT |
| $ git merge-index git-merge-one-file -a |
| $ echo "Merge with Linus" | \ |
| git commit-tree `git write-tree` -p $JC -p $LT</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>what you would commit is a pure merge between $JC and $LT without |
| your work-in-progress changes, and your work tree would be |
| updated to the result of the merge.</p> |
| </div> |
| <div class="paragraph"> |
| <p>However, if you have local changes in the working tree that |
| would be overwritten by this merge, <em>git read-tree</em> will refuse |
| to run to prevent your changes from being lost.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In other words, there is no need to worry about what exists only |
| in the working tree. When you have local changes in a part of |
| the project that is not involved in the merge, your changes do |
| not interfere with the merge, and are kept intact. When they |
| <strong>do</strong> interfere, the merge does not even start (<em>git read-tree</em> |
| complains loudly and fails without modifying anything). In such |
| a case, you can simply continue doing what you were in the |
| middle of doing, and when your working tree is ready (i.e. you |
| have finished your work-in-progress), attempt the merge again.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_sparse_checkout">SPARSE CHECKOUT</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Note: The skip-worktree capabilities in <a href="git-update-index.html">git-update-index(1)</a> |
| and <code>read-tree</code> predated the introduction of |
| <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>. Users are encouraged to use the |
| <code>sparse-checkout</code> command in preference to these plumbing commands for |
| sparse-checkout/skip-worktree related needs. However, the information |
| below might be useful to users trying to understand the pattern style |
| used in non-cone mode of the <code>sparse-checkout</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p>"Sparse checkout" allows populating the working directory sparsely. |
| It uses the skip-worktree bit (see <a href="git-update-index.html">git-update-index(1)</a>) to |
| tell Git whether a file in the working directory is worth looking at.</p> |
| </div> |
| <div class="paragraph"> |
| <p><em>git read-tree</em> and other merge-based commands (<em>git merge</em>, <em>git |
| checkout</em>…​) can help maintaining the skip-worktree bitmap and working |
| directory update. <code>$GIT_DIR/info/sparse-checkout</code> is used to |
| define the skip-worktree reference bitmap. When <em>git read-tree</em> needs |
| to update the working directory, it resets the skip-worktree bit in the index |
| based on this file, which uses the same syntax as .gitignore files. |
| If an entry matches a pattern in this file, or the entry corresponds to |
| a file present in the working tree, then skip-worktree will not be |
| set on that entry. Otherwise, skip-worktree will be set.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Then it compares the new skip-worktree value with the previous one. If |
| skip-worktree turns from set to unset, it will add the corresponding |
| file back. If it turns from unset to set, that file will be removed.</p> |
| </div> |
| <div class="paragraph"> |
| <p>While <code>$GIT_DIR/info/sparse-checkout</code> is usually used to specify what |
| files are in, you can also specify what files are <em>not</em> in, using |
| negate patterns. For example, to remove the file <code>unwanted</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>/* |
| !unwanted</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Another tricky thing is fully repopulating the working directory when you |
| no longer want sparse checkout. You cannot just disable "sparse |
| checkout" because skip-worktree bits are still in the index and your working |
| directory is still sparsely populated. You should re-populate the working |
| directory with the <code>$GIT_DIR/info/sparse-checkout</code> file content as |
| follows:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>/*</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Then you can disable sparse checkout. Sparse checkout support in <em>git |
| read-tree</em> and similar commands is disabled by default. You need to |
| turn <code>core.sparseCheckout</code> on in order to have sparse checkout |
| support.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_see_also">SEE ALSO</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><a href="git-write-tree.html">git-write-tree(1)</a>, <a href="git-ls-files.html">git-ls-files(1)</a>, |
| <a href="gitignore.html">gitignore(5)</a>, <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a></p> |
| </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="footer"> |
| <div id="footer-text"> |
| Last updated 2025-02-14 21:38:14 -0800 |
| </div> |
| </div> |
| </body> |
| </html> |
