aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-read-tree.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-06-03 14:30:33 -0700
committerJunio C Hamano <gitster@pobox.com>2022-06-03 14:30:33 -0700
commit377d347eb3b1a23ece080dc5e5b8df6958c56e96 (patch)
tree19c5bf822937e10acb22707870611846e53d03fd /Documentation/git-read-tree.txt
parent2668e3608e47494f2f10ef2b6e69f08a84816bcb (diff)
parent5d4b2933407286ac2b76a1a66a04967a35d973f0 (diff)
downloadgit-377d347eb3b1a23ece080dc5e5b8df6958c56e96.tar.gz
Merge branch 'en/sparse-cone-becomes-default'
Deprecate non-cone mode of the sparse-checkout feature. * en/sparse-cone-becomes-default: Documentation: some sparsity wording clarifications git-sparse-checkout.txt: mark non-cone mode as deprecated git-sparse-checkout.txt: flesh out pattern set sections a bit git-sparse-checkout.txt: add a new EXAMPLES section git-sparse-checkout.txt: shuffle some sections and mark as internal git-sparse-checkout.txt: update docs for deprecation of 'init' git-sparse-checkout.txt: wording updates for the cone mode default sparse-checkout: make --cone the default tests: stop assuming --no-cone is the default mode for sparse-checkout
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 a5356a230b..b9bfdc0a31 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