summaryrefslogtreecommitdiffstats
path: root/Documentation/git-sparse-checkout.txt
diff options
context:
space:
mode:
authorDerrick Stolee <dstolee@microsoft.com>2019-11-21 23:04:47 +0100
committerJunio C Hamano <gitster@pobox.com>2019-11-22 08:11:45 +0100
commit99dfa6f9702ee81c44ef9382933e4e391ec5d6ee (patch)
treeebd9b7b6ab450e71366c5415b9b10ad3aea906aa /Documentation/git-sparse-checkout.txt
parentsparse-checkout: update working directory in-process (diff)
downloadgit-99dfa6f9702ee81c44ef9382933e4e391ec5d6ee.tar.xz
git-99dfa6f9702ee81c44ef9382933e4e391ec5d6ee.zip
sparse-checkout: use in-process update for disable subcommand
The 'git sparse-checkout disable' subcommand returns a user to a full working directory. The old process for doing this required updating the sparse-checkout file with the "/*" pattern and then updating the working directory with core.sparseCheckout enabled. Finally, the sparse-checkout file could be removed and the config setting disabled. However, it is valuable to keep a user's sparse-checkout file intact so they can re-enable the sparse-checkout they previously used with 'git sparse-checkout init'. This is now possible with the in-process mechanism for updating the working directory. Reported-by: Szeder Gábor <szeder.dev@gmail.com> Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-sparse-checkout.txt')
-rw-r--r--Documentation/git-sparse-checkout.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index 8535f0cf40..b975285673 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -52,8 +52,10 @@ When the `--stdin` option is provided, the patterns are read from
standard in as a newline-delimited list instead of from the arguments.
'disable'::
- Remove the sparse-checkout file, set `core.sparseCheckout` to
- `false`, and restore the working directory to include all files.
+ Disable the `core.sparseCheckout` config setting, and restore the
+ working directory to include all files. Leaves the sparse-checkout
+ file intact so a later 'git sparse-checkout init' command may
+ return the working directory to the same state.
SPARSE CHECKOUT
---------------