| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> | |
| <meta name="generator" content="AsciiDoc 9.0.0rc1" /> | |
| <title>git-sparse-checkout(1)</title> | |
| <style type="text/css"> | |
| /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ | |
| /* Default font. */ | |
| body { | |
| font-family: Georgia,serif; | |
| } | |
| /* Title font. */ | |
| h1, h2, h3, h4, h5, h6, | |
| div.title, caption.title, | |
| thead, p.table.header, | |
| #toctitle, | |
| #author, #revnumber, #revdate, #revremark, | |
| #footer { | |
| font-family: Arial,Helvetica,sans-serif; | |
| } | |
| body { | |
| margin: 1em 5% 1em 5%; | |
| } | |
| a { | |
| color: blue; | |
| text-decoration: underline; | |
| } | |
| a:visited { | |
| color: fuchsia; | |
| } | |
| em { | |
| font-style: italic; | |
| color: navy; | |
| } | |
| strong { | |
| font-weight: bold; | |
| color: #083194; | |
| } | |
| h1, h2, h3, h4, h5, h6 { | |
| color: #527bbd; | |
| margin-top: 1.2em; | |
| margin-bottom: 0.5em; | |
| line-height: 1.3; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| padding-top: 0.5em; | |
| } | |
| h3 { | |
| float: left; | |
| } | |
| h3 + * { | |
| clear: left; | |
| } | |
| h5 { | |
| font-size: 1.0em; | |
| } | |
| div.sectionbody { | |
| margin-left: 0; | |
| } | |
| hr { | |
| border: 1px solid silver; | |
| } | |
| p { | |
| margin-top: 0.5em; | |
| margin-bottom: 0.5em; | |
| } | |
| ul, ol, li > p { | |
| margin-top: 0; | |
| } | |
| ul > li { color: #aaa; } | |
| ul > li > * { color: black; } | |
| .monospaced, code, pre { | |
| font-family: "Courier New", Courier, monospace; | |
| font-size: inherit; | |
| color: navy; | |
| padding: 0; | |
| margin: 0; | |
| } | |
| pre { | |
| white-space: pre-wrap; | |
| } | |
| #author { | |
| color: #527bbd; | |
| font-weight: bold; | |
| font-size: 1.1em; | |
| } | |
| #email { | |
| } | |
| #revnumber, #revdate, #revremark { | |
| } | |
| #footer { | |
| font-size: small; | |
| border-top: 2px solid silver; | |
| padding-top: 0.5em; | |
| margin-top: 4.0em; | |
| } | |
| #footer-text { | |
| float: left; | |
| padding-bottom: 0.5em; | |
| } | |
| #footer-badges { | |
| float: right; | |
| padding-bottom: 0.5em; | |
| } | |
| #preamble { | |
| margin-top: 1.5em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.imageblock, div.exampleblock, div.verseblock, | |
| div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
| div.admonitionblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.admonitionblock { | |
| margin-top: 2.0em; | |
| margin-bottom: 2.0em; | |
| margin-right: 10%; | |
| color: #606060; | |
| } | |
| div.content { /* Block element content. */ | |
| padding: 0; | |
| } | |
| /* Block element titles. */ | |
| div.title, caption.title { | |
| color: #527bbd; | |
| font-weight: bold; | |
| text-align: left; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.5em; | |
| } | |
| div.title + * { | |
| margin-top: 0; | |
| } | |
| td div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content + div.title { | |
| margin-top: 0.0em; | |
| } | |
| div.sidebarblock > div.content { | |
| background: #ffffee; | |
| border: 1px solid #dddddd; | |
| border-left: 4px solid #f0f0f0; | |
| padding: 0.5em; | |
| } | |
| div.listingblock > div.content { | |
| border: 1px solid #dddddd; | |
| border-left: 5px solid #f0f0f0; | |
| background: #f8f8f8; | |
| padding: 0.5em; | |
| } | |
| div.quoteblock, div.verseblock { | |
| padding-left: 1.0em; | |
| margin-left: 1.0em; | |
| margin-right: 10%; | |
| border-left: 5px solid #f0f0f0; | |
| color: #888; | |
| } | |
| div.quoteblock > div.attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock > pre.content { | |
| font-family: inherit; | |
| font-size: inherit; | |
| } | |
| div.verseblock > div.attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
| div.verseblock + div.attribution { | |
| text-align: left; | |
| } | |
| div.admonitionblock .icon { | |
| vertical-align: top; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| text-decoration: underline; | |
| color: #527bbd; | |
| padding-right: 0.5em; | |
| } | |
| div.admonitionblock td.content { | |
| padding-left: 0.5em; | |
| border-left: 3px solid #dddddd; | |
| } | |
| div.exampleblock > div.content { | |
| border-left: 3px solid #dddddd; | |
| padding-left: 0.5em; | |
| } | |
| div.imageblock div.content { padding-left: 0; } | |
| span.image img { border-style: none; vertical-align: text-bottom; } | |
| a.image:visited { color: white; } | |
| dl { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| dt { | |
| margin-top: 0.5em; | |
| margin-bottom: 0; | |
| font-style: normal; | |
| color: navy; | |
| } | |
| dd > *:first-child { | |
| margin-top: 0.1em; | |
| } | |
| ul, ol { | |
| list-style-position: outside; | |
| } | |
| ol.arabic { | |
| list-style-type: decimal; | |
| } | |
| 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; | |
| } | |
| div.compact ul, div.compact ol, | |
| div.compact p, div.compact p, | |
| div.compact div, div.compact div { | |
| margin-top: 0.1em; | |
| margin-bottom: 0.1em; | |
| } | |
| tfoot { | |
| font-weight: bold; | |
| } | |
| td > div.verse { | |
| white-space: pre; | |
| } | |
| div.hdlist { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| div.hdlist tr { | |
| padding-bottom: 15px; | |
| } | |
| dt.hdlist1.strong, td.hdlist1.strong { | |
| font-weight: bold; | |
| } | |
| td.hdlist1 { | |
| vertical-align: top; | |
| font-style: normal; | |
| padding-right: 0.8em; | |
| color: navy; | |
| } | |
| td.hdlist2 { | |
| vertical-align: top; | |
| } | |
| div.hdlist.compact tr { | |
| margin: 0; | |
| padding-bottom: 0; | |
| } | |
| .comment { | |
| background: yellow; | |
| } | |
| .footnote, .footnoteref { | |
| font-size: 0.8em; | |
| } | |
| span.footnote, span.footnoteref { | |
| vertical-align: super; | |
| } | |
| #footnotes { | |
| margin: 20px 0 20px 0; | |
| padding: 7px 0 0 0; | |
| } | |
| #footnotes div.footnote { | |
| margin: 0 0 5px 0; | |
| } | |
| #footnotes hr { | |
| border: none; | |
| border-top: 1px solid silver; | |
| height: 1px; | |
| text-align: left; | |
| margin-left: 0; | |
| width: 20%; | |
| min-width: 100px; | |
| } | |
| div.colist td { | |
| padding-right: 0.5em; | |
| padding-bottom: 0.3em; | |
| vertical-align: top; | |
| } | |
| div.colist td img { | |
| margin-top: 0.3em; | |
| } | |
| @media print { | |
| #footer-badges { display: none; } | |
| } | |
| #toc { | |
| margin-bottom: 2.5em; | |
| } | |
| #toctitle { | |
| color: #527bbd; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
| margin-top: 0; | |
| margin-bottom: 0; | |
| } | |
| div.toclevel2 { | |
| margin-left: 2em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel3 { | |
| margin-left: 4em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel4 { | |
| margin-left: 6em; | |
| font-size: 0.9em; | |
| } | |
| span.aqua { color: aqua; } | |
| span.black { color: black; } | |
| span.blue { color: blue; } | |
| span.fuchsia { color: fuchsia; } | |
| span.gray { color: gray; } | |
| span.green { color: green; } | |
| span.lime { color: lime; } | |
| span.maroon { color: maroon; } | |
| span.navy { color: navy; } | |
| span.olive { color: olive; } | |
| span.purple { color: purple; } | |
| span.red { color: red; } | |
| span.silver { color: silver; } | |
| span.teal { color: teal; } | |
| span.white { color: white; } | |
| span.yellow { color: yellow; } | |
| span.aqua-background { background: aqua; } | |
| span.black-background { background: black; } | |
| span.blue-background { background: blue; } | |
| span.fuchsia-background { background: fuchsia; } | |
| span.gray-background { background: gray; } | |
| span.green-background { background: green; } | |
| span.lime-background { background: lime; } | |
| span.maroon-background { background: maroon; } | |
| span.navy-background { background: navy; } | |
| span.olive-background { background: olive; } | |
| span.purple-background { background: purple; } | |
| span.red-background { background: red; } | |
| span.silver-background { background: silver; } | |
| span.teal-background { background: teal; } | |
| span.white-background { background: white; } | |
| span.yellow-background { background: yellow; } | |
| span.big { font-size: 2em; } | |
| span.small { font-size: 0.6em; } | |
| span.underline { text-decoration: underline; } | |
| span.overline { text-decoration: overline; } | |
| span.line-through { text-decoration: line-through; } | |
| div.unbreakable { page-break-inside: avoid; } | |
| /* | |
| * xhtml11 specific | |
| * | |
| * */ | |
| div.tableblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.tableblock > table { | |
| border: 3px solid #527bbd; | |
| } | |
| thead, p.table.header { | |
| font-weight: bold; | |
| color: #527bbd; | |
| } | |
| p.table { | |
| margin-top: 0; | |
| } | |
| /* Because the table frame attribute is overridden by CSS in most browsers. */ | |
| div.tableblock > table[frame="void"] { | |
| border-style: none; | |
| } | |
| div.tableblock > table[frame="hsides"] { | |
| border-left-style: none; | |
| border-right-style: none; | |
| } | |
| div.tableblock > table[frame="vsides"] { | |
| border-top-style: none; | |
| border-bottom-style: none; | |
| } | |
| /* | |
| * html5 specific | |
| * | |
| * */ | |
| table.tableblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| thead, p.tableblock.header { | |
| font-weight: bold; | |
| color: #527bbd; | |
| } | |
| p.tableblock { | |
| margin-top: 0; | |
| } | |
| table.tableblock { | |
| border-width: 3px; | |
| border-spacing: 0px; | |
| border-style: solid; | |
| border-color: #527bbd; | |
| border-collapse: collapse; | |
| } | |
| th.tableblock, td.tableblock { | |
| border-width: 1px; | |
| padding: 4px; | |
| border-style: solid; | |
| border-color: #527bbd; | |
| } | |
| table.tableblock.frame-topbot { | |
| border-left-style: hidden; | |
| border-right-style: hidden; | |
| } | |
| table.tableblock.frame-sides { | |
| border-top-style: hidden; | |
| border-bottom-style: hidden; | |
| } | |
| table.tableblock.frame-none { | |
| border-style: hidden; | |
| } | |
| th.tableblock.halign-left, td.tableblock.halign-left { | |
| text-align: left; | |
| } | |
| th.tableblock.halign-center, td.tableblock.halign-center { | |
| text-align: center; | |
| } | |
| th.tableblock.halign-right, td.tableblock.halign-right { | |
| text-align: right; | |
| } | |
| th.tableblock.valign-top, td.tableblock.valign-top { | |
| vertical-align: top; | |
| } | |
| th.tableblock.valign-middle, td.tableblock.valign-middle { | |
| vertical-align: middle; | |
| } | |
| th.tableblock.valign-bottom, td.tableblock.valign-bottom { | |
| vertical-align: bottom; | |
| } | |
| /* | |
| * manpage specific | |
| * | |
| * */ | |
| body.manpage h1 { | |
| padding-top: 0.5em; | |
| padding-bottom: 0.5em; | |
| border-top: 2px solid silver; | |
| border-bottom: 2px solid silver; | |
| } | |
| body.manpage h2 { | |
| border-style: none; | |
| } | |
| body.manpage div.sectionbody { | |
| margin-left: 3em; | |
| } | |
| @media print { | |
| body.manpage div#toc { display: none; } | |
| } | |
| </style> | |
| <script type="text/javascript"> | |
| /*<+'])'); | |
| // Function that scans the DOM tree for header elements (the DOM2 | |
| // nodeIterator API would be a better technique but not supported by all | |
| // browsers). | |
| var iterate = function (el) { | |
| for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
| if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
| var mo = re.exec(i.tagName); | |
| if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
| result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
| } | |
| iterate(i); | |
| } | |
| } | |
| } | |
| iterate(el); | |
| return result; | |
| } | |
| var toc = document.getElementById("toc"); | |
| if (!toc) { | |
| return; | |
| } | |
| // Delete existing TOC entries in case we're reloading the TOC. | |
| var tocEntriesToRemove = []; | |
| var i; | |
| for (i = 0; i < toc.childNodes.length; i++) { | |
| var entry = toc.childNodes[i]; | |
| if (entry.nodeName.toLowerCase() == 'div' | |
| && entry.getAttribute("class") | |
| && entry.getAttribute("class").match(/^toclevel/)) | |
| tocEntriesToRemove.push(entry); | |
| } | |
| for (i = 0; i < tocEntriesToRemove.length; i++) { | |
| toc.removeChild(tocEntriesToRemove[i]); | |
| } | |
| // Rebuild TOC entries. | |
| var entries = tocEntries(document.getElementById("content"), toclevels); | |
| for (var i = 0; i < entries.length; ++i) { | |
| var entry = entries[i]; | |
| if (entry.element.id == "") | |
| entry.element.id = "_toc_" + i; | |
| var a = document.createElement("a"); | |
| a.href = "#" + entry.element.id; | |
| a.appendChild(document.createTextNode(entry.text)); | |
| var div = document.createElement("div"); | |
| div.appendChild(a); | |
| div.className = "toclevel" + entry.toclevel; | |
| toc.appendChild(div); | |
| } | |
| if (entries.length == 0) | |
| toc.parentNode.removeChild(toc); | |
| }, | |
| ///////////////////////////////////////////////////////////////////// | |
| // Footnotes generator | |
| ///////////////////////////////////////////////////////////////////// | |
| /* Based on footnote generation code from: | |
| * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
| */ | |
| footnotes: function () { | |
| // Delete existing footnote entries in case we're reloading the footnodes. | |
| var i; | |
| var noteholder = document.getElementById("footnotes"); | |
| if (!noteholder) { | |
| return; | |
| } | |
| var entriesToRemove = []; | |
| for (i = 0; i < noteholder.childNodes.length; i++) { | |
| var entry = noteholder.childNodes[i]; | |
| if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") | |
| entriesToRemove.push(entry); | |
| } | |
| for (i = 0; i < entriesToRemove.length; i++) { | |
| noteholder.removeChild(entriesToRemove[i]); | |
| } | |
| // Rebuild footnote entries. | |
| var cont = document.getElementById("content"); | |
| var spans = cont.getElementsByTagName("span"); | |
| var refs = {}; | |
| var n = 0; | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnote") { | |
| n++; | |
| var note = spans[i].getAttribute("data-note"); | |
| if (!note) { | |
| // Use [\s\S] in place of . so multi-line matches work. | |
| // Because JavaScript has no s (dotall) regex flag. | |
| note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
| spans[i].innerHTML = | |
| "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| spans[i].setAttribute("data-note", note); | |
| } | |
| noteholder.innerHTML += | |
| "<div class='footnote' id='_footnote_" + n + "'>" + | |
| "<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
| n + "</a>. " + note + "</div>"; | |
| var id =spans[i].getAttribute("id"); | |
| if (id != null) refs["#"+id] = n; | |
| } | |
| } | |
| if (n == 0) | |
| noteholder.parentNode.removeChild(noteholder); | |
| else { | |
| // Process footnoterefs. | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnoteref") { | |
| var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
| href = href.match(/#.*/)[0]; // Because IE return full URL. | |
| n = refs[href]; | |
| spans[i].innerHTML = | |
| "[<a href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| } | |
| } | |
| } | |
| }, | |
| install: function(toclevels) { | |
| var timerId; | |
| function reinstall() { | |
| asciidoc.footnotes(); | |
| if (toclevels) { | |
| asciidoc.toc(toclevels); | |
| } | |
| } | |
| function reinstallAndRemoveTimer() { | |
| clearInterval(timerId); | |
| reinstall(); | |
| } | |
| timerId = setInterval(reinstall, 500); | |
| if (document.addEventListener) | |
| document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); | |
| else | |
| window.onload = reinstallAndRemoveTimer; | |
| } | |
| } | |
| asciidoc.install(); | |
| /*]]>*/ | |
| </script> | |
| </head> | |
| <body class="manpage"> | |
| <div id="header"> | |
| <h1> | |
| git-sparse-checkout(1) Manual Page | |
| </h1> | |
| <h2>NAME</h2> | |
| <div class="sectionbody"> | |
| <p>git-sparse-checkout - | |
| Initialize and modify the sparse-checkout configuration, which reduces the checkout to a set of paths given by a list of patterns. | |
| </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 <subcommand> [options]</em></pre> | |
| <div class="attribution"> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_description">DESCRIPTION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Initialize and modify the sparse-checkout configuration, which reduces | |
| the checkout to a set of paths given by a list of patterns.</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 patterns in the sparse-checkout file. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>init</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| Enable the <code>core.sparseCheckout</code> setting. If the | |
| sparse-checkout file does not exist, then populate it with | |
| patterns that match every file in the root directory and | |
| no other directories, then will remove all directories tracked | |
| by Git. Add patterns to the sparse-checkout file to | |
| repopulate the working directory. | |
| </p> | |
| <div class="paragraph"><p>To avoid interfering with other worktrees, it first enables the | |
| <code>extensions.worktreeConfig</code> setting and makes sure to set the | |
| <code>core.sparseCheckout</code> setting in the worktree-specific config file.</p></div> | |
| <div class="paragraph"><p>When <code>--cone</code> is provided, the <code>core.sparseCheckoutCone</code> setting is | |
| also set, allowing for better performance with a limited set of | |
| patterns (see <em>CONE PATTERN SET</em> below).</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>set</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| Write a set of patterns to the sparse-checkout file, as given as | |
| a list of arguments following the <em>set</em> subcommand. Update the | |
| working directory to match the new patterns. Enable the | |
| core.sparseCheckout config setting if it is not already enabled. | |
| </p> | |
| <div class="paragraph"><p>When the <code>--stdin</code> option is provided, the patterns are read from | |
| standard in as a newline-delimited list instead of from the arguments.</p></div> | |
| <div class="paragraph"><p>When <code>core.sparseCheckoutCone</code> is enabled, the input list is considered a | |
| list of directories instead of sparse-checkout patterns. The command writes | |
| patterns to the sparse-checkout file to include all files contained in those | |
| directories (recursively) as well as files that are siblings of ancestor | |
| directories. The input format matches the output of <code>git ls-tree --name-only</code>. | |
| This includes interpreting pathnames that begin with a double quote (") as | |
| C-style quoted strings.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <em>add</em> | |
| </dt> | |
| <dd> | |
| <p> | |
| Update the sparse-checkout file to include additional patterns. | |
| By default, these patterns are read from the command-line arguments, | |
| but they can be read from stdin using the <code>--stdin</code> option. When | |
| <code>core.sparseCheckoutCone</code> is enabled, the given patterns are interpreted | |
| as directory names as in the <em>set</em> subcommand. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| 'reapply | |
| </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 sparse-checkout reapply</code> later | |
| after cleaning up affected paths (e.g. resolving conflicts, undoing | |
| or committing changes, etc.). | |
| </p> | |
| </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. Leaves the sparse-checkout | |
| file intact so a later <em>git sparse-checkout init</em> command may | |
| return the working directory to the same state. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_sparse_checkout">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, then the file is ignored in the working | |
| directory. Git will not populate 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 class="paragraph"><p>To enable the sparse-checkout feature, run <code>git sparse-checkout init</code> to | |
| initialize a simple sparse-checkout file and enable the <code>core.sparseCheckout</code> | |
| config setting. Then, run <code>git sparse-checkout set</code> to modify the patterns in | |
| the sparse-checkout file.</p></div> | |
| <div class="paragraph"><p>To repopulate the working directory with all files, use the | |
| <code>git sparse-checkout disable</code> command.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_full_pattern_set">FULL PATTERN SET</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>By default, the sparse-checkout file uses the same syntax as <code>.gitignore</code> | |
| files.</p></div> | |
| <div class="paragraph"><p>While <code>$GIT_DIR/info/sparse-checkout</code> is usually used to specify what | |
| files are included, you can also specify what files are <em>not</em> included, | |
| using negative patterns. For example, to remove the file <code>unwanted</code>:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>/* | |
| !unwanted</code></pre> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_cone_pattern_set">CONE 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 accepted patterns in the cone pattern set are:</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>In addition to the above two patterns, we also expect that all files in the | |
| root directory are included. If a recursive pattern is added, then all | |
| leading directories are added as parent patterns.</p></div> | |
| <div class="paragraph"><p>By default, when running <code>git sparse-checkout init</code>, the root 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><code>/* | |
| !/*/</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>This says "include everything in root, but nothing two levels below root."</p></div> | |
| <div class="paragraph"><p>When in cone mode, the <code>git sparse-checkout set</code> subcommand takes a list of | |
| directories instead of a list of sparse-checkout patterns. In this mode, | |
| the command <code>git sparse-checkout set 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><code>/* | |
| !/*/ | |
| /A/ | |
| !/A/*/ | |
| /A/B/ | |
| !/A/B/*/ | |
| /A/B/C/</code></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>If <code>core.sparseCheckoutCone=true</code>, then 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.</p></div> | |
| <div class="paragraph"><p>In the cone mode case, the <code>git sparse-checkout 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><code>$ git sparse-checkout list | |
| A/B/C</code></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="_submodules">SUBMODULES</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>If your repository contains one or more submodules, then those submodules will | |
| appear based on which you initialized with the <code>git submodule</code> command. If | |
| your sparse-checkout patterns exclude an initialized submodule, then that | |
| submodule will still appear in your working directory.</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="footnotes"><hr /></div> | |
| <div id="footer"> | |
| <div id="footer-text"> | |
| Last updated | |
| 2020-04-29 16:59:10 PDT | |
| </div> | |
| </div> | |
| </body> | |
| </html> |