| <!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-sparse-checkout(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-sparse-checkout(1) Manual Page</h1> |
| <h2 id="_name">NAME</h2> |
| <div class="sectionbody"> |
| <p>git-sparse-checkout - Reduce your working tree to a subset of tracked files</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 sparse-checkout</em> (init | list | set | add | reapply | disable | check-rules) [<options>]</pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_description">DESCRIPTION</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This command is used to create sparse checkouts, which change the |
| working tree from having all tracked files present to only having a |
| subset of those files. It can also switch which subset of files are |
| present, or undo and go back to having all tracked files present in |
| the working copy.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The subset of files is chosen by providing a list of directories in |
| cone mode (the default), or by providing a list of patterns in |
| non-cone mode.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When in a sparse-checkout, other Git commands behave a bit differently. |
| For example, switching branches will not update paths outside the |
| sparse-checkout directories/patterns, and <code>git</code> <code>commit</code> <code>-a</code> will not record |
| paths outside the sparse-checkout directories/patterns as deleted.</p> |
| </div> |
| <div class="paragraph"> |
| <p>THIS COMMAND IS EXPERIMENTAL. ITS BEHAVIOR, AND THE BEHAVIOR OF OTHER |
| COMMANDS IN THE PRESENCE OF SPARSE-CHECKOUTS, WILL LIKELY CHANGE IN |
| THE FUTURE.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_commands">COMMANDS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1"><em>list</em></dt> |
| <dd> |
| <p>Describe the directories or patterns in the sparse-checkout file.</p> |
| </dd> |
| <dt class="hdlist1"><em>set</em></dt> |
| <dd> |
| <p>Enable the necessary sparse-checkout config settings |
| (<code>core.sparseCheckout</code>, <code>core.sparseCheckoutCone</code>, and |
| <code>index.sparse</code>) if they are not already set to the desired values, |
| populate the sparse-checkout file from the list of arguments |
| following the <em>set</em> subcommand, and update the working directory to |
| match.</p> |
| <div class="paragraph"> |
| <p>To ensure that adjusting the sparse-checkout settings within a worktree |
| does not alter the sparse-checkout settings in other worktrees, the <em>set</em> |
| subcommand will upgrade your repository config to use worktree-specific |
| config if not already present. The sparsity defined by the arguments to |
| the <em>set</em> subcommand are stored in the worktree-specific sparse-checkout |
| file. See <a href="git-worktree.html">git-worktree(1)</a> and the documentation of |
| <code>extensions.worktreeConfig</code> in <a href="git-config.html">git-config(1)</a> for more details.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When the <code>--stdin</code> option is provided, the directories or patterns are |
| read from standard in as a newline-delimited list instead of from the |
| arguments.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, the input list is considered a list of directories, matching |
| the output of <code>git</code> <code>ls-tree</code> <code>-d</code> <code>--name-only</code>. This includes interpreting |
| pathnames that begin with a double quote (") as C-style quoted strings. |
| Note that all files under the specified directories (at any depth) will |
| be included in the sparse checkout, as well as files that are siblings |
| of either the given directory or any of its ancestors (see <em>CONE PATTERN |
| SET</em> below for more details). In the past, this was not the default, |
| and <code>--cone</code> needed to be specified or <code>core.sparseCheckoutCone</code> needed |
| to be enabled.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When <code>--no-cone</code> is passed, the input list is considered a list of |
| patterns. This mode has a number of drawbacks, including not working |
| with some options like <code>--sparse-index</code>. As explained in the |
| "Non-cone Problems" section below, we do not recommend using it.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use the <code>--</code>[<code>no-</code>]<code>sparse-index</code> option to use a sparse index (the |
| default is to not use it). A sparse index reduces the size of the |
| index to be more closely aligned with your sparse-checkout |
| definition. This can have significant performance advantages for |
| commands such as <code>git</code> <code>status</code> or <code>git</code> <code>add</code>. This feature is still |
| experimental. Some commands might be slower with a sparse index until |
| they are properly integrated with the feature.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>WARNING:</strong> Using a sparse index requires modifying the index in a way |
| that is not completely understood by external tools. If you have trouble |
| with this compatibility, then run <code>git</code> <code>sparse-checkout</code> <code>init</code> <code>--no-sparse-index</code> |
| to rewrite your index to not be sparse. Older versions of Git will not |
| understand the sparse directory entries index extension and may fail to |
| interact with your repository until it is disabled.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1"><em>add</em></dt> |
| <dd> |
| <p>Update the sparse-checkout file to include additional directories |
| (in cone mode) or patterns (in non-cone mode). By default, these |
| directories or patterns are read from the command-line arguments, |
| but they can be read from stdin using the <code>--stdin</code> option.</p> |
| </dd> |
| <dt class="hdlist1"><em>reapply</em></dt> |
| <dd> |
| <p>Reapply the sparsity pattern rules to paths in the working tree. |
| Commands like merge or rebase can materialize paths to do their |
| work (e.g. in order to show you a conflict), and other |
| sparse-checkout commands might fail to sparsify an individual file |
| (e.g. because it has unstaged changes or conflicts). In such |
| cases, it can make sense to run <code>git</code> <code>sparse-checkout</code> <code>reapply</code> later |
| after cleaning up affected paths (e.g. resolving conflicts, undoing |
| or committing changes, etc.).</p> |
| <div class="paragraph"> |
| <p>The <code>reapply</code> command can also take <code>--</code>[<code>no-</code>]<code>cone</code> and <code>--</code>[<code>no-</code>]<code>sparse-index</code> |
| flags, with the same meaning as the flags from the <code>set</code> command, in order |
| to change which sparsity mode you are using without needing to also respecify |
| all sparsity paths.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1"><em>disable</em></dt> |
| <dd> |
| <p>Disable the <code>core.sparseCheckout</code> config setting, and restore the |
| working directory to include all files.</p> |
| </dd> |
| <dt class="hdlist1"><em>init</em></dt> |
| <dd> |
| <p>Deprecated command that behaves like <code>set</code> with no specified paths. |
| May be removed in the future.</p> |
| <div class="paragraph"> |
| <p>Historically, <code>set</code> did not handle all the necessary config settings, |
| which meant that both <code>init</code> and <code>set</code> had to be called. Invoking |
| both meant the <code>init</code> step would first remove nearly all tracked files |
| (and in cone mode, ignored files too), then the <code>set</code> step would add |
| many of the tracked files (but not ignored files) back. In addition |
| to the lost files, the performance and UI of this combination was |
| poor.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Also, historically, <code>init</code> would not actually initialize the |
| sparse-checkout file if it already existed. This meant it was |
| possible to return to a sparse-checkout without remembering which |
| paths to pass to a subsequent <em>set</em> or <em>add</em> command. However, |
| <code>--cone</code> and <code>--sparse-index</code> options would not be remembered across |
| the disable command, so the easy restore of calling a plain <code>init</code> |
| decreased in utility.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1"><em>check-rules</em></dt> |
| <dd> |
| <p>Check whether sparsity rules match one or more paths.</p> |
| <div class="paragraph"> |
| <p>By default <code>check-rules</code> reads a list of paths from stdin and outputs only |
| the ones that match the current sparsity rules. The input is expected to consist |
| of one path per line, matching the output of <code>git</code> <code>ls-tree</code> <code>--name-only</code> including |
| that pathnames that begin with a double quote (") are interpreted as C-style |
| quoted strings.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When called with the <code>--rules-file</code> <em><file></em> flag the input files are matched |
| against the sparse checkout rules found in <em><file></em> instead of the current ones. |
| The rules in the files are expected to be in the same form as accepted by <code>git</code> |
| <code>sparse-checkout</code> <code>set</code> <code>--stdin</code> (in particular, they must be newline-delimited).</p> |
| </div> |
| <div class="paragraph"> |
| <p>By default, the rules passed to the <code>--rules-file</code> option are interpreted as |
| cone mode directories. To pass non-cone mode patterns with <code>--rules-file</code>, |
| combine the option with the <code>--no-cone</code> option.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When called with the <code>-z</code> flag, the format of the paths input on stdin as well |
| as the output paths are \0 terminated and not quoted. Note that this does not |
| apply to the format of the rules passed with the <code>--rules-file</code> option.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_examples">EXAMPLES</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1"><code>git</code> <code>sparse-checkout</code> <code>set</code> <code>MY/DIR1</code> <code>SUB/DIR2</code></dt> |
| <dd> |
| <p>Change to a sparse checkout with all files (at any depth) under |
| MY/DIR1/ and SUB/DIR2/ present in the working copy (plus all |
| files immediately under MY/ and SUB/ and the toplevel |
| directory). If already in a sparse checkout, change which files |
| are present in the working copy to this new selection. Note |
| that this command will also delete all ignored files in any |
| directory that no longer has either tracked or |
| non-ignored-untracked files present.</p> |
| </dd> |
| <dt class="hdlist1"><code>git</code> <code>sparse-checkout</code> <code>disable</code></dt> |
| <dd> |
| <p>Repopulate the working directory with all files, disabling sparse |
| checkouts.</p> |
| </dd> |
| <dt class="hdlist1"><code>git</code> <code>sparse-checkout</code> <code>add</code> <code>SOME/DIR/ECTORY</code></dt> |
| <dd> |
| <p>Add all files under SOME/DIR/ECTORY/ (at any depth) to the |
| sparse checkout, as well as all files immediately under |
| SOME/DIR/ and immediately under SOME/. Must already be in a |
| sparse checkout before using this command.</p> |
| </dd> |
| <dt class="hdlist1"><code>git</code> <code>sparse-checkout</code> <code>reapply</code></dt> |
| <dd> |
| <p>It is possible for commands to update the working tree in a |
| way that does not respect the selected sparsity directories. |
| This can come from tools external to Git writing files, or |
| even affect Git commands because of either special cases (such |
| as hitting conflicts when merging/rebasing), or because some |
| commands didn’t fully support sparse checkouts (e.g. the old |
| <code>recursive</code> merge backend had only limited support). This |
| command reapplies the existing sparse directory specifications |
| to make the working directory match.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_internalssparse_checkout">INTERNALS — SPARSE CHECKOUT</h2> |
| <div class="sectionbody"> |
| <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. If the |
| skip-worktree bit is set, and the file is not present in the working tree, |
| then its absence is ignored. Git will avoid populating the contents of |
| those files, which makes a sparse checkout helpful when working in a |
| repository with many files, but only a few are important to the current |
| user.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>$GIT_DIR/info/sparse-checkout</code> file is used to define the |
| skip-worktree reference bitmap. When Git updates the working |
| directory, it updates the skip-worktree bits in the index based |
| on this file. The files matching the patterns in the file will |
| appear in the working directory, and the rest will not.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_internalsnon_cone_problems">INTERNALS — NON-CONE PROBLEMS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>$GIT_DIR/info/sparse-checkout</code> file populated by the <code>set</code> and |
| <code>add</code> subcommands is defined to be a bunch of patterns (one per line) |
| using the same syntax as .<code>gitignore</code> files. In cone mode, these |
| patterns are restricted to matching directories (and users only ever |
| need supply or see directory names), while in non-cone mode any |
| gitignore-style pattern is permitted. Using the full gitignore-style |
| patterns in non-cone mode has a number of shortcomings:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Fundamentally, it makes various worktree-updating processes (pull, |
| merge, rebase, switch, reset, checkout, etc.) require O(N*M) pattern |
| matches, where N is the number of patterns and M is the number of |
| paths in the index. This scales poorly.</p> |
| </li> |
| <li> |
| <p>Avoiding the scaling issue has to be done via limiting the number |
| of patterns via specifying leading directory name or glob.</p> |
| </li> |
| <li> |
| <p>Passing globs on the command line is error-prone as users may |
| forget to quote the glob, causing the shell to expand it into all |
| matching files and pass them all individually along to |
| sparse-checkout set/add. While this could also be a problem with |
| e.g. "git grep — *.c", mistakes with grep/log/status appear in |
| the immediate output. With sparse-checkout, the mistake gets |
| recorded at the time the sparse-checkout command is run and might |
| not be problematic until the user later switches branches or rebases |
| or merges, thus putting a delay between the user’s error and when |
| they have a chance to catch/notice it.</p> |
| </li> |
| <li> |
| <p>Related to the previous item, sparse-checkout has an <em>add</em> |
| subcommand but no <em>remove</em> subcommand. Even if a <em>remove</em> |
| subcommand were added, undoing an accidental unquoted glob runs |
| the risk of "removing too much", as it may remove entries that had |
| been included before the accidental add.</p> |
| </li> |
| <li> |
| <p>Non-cone mode uses gitignore-style patterns to select what to |
| <strong>include</strong> (with the exception of negated patterns), while |
| .gitignore files use gitignore-style patterns to select what to |
| <strong>exclude</strong> (with the exception of negated patterns). The |
| documentation on gitignore-style patterns usually does not talk in |
| terms of matching or non-matching, but on what the user wants to |
| "exclude". This can cause confusion for users trying to learn how |
| to specify sparse-checkout patterns to get their desired behavior.</p> |
| </li> |
| <li> |
| <p>Every other git subcommand that wants to provide "special path |
| pattern matching" of some sort uses pathspecs, but non-cone mode |
| for sparse-checkout uses gitignore patterns, which feels |
| inconsistent.</p> |
| </li> |
| <li> |
| <p>It has edge cases where the "right" behavior is unclear. Two examples:</p> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>First, two users are in a subdirectory, and the first runs |
| git sparse-checkout set '/toplevel-dir/*.c' |
| while the second runs |
| git sparse-checkout set relative-dir |
| Should those arguments be transliterated into |
| current/subdirectory/toplevel-dir/*.c |
| and |
| current/subdirectory/relative-dir |
| before inserting into the sparse-checkout file? The user who typed |
| the first command is probably aware that arguments to set/add are |
| supposed to be patterns in non-cone mode, and probably would not be |
| happy with such a transliteration. However, many gitignore-style |
| patterns are just paths, which might be what the user who typed the |
| second command was thinking, and they'd be upset if their argument |
| wasn't transliterated.</pre> |
| </div> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>Second, what should bash-completion complete on for set/add commands |
| for non-cone users? If it suggests paths, is it exacerbating the |
| problem above? Also, if it suggests paths, what if the user has a |
| file or directory that begins with either a '!' or '#' or has a '*', |
| '\', '?', '[', or ']' in its name? And if it suggests paths, will |
| it complete "/pro" to "/proc" (in the root filesystem) rather than to |
| "/progress.txt" in the current directory? (Note that users are |
| likely to want to start paths with a leading '/' in non-cone mode, |
| for the same reason that .gitignore files often have one.) |
| Completing on files or directories might give nasty surprises in |
| all these cases.</pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>The excessive flexibility made other extensions essentially |
| impractical. <code>--sparse-index</code> is likely impossible in non-cone |
| mode; even if it is somehow feasible, it would have been far more |
| work to implement and may have been too slow in practice. Some |
| ideas for adding coupling between partial clones and sparse |
| checkouts are only practical with a more restricted set of paths |
| as well.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For all these reasons, non-cone mode is deprecated. Please switch to |
| using cone mode.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_internalscone_mode_handling">INTERNALS — CONE MODE HANDLING</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The "cone mode", which is the default, lets you specify only what |
| directories to include. For any directory specified, all paths below |
| that directory will be included, and any paths immediately under |
| leading directories (including the toplevel directory) will also be |
| included. Thus, if you specified the directory |
| Documentation/technical/ |
| then your sparse checkout would contain:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>all files in the toplevel-directory</p> |
| </li> |
| <li> |
| <p>all files immediately under Documentation/</p> |
| </li> |
| <li> |
| <p>all files at any depth under Documentation/technical/</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Also, in cone mode, even if no directories are specified, then the |
| files in the toplevel directory will be included.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When changing the sparse-checkout patterns in cone mode, Git will inspect each |
| tracked directory that is not within the sparse-checkout cone to see if it |
| contains any untracked files. If all of those files are ignored due to the |
| .<code>gitignore</code> patterns, then the directory will be deleted. If any of the |
| untracked files within that directory is not ignored, then no deletions will |
| occur within that directory and a warning message will appear. If these files |
| are important, then reset your sparse-checkout definition so they are included, |
| use <code>git</code> <code>add</code> and <code>git</code> <code>commit</code> to store them, then remove any remaining files |
| manually to ensure Git can behave optimally.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See also the "Internals — Cone Pattern Set" section to learn how the |
| directories are transformed under the hood into a subset of the |
| Full Pattern Set of sparse-checkout.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_internalsfull_pattern_set">INTERNALS — FULL PATTERN SET</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The full pattern set allows for arbitrary pattern matches and complicated |
| inclusion/exclusion rules. These can result in O(N*M) pattern matches when |
| updating the index, where N is the number of patterns and M is the number |
| of paths in the index. To combat this performance issue, a more restricted |
| pattern set is allowed when <code>core.sparseCheckoutCone</code> is enabled.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The sparse-checkout file uses the same syntax as .<code>gitignore</code> files; |
| see <a href="gitignore.html">gitignore(5)</a> for details. Here, though, the patterns are |
| usually being used to select which files to include rather than which |
| files to exclude. (However, it can get a bit confusing since |
| gitignore-style patterns have negations defined by patterns which |
| begin with a <em>!</em>, so you can also select files to <em>not</em> include.)</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example, to select everything, and then to remove the file |
| <code>unwanted</code> (so that every file will appear in your working tree except |
| the file named <code>unwanted</code>):</p> |
| </div> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>git sparse-checkout set --no-cone '/*' '!unwanted'</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>These patterns are just placed into the |
| <code>$GIT_DIR/info/sparse-checkout</code> as-is, so the contents of that file |
| at this point would be</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>/* |
| !unwanted</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>See also the "Sparse Checkout" section of <a href="git-read-tree.html">git-read-tree(1)</a> to |
| learn more about the gitignore-style patterns used in sparse |
| checkouts.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_internalscone_pattern_set">INTERNALS — CONE PATTERN SET</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>In cone mode, only directories are accepted, but they are translated into |
| the same gitignore-style patterns used in the full pattern set. We refer |
| to the particular patterns used in those mode as being of one of two types:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p><strong>Recursive:</strong> All paths inside a directory are included.</p> |
| </li> |
| <li> |
| <p><strong>Parent:</strong> All files immediately inside a directory are included.</p> |
| </li> |
| </ol> |
| </div> |
| <div class="paragraph"> |
| <p>Since cone mode always includes files at the toplevel, when running |
| <code>git</code> <code>sparse-checkout</code> <code>set</code> with no directories specified, the toplevel |
| directory is added as a parent pattern. At this point, the |
| sparse-checkout file contains the following patterns:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>/* |
| !/*/</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This says "include everything immediately under the toplevel |
| directory, but nothing at any level below that."</p> |
| </div> |
| <div class="paragraph"> |
| <p>When in cone mode, the <code>git</code> <code>sparse-checkout</code> <code>set</code> subcommand takes a |
| list of directories. The command <code>git</code> <code>sparse-checkout</code> <code>set</code> <code>A/B/C</code> sets |
| the directory <code>A/B/C</code> as a recursive pattern, the directories <code>A</code> and |
| <code>A/B</code> are added as parent patterns. The resulting sparse-checkout file |
| is now</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>/* |
| !/*/ |
| /A/ |
| !/A/*/ |
| /A/B/ |
| !/A/B/*/ |
| /A/B/C/</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Here, order matters, so the negative patterns are overridden by the positive |
| patterns that appear lower in the file.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Unless <code>core.sparseCheckoutCone</code> is explicitly set to <code>false</code>, Git will |
| parse the sparse-checkout file expecting patterns of these types. Git will |
| warn if the patterns do not match. If the patterns do match the expected |
| format, then Git will use faster hash-based algorithms to compute inclusion |
| in the sparse-checkout. If they do not match, git will behave as though |
| <code>core.sparseCheckoutCone</code> was false, regardless of its setting.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In the cone mode case, despite the fact that full patterns are written |
| to the $GIT_DIR/info/sparse-checkout file, the <code>git</code> <code>sparse-checkout</code> |
| <code>list</code> subcommand will list the directories that define the recursive |
| patterns. For the example sparse-checkout file above, the output is as |
| follows:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git sparse-checkout list |
| A/B/C</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>core.ignoreCase=true</code>, then the pattern-matching algorithm will use a |
| case-insensitive check. This corrects for case mismatched filenames in the |
| <em>git sparse-checkout set</em> command to reflect the expected cone in the working |
| directory.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_internalssubmodules">INTERNALS — SUBMODULES</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>If your repository contains one or more submodules, then submodules |
| are populated based on interactions with the <code>git</code> <code>submodule</code> command. |
| Specifically, <code>git</code> <code>submodule</code> <code>init</code> <code>--</code> <em><path></em> will ensure the submodule |
| at <em><path></em> is present, while <code>git</code> <code>submodule</code> <code>deinit</code> [<code>-f</code>] <code>--</code> <em><path></em> |
| will remove the files for the submodule at <em><path></em> (including any |
| untracked files, uncommitted changes, and unpushed history). Similar |
| to how sparse-checkout removes files from the working tree but still |
| leaves entries in the index, deinitialized submodules are removed from |
| the working directory but still have an entry in the index.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Since submodules may have unpushed changes or untracked files, |
| removing them could result in data loss. Thus, changing sparse |
| inclusion/exclusion rules will not cause an already checked out |
| submodule to be removed from the working copy. Said another way, just |
| as <code>checkout</code> will not cause submodules to be automatically removed or |
| initialized even when switching between branches that remove or add |
| submodules, using <code>sparse-checkout</code> to reduce or expand the scope of |
| "interesting" files will not cause submodules to be automatically |
| deinitialized or initialized either.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Further, the above facts mean that there are multiple reasons that |
| "tracked" files might not be present in the working copy: sparsity |
| pattern application from sparse-checkout, and submodule initialization |
| state. Thus, commands like <code>git</code> <code>grep</code> that work on tracked files in |
| the working copy may return results that are limited by either or both |
| of these restrictions.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_see_also">SEE ALSO</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><a href="git-read-tree.html">git-read-tree(1)</a> |
| <a href="gitignore.html">gitignore(5)</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-06-20 18:10:42 -0700 |
| </div> |
| </div> |
| </body> |
| </html> |
