summaryrefslogtreecommitdiff
path: root/Documentation/git-sparse-checkout.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-sparse-checkout.adoc')
-rw-r--r--Documentation/git-sparse-checkout.adoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/git-sparse-checkout.adoc b/Documentation/git-sparse-checkout.adoc
index baaebce746..42050ff5b5 100644
--- a/Documentation/git-sparse-checkout.adoc
+++ b/Documentation/git-sparse-checkout.adoc
@@ -127,6 +127,15 @@ clean` to resolve these cases.
This command can be used to be sure the sparse index works efficiently,
though it does not require enabling the sparse index feature via the
`index.sparse=true` configuration.
++
+To prevent accidental deletion of worktree files, the `clean` subcommand
+will not delete any files without the `-f` or `--force` option, unless
+the `clean.requireForce` config option is set to `false`.
++
+The `--dry-run` option will list the directories that would be removed
+without deleting them. Running in this mode can be helpful to predict the
+behavior of the clean comand or to determine which kinds of files are left
+in the sparse directories.
'disable'::
Disable the `core.sparseCheckout` config setting, and restore the