summaryrefslogtreecommitdiffstats
path: root/git-sparse-checkout.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-02-25 16:21:27 -0800
committerJunio C Hamano <gitster@pobox.com>2022-02-25 16:21:27 -0800
commit5f907e9e08462d0b15c8983fc31451755eb9cebe (patch)
tree47c3163dd546269ddc4740cb8e6ed0e5a89e0195 /git-sparse-checkout.txt
parentc44a3c5407578ca733b6e1aa66cf8a94e5b4d2e3 (diff)
downloadgit-htmldocs-5f907e9e08462d0b15c8983fc31451755eb9cebe.tar.gz
Autogenerated HTML docs for v2.35.1-354-g715d08
Diffstat (limited to 'git-sparse-checkout.txt')
-rw-r--r--git-sparse-checkout.txt16
1 files changed, 12 insertions, 4 deletions
diff --git a/git-sparse-checkout.txt b/git-sparse-checkout.txt
index b81dbe065..94dad137b 100644
--- a/git-sparse-checkout.txt
+++ b/git-sparse-checkout.txt
@@ -31,13 +31,21 @@ COMMANDS
Describe the patterns in the sparse-checkout file.
'set'::
- Enable the necessary config settings
- (extensions.worktreeConfig, core.sparseCheckout,
- core.sparseCheckoutCone) if they are not already enabled, and
- write a set of patterns to the sparse-checkout file from the
+ Enable the necessary sparse-checkout config settings
+ (`core.sparseCheckout`, `core.sparseCheckoutCone`, and
+ `index.sparse`) if they are not already set to the desired values,
+ and write a set of patterns to the sparse-checkout file from the
list of arguments following the 'set' subcommand. Update the
working directory to match the new patterns.
+
+To ensure that adjusting the sparse-checkout settings within a worktree
+does not alter the sparse-checkout settings in other worktrees, the 'set'
+subcommand will upgrade your repository config to use worktree-specific
+config if not already present. The sparsity defined by the arguments to
+the 'set' subcommand are stored in the worktree-specific sparse-checkout
+file. See linkgit:git-worktree[1] and the documentation of
+`extensions.worktreeConfig` in linkgit:git-config[1] for more details.
++
When the `--stdin` option is provided, the patterns are read from
standard in as a newline-delimited list instead of from the arguments.
+