aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-read-tree.txt
diff options
context:
space:
mode:
authorElijah Newren <newren@gmail.com>2022-04-22 02:32:26 +0000
committerJunio C Hamano <gitster@pobox.com>2022-04-21 23:12:39 -0700
commit5d4b2933407286ac2b76a1a66a04967a35d973f0 (patch)
treef373169358b25c3e6716105032d18c7e4249c081 /Documentation/git-read-tree.txt
parenta8defed07cb4c287306d228b2e9f03d1195f5395 (diff)
downloadgit-5d4b2933407286ac2b76a1a66a04967a35d973f0.tar.gz
Documentation: some sparsity wording clarifications
Improve the wording for a couple paragraphs in two different manuals relating to sparse behavior. Reported-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-read-tree.txt')
-rw-r--r--Documentation/git-read-tree.txt11
1 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 99bb387134..d255807798 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -375,10 +375,13 @@ have finished your work-in-progress), attempt the merge again.
SPARSE CHECKOUT
---------------
-Note: The `update-index` and `read-tree` primitives for supporting the
-skip-worktree bit predated the introduction of
-linkgit:git-sparse-checkout[1]. Users are encouraged to use
-`sparse-checkout` in preference to these low-level primitives.
+Note: The skip-worktree capabilities in linkgit:git-update-index[1]
+and `read-tree` predated the introduction of
+linkgit:git-sparse-checkout[1]. Users are encouraged to use the
+`sparse-checkout` command in preference to these plumbing commands for
+sparse-checkout/skip-worktree related needs. However, the information
+below might be useful to users trying to understand the pattern style
+used in non-cone mode of the `sparse-checkout` command.
"Sparse checkout" allows populating the working directory sparsely.
It uses the skip-worktree bit (see linkgit:git-update-index[1]) to