== Maintainer notes == Note: There is a small textual and small semantic conflict with ds/sparse-checkout-requires-per-worktree-config in seen. I included the diff with the correct resolution near the end of this cover letter. If you'd prefer I rebased on top of ds/sparse-chckout-requires-per-worktree-config, let me know. == Overview == This series continues attempts to make sparse-checkouts more user friendly. A quick overview: * Patches 1-2 fix existing bugs from en/sparse-checkout-set (i.e. in v2.35.0) * Patch 3 fixes sparse-checkout-from-subdirectories-ignores-"prefix" (see https://lore.kernel.org/git/29f0410e-6dfa-2e86-394d-b1fb735e7608@xxxxxxxxx/), in cone mode. Since we'll get nasty surprises whether we use or don't use "prefix" for non-cone mode, simply throw an error if set/add subcommands of sparse-checkout are run from a subdirectory. * Patches 4-5 check positional arguments to set/add and provide errors/warnings for very likely mistakes. It also adds a --skip-checks flag for overridding in case you have a very unusual situation. == Update history == Changes since v3: * Use strpbrk() instead of multiple strchr(), fix commit message relative to backslashes. Changes since v2: * Dropped patch 5 * Added Stolee's Reviewed-by Changes since v1: * Dropped the commit changing cone-mode to default (patch 7, which will be split into multiple patches and submitted as a separate series) * Removed the RFC label * Decided to error out when running set/add with paths from a subdirectory in non-cone mode, and added tests * Changed the warning for non-cone mode with individual files to point out that the user is likely trying to select an individual file, but should likely add a leading slash to ensure that is what happens * Fixed typos, removed unnecessary condition checks == Conflict resolution == Patch to resolve textual and semantic conflict with ds/sparse-checkout-requires-per-worktree-config: diff --git a/t/t1091-sparse-checkout-builtin.sh b/t/t1091-sparse-checkout-builtin.sh remerge CONFLICT (content): Merge conflict in t/t1091-sparse-checkout-builtin.sh index 3c6adeb885..3a95d2996d 100755 --- a/t/t1091-sparse-checkout-builtin.sh +++ b/t/t1091-sparse-checkout-builtin.sh @@ -275,24 +275,8 @@ test_expect_success 'sparse-index enabled and disabled' ' diff -u sparse full | tail -n +3 >actual && test_cmp expect actual && -<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 286c22e5ec (sparse-checkout: reject arguments in cone-mode that look like patterns) git -C repo config --list >config && - ! grep index.sparse config -|||||||||||||||||||||||||||||||| 89bece5c8c - diff -u sparse full | tail -n +3 >actual && - test_cmp expect actual && - - git -C repo config --list >config && - ! grep index.sparse config - ) -================================ - diff -u sparse full | tail -n +3 >actual && - test_cmp expect actual && - - git -C repo config --list >config && - test_cmp_config -C repo false index.sparse - ) ->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 3ce1138272 (config: make git_configset_get_string_tmp() private) + test_cmp_config -C repo false index.sparse ' test_expect_success 'cone mode: init and set' ' @@ -532,6 +516,7 @@ test_expect_success 'reapply can handle config options' ' cat >expect <<-\EOF && core.sparsecheckout=true core.sparsecheckoutcone=true + index.sparse=false EOF test_cmp expect actual && @@ -539,6 +524,8 @@ test_expect_success 'reapply can handle config options' ' git -C repo config --worktree --list >actual && cat >expect <<-\EOF && core.sparsecheckout=true + core.sparsecheckoutcone=false + index.sparse=false EOF test_cmp expect actual && == CCs == Elijah Newren (5): sparse-checkout: correct reapply's handling of options sparse-checkout: correctly set non-cone mode when expected sparse-checkout: pay attention to prefix for {set, add} sparse-checkout: error or warn when given individual files sparse-checkout: reject arguments in cone-mode that look like patterns builtin/sparse-checkout.c | 78 +++++++++++++++++++++++++-- t/t1091-sparse-checkout-builtin.sh | 87 +++++++++++++++++++++++++++++- 2 files changed, 158 insertions(+), 7 deletions(-) base-commit: b80121027d1247a0754b3cc46897fee75c050b44 Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1118%2Fnewren%2Fsparse-checkout-default-and-arg-validity-v4 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1118/newren/sparse-checkout-default-and-arg-validity-v4 Pull-Request: https://github.com/gitgitgadget/git/pull/1118 Range-diff vs v3: 1: 5215b7f7179 = 1: 5215b7f7179 sparse-checkout: correct reapply's handling of options 2: 0c2ab523e74 = 2: 0c2ab523e74 sparse-checkout: correctly set non-cone mode when expected 3: e68b0a37ff3 = 3: e68b0a37ff3 sparse-checkout: pay attention to prefix for {set, add} 4: 1fdebc1953f = 4: 1fdebc1953f sparse-checkout: error or warn when given individual files 5: 2008542d0c7 ! 5: d68682c25c4 sparse-checkout: reject arguments in cone-mode that look like patterns @@ Commit message To help catch such mistakes, throw an error if any of the positional arguments: * starts with any of '/!' - * contains 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. + 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@xxxxxxxxxx> Signed-off-by: Elijah Newren <newren@xxxxxxxxx> @@ builtin/sparse-checkout.c: static void sanitize_paths(int argc, const char **arg + 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")); ++ if (strpbrk(argv[i], "*?[]")) ++ die(_("specify directories rather than patterns. If your directory really has any of '*?[]\\' in it, pass --skip-checks")); + } + } + -- gitgitgadget
