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>
Elijah Newren committed
Apr 22, 2022 at 02:32 UTC
5d4b2933407286ac2b76a1a66a04967a35d973f0
2 files changed
+12
-9
Documentation/git-read-tree.txt
+7
-4
@@ -375,10 +375,13 @@ have finished your work-in-progress), attempt the merge again.
375
SPARSE CHECKOUT
376
---------------
377
378
-Note: The `update-index` and `read-tree` primitives for supporting the
379
-skip-worktree bit predated the introduction of
380
-linkgit:git-sparse-checkout[1]. Users are encouraged to use
381
-`sparse-checkout` in preference to these low-level primitives.
378
+Note: The skip-worktree capabilities in linkgit:git-update-index[1]
379
+and `read-tree` predated the introduction of
380
+linkgit:git-sparse-checkout[1]. Users are encouraged to use the
381
+`sparse-checkout` command in preference to these plumbing commands for
382
+sparse-checkout/skip-worktree related needs. However, the information
383
+below might be useful to users trying to understand the pattern style
384
+used in non-cone mode of the `sparse-checkout` command.
385
386
"Sparse checkout" allows populating the working directory sparsely.
387
It uses the skip-worktree bit (see linkgit:git-update-index[1]) to
Documentation/git-sparse-checkout.txt
+5
-5
@@ -15,11 +15,11 @@ SYNOPSIS
15
DESCRIPTION
16
-----------
17
18
-This command is used to create sparse checkouts, which means that it
19
-changes the working tree from having all tracked files present, to only
20
-have a subset of them. It can also switch which subset of files are
21
-present, or undo and go back to having all tracked files present in the
22
-working copy.
18
+This command is used to create sparse checkouts, which change the
19
+working tree from having all tracked files present to only having a
20
+subset of those files. It can also switch which subset of files are
21
+present, or undo and go back to having all tracked files present in
22
+the working copy.
23
24
The subset of files is chosen by providing a list of directories in
25
cone mode (the default), or by providing a list of patterns in