sparse-checkout: reject arguments in cone-mode that look like patterns

In sparse-checkout add/set under cone mode, the arguments passed are
supposed to be directories rather than gitignore-style patterns.
However, given the amount of effort spent in the manual discussing
patterns, it is easy for users to assume they need to pass patterns such
as
   /foo/*
or
   !/bar/*/
or perhaps they really do ignore the directory rule and specify a
random gitignore-style pattern like
   *.c

To help catch such mistakes, throw an error if any of the positional
arguments:
  * starts with any of '/!'
  * contains any of '*?[]'

Inform users they can pass --skip-checks if they have a directory that
really does have such special characters in its name.  (We exclude '\'
because of sparse-checkout's special handling of backslashes; see
the MINGW test in t1091.46.)

Reviewed-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
index 38ac37d9c61dfafb8eec60afd1aa49f3b385bb6f..a0c8a1499afae1d46d79f517663864bee8e962d1 100644 (file)
--- a/builtin/sparse-checkout.c
+++ b/builtin/sparse-checkout.c
@@ -710,6 +710,17 @@ static void sanitize_paths(int argc, const char **argv,
        if (prefix && *prefix && !core_sparse_checkout_cone)
                die(_("please run from the toplevel directory in non-cone mode"));
 
+       if (core_sparse_checkout_cone) {
+               for (i = 0; i < argc; i++) {
+                       if (argv[i][0] == '/')
+                               die(_("specify directories rather than patterns (no leading slash)"));
+                       if (argv[i][0] == '!')
+                               die(_("specify directories rather than patterns.  If your directory starts with a '!', pass --skip-checks"));
+                       if (strpbrk(argv[i], "*?[]"))
+                               die(_("specify directories rather than patterns.  If your directory really has any of '*?[]\\' in it, pass --skip-checks"));
+               }
+       }
+
        for (i = 0; i < argc; i++) {
                struct cache_entry *ce;
                struct index_state *index = the_repository->index;

diff --git a/t/t1091-sparse-checkout-builtin.sh b/t/t1091-sparse-checkout-builtin.sh
index 3b39329266b7fc67e678edb745ac8831df8259b7..421127d99c2c6c4e28043a92d0258eaff1a167fa 100755 (executable)
--- a/t/t1091-sparse-checkout-builtin.sh
+++ b/t/t1091-sparse-checkout-builtin.sh
@@ -673,7 +673,7 @@ test_expect_success BSLASHPSPEC 'pattern-checks: escaped characters' '
        git -C escaped reset --hard $COMMIT &&
        check_files escaped "a deep folder1 folder2 zbad\\dir zdoes*exist" zglob[!a]? &&
        git -C escaped sparse-checkout init --cone &&
-       git -C escaped sparse-checkout set zbad\\dir/bogus "zdoes*not*exist" "zdoes*exist" "zglob[!a]?" &&
+       git -C escaped sparse-checkout set --skip-checks zbad\\dir/bogus "zdoes*not*exist" "zdoes*exist" "zglob[!a]?" &&
        cat >expect <<-\EOF &&
        /*
        !/*/