Skip to content

Commit

Permalink
sparse-checkout: reject arguments in cone-mode that look like patterns
Browse files Browse the repository at this point in the history
In sparse-checkout add/set, 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.

Signed-off-by: Elijah Newren <newren@gmail.com>
  • Loading branch information
newren committed Feb 12, 2022
1 parent f6a4f00 commit 1495fad
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
16 changes: 14 additions & 2 deletions builtin/sparse-checkout.c
Original file line number Diff line number Diff line change
Expand Up @@ -704,10 +704,22 @@ static void sanitize_paths(int argc, const char **argv,
if (skip_checks)
return;

if (!core_sparse_checkout_cone)
for (i = 0; i < argc; i++)
for (i = 0; i < argc; i++) {
if (core_sparse_checkout_cone) {
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 (strchr(argv[i], '*') ||
strchr(argv[i], '?') ||
strchr(argv[i], '[') ||
strchr(argv[i], ']'))
die(_("specify directories rather than patterns. If your directory really has any of '*?[]' in it, pass --skip-checks"));
} else {
if (argv[i][0] == '#')
die(_("paths beginning with a '#' must be preceeded by a backslash"));
}
}

for (i = 0; i < argc; i++) {
struct cache_entry *ce;
Expand Down
2 changes: 1 addition & 1 deletion t/t1091-sparse-checkout-builtin.sh
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,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 &&
/*
!/*/
Expand Down

0 comments on commit 1495fad

Please sign in to comment.