Skip to content

Commit

Permalink
Documentation: some sparsity wording clarifications
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
newren committed Apr 21, 2022
1 parent a1b68fd commit 5f0e807
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
11 changes: 7 additions & 4 deletions Documentation/git-read-tree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions Documentation/git-sparse-checkout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ SYNOPSIS
DESCRIPTION
-----------

This command is used to create sparse checkouts, which means that it
changes the working tree from having all tracked files present, to only
have a subset of them. It can also switch which subset of files are
present, or undo and go back to having all tracked files present in the
working copy.
This command is used to create sparse checkouts, which change the
working tree from having all tracked files present to only having a
subset of those files. It can also switch which subset of files are
present, or undo and go back to having all tracked files present in
the working copy.

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

0 comments on commit 5f0e807

Please sign in to comment.