summaryrefslogtreecommitdiffstats
path: root/git-sparse-checkout.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-04-30 15:08:10 +0900
committerJunio C Hamano <gitster@pobox.com>2021-04-30 15:08:10 +0900
commit4078a55a6fb467915a2f03f271d1390b97eabc13 (patch)
tree94f9713738bf23d7a7bce9c87937558570412c71 /git-sparse-checkout.html
parent9877648272f630de87aeee2e3a8b7f4ac1ad9c70 (diff)
downloadgit-htmldocs-4078a55a6fb467915a2f03f271d1390b97eabc13.tar.gz
Autogenerated HTML docs for v2.31.1-442-g7e391
Diffstat (limited to 'git-sparse-checkout.html')
-rw-r--r--git-sparse-checkout.html14
1 files changed, 13 insertions, 1 deletions
diff --git a/git-sparse-checkout.html b/git-sparse-checkout.html
index 893530ec2..3181cc4f2 100644
--- a/git-sparse-checkout.html
+++ b/git-sparse-checkout.html
@@ -794,6 +794,18 @@ THE FUTURE.</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>
+<div class="paragraph"><p>Use the <code>--[no-]sparse-index</code> option to toggle the use of the sparse
+index format. This 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 status</code> or <code>git 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 sparse-checkout init --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>set</em>
@@ -1009,7 +1021,7 @@ of these restrictions.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2020-06-22 16:55:13 PDT
+ 2021-04-30 15:03:30 JST
</div>
</div>
</body>