summaryrefslogtreecommitdiffstats
path: root/git-read-tree.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-03-09 14:19:31 -0800
committerJunio C Hamano <gitster@pobox.com>2022-03-09 14:19:31 -0800
commit7c37da749fa2c8d767b9ddfc2ed43986eb2f4d7c (patch)
tree217db038da87f53d7f6483aead1f09299d8a02e4 /git-read-tree.html
parentc7a8d87b7ec3976798edbadec4c209e77b38c7c6 (diff)
downloadgit-htmldocs-7c37da749fa2c8d767b9ddfc2ed43986eb2f4d7c.tar.gz
Autogenerated HTML docs for v2.35.1-455-g1a487
Diffstat (limited to 'git-read-tree.html')
-rw-r--r--git-read-tree.html13
1 files changed, 9 insertions, 4 deletions
diff --git a/git-read-tree.html b/git-read-tree.html
index bb177a7f0..0623a9d3a 100644
--- a/git-read-tree.html
+++ b/git-read-tree.html
@@ -1230,16 +1230,21 @@ have finished your work-in-progress), attempt the merge again.</p></div>
<div class="sect1">
<h2 id="_sparse_checkout">SPARSE CHECKOUT</h2>
<div class="sectionbody">
+<div class="paragraph"><p>Note: The <code>update-index</code> and <code>read-tree</code> primitives for supporting the
+skip-worktree bit predated the introduction of
+<a href="git-sparse-checkout.html">git-sparse-checkout(1)</a>. Users are encouraged to use
+<code>sparse-checkout</code> in preference to these low-level primitives.</p></div>
<div class="paragraph"><p>"Sparse checkout" allows populating the working directory sparsely.
-It uses the skip-worktree bit (see <a href="git-update-index.html">git-update-index(1)</a>) to tell
-Git whether a file in the working directory is worth looking at.</p></div>
+It uses the skip-worktree bit (see <a href="git-update-index.html">git-update-index(1)</a>) to
+tell Git whether a file in the working directory is worth looking at.</p></div>
<div class="paragraph"><p><em>git read-tree</em> and other merge-based commands (<em>git merge</em>, <em>git
checkout</em>&#8230;) can help maintaining the skip-worktree bitmap and working
directory update. <code>$GIT_DIR/info/sparse-checkout</code> is used to
define the skip-worktree reference bitmap. When <em>git read-tree</em> needs
to update the working directory, it resets the skip-worktree bit in the index
based on this file, which uses the same syntax as .gitignore files.
-If an entry matches a pattern in this file, skip-worktree will not be
+If an entry matches a pattern in this file, or the entry corresponds to
+a file present in the working tree, then skip-worktree will not be
set on that entry. Otherwise, skip-worktree will be set.</p></div>
<div class="paragraph"><p>Then it compares the new skip-worktree value with the previous one. If
skip-worktree turns from set to unset, it will add the corresponding
@@ -1286,7 +1291,7 @@ support.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2021-10-14 10:10:01 PDT
+ 2022-03-09 14:17:38 PST
</div>
</div>
</body>