]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: sparse-checkout: mention --cone option
authorMatheus Tavares <matheus.bernardino@usp.br>
Thu, 23 Jan 2020 19:00:02 +0000 (16:00 -0300)
committerJunio C Hamano <gitster@pobox.com>
Thu, 23 Jan 2020 21:20:14 +0000 (13:20 -0800)
In af09ce2 ("sparse-checkout: init and set in cone mode", 2019-11-21),
the '--cone' option was added to 'git sparse-checkout init'.

Document it.

Signed-off-by: Matheus Tavares <matheus.bernardino@usp.br>
Acked-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-sparse-checkout.txt

index 974ade22387f23905938e2a898f730168f7dd76b..e6f235a0c485a550eb1232e302304efdb8de81ac 100644 (file)
@@ -41,6 +41,10 @@ COMMANDS
 To avoid interfering with other worktrees, it first enables the
 `extensions.worktreeConfig` setting and makes sure to set the
 `core.sparseCheckout` setting in the worktree-specific config file.
++
+When `--cone` is provided, the `core.sparseCheckoutCone` setting is
+also set, allowing for better performance with a limited set of
+patterns (see 'CONE PATTERN SET' below).
 
 'set'::
        Write a set of patterns to the sparse-checkout file, as given as