undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: some sparsity wording clarifications

Browse Source 
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>
This commit is contained in:
Elijah Newren 2022-04-22 02:32:26 +00:00 committed by Junio C Hamano
parent a8defed07c
commit 5d4b293340
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/git-read-tree.txt
View File

@ -375,10 +375,13 @@ have finished your work-in-progress), attempt the merge again.
SPARSE CHECKOUT SPARSE CHECKOUT
--------------- ---------------
Note: The `update-index` and `read-tree` primitives for supporting the Note: The skip-worktree capabilities in linkgit:git-update-index[1]
skip-worktree bit predated the introduction of and `read-tree` predated the introduction of
linkgit:git-sparse-checkout[1]. Users are encouraged to use linkgit:git-sparse-checkout[1]. Users are encouraged to use the
`sparse-checkout` in preference to these low-level primitives. `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. "Sparse checkout" allows populating the working directory sparsely.
It uses the skip-worktree bit (see linkgit:git-update-index[1]) to It uses the skip-worktree bit (see linkgit:git-update-index[1]) to

10
Documentation/git-sparse-checkout.txt
View File

@ -15,11 +15,11 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
This command is used to create sparse checkouts, which means that it This command is used to create sparse checkouts, which change the
changes the working tree from having all tracked files present, to only working tree from having all tracked files present to only having a
have a subset of them. It can also switch which subset of files are 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 present, or undo and go back to having all tracked files present in
working copy. the working copy.
The subset of files is chosen by providing a list of directories in 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 cone mode (the default), or by providing a list of patterns in