Skip to content

Commit 5d4b293

Browse files
newrengitster
authored andcommitted
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 <[email protected]> Signed-off-by: Elijah Newren <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a8defed commit 5d4b293

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

Documentation/git-read-tree.txt

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -375,10 +375,13 @@ have finished your work-in-progress), attempt the merge again.
375375
SPARSE CHECKOUT
376376
---------------
377377

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.
382385

383386
"Sparse checkout" allows populating the working directory sparsely.
384387
It uses the skip-worktree bit (see linkgit:git-update-index[1]) to

Documentation/git-sparse-checkout.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ SYNOPSIS
1515
DESCRIPTION
1616
-----------
1717

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.
2323

2424
The subset of files is chosen by providing a list of directories in
2525
cone mode (the default), or by providing a list of patterns in

0 commit comments

Comments
 (0)