Re: [PATCH v2] sparse-checkout: create leading directory

[Elijah Newren <newren@gmail.com>]

On Fri, Jan 21, 2022 at 6:05 PM Jonathan Tan <jonathantanmy@google.com> wrote:
>
> When creating the sparse-checkout file, Git does not create the leading
> directory, "$GIT_DIR/info", if it does not exist. This causes problems
> if the repository does not have that directory. Therefore, ensure that
> the leading directory is created.
>
> This is the only "open" in builtin/sparse-checkout.c that does not have
> a leading directory check. (The other one in write_patterns_and_update()
> does.)
>
> Note that the test needs to explicitly specify a template when running
> "git init" because the default template used in the tests has the
> "info/" directory included.

If wanted, you could avoid that by using `git worktree add ...`;
git-worktree will create a $GIT_DIR that does not contain an info
subdirectory.

(No need to resubmit or anything, mostly I'm just mentioning another
way folks might have triggered this issue.)

> Helped-by: Jose Lopes <jabolopes@google.com>
> Signed-off-by: Jonathan Tan <jonathantanmy@google.com>
> ---
> Changes from v1:
>  - made test simpler
>  - added attribution to Jose Lopes for finding and making the first
>    draft of this patch (after confirming with them)
>
> Ævar mentioned "git sparse-checkout add" but I think that that is a
> different problem - in the "git sparse-checkout init" case, we could get
> into this case with a template that does not have .git/info, but in the
> "git sparse-checkout add" case, the user would have had to explicitly
> remove the info directory. So I'll limit this patch to the "init" case,
> for now.
> ---
>  builtin/sparse-checkout.c          | 3 +++
>  t/t1091-sparse-checkout-builtin.sh | 6 ++++++
>  2 files changed, 9 insertions(+)
>
> diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
> index 679c107036..2b0e1db2d2 100644
> --- a/builtin/sparse-checkout.c
> +++ b/builtin/sparse-checkout.c
> @@ -471,6 +471,9 @@ static int sparse_checkout_init(int argc, const char **argv)
>                 FILE *fp;
>
>                 /* assume we are in a fresh repo, but update the sparse-checkout file */
> +               if (safe_create_leading_directories(sparse_filename))
> +                       die(_("unable to create leading directories of %s"),
> +                           sparse_filename);
>                 fp = xfopen(sparse_filename, "w");
>                 if (!fp)
>                         die(_("failed to open '%s'"), sparse_filename);
> diff --git a/t/t1091-sparse-checkout-builtin.sh b/t/t1091-sparse-checkout-builtin.sh
> index 42776984fe..3189d3da96 100755
> --- a/t/t1091-sparse-checkout-builtin.sh
> +++ b/t/t1091-sparse-checkout-builtin.sh
> @@ -79,6 +79,12 @@ test_expect_success 'git sparse-checkout init' '
>         check_files repo a
>  '
>
> +test_expect_success 'git sparse-checkout init in empty repo' '
> +       test_when_finished rm -rf empty-repo blank-template &&
> +       git init --template= empty-repo &&
> +       git -C empty-repo sparse-checkout init
> +'
> +
>  test_expect_success 'git sparse-checkout list after init' '
>         git -C repo sparse-checkout list >actual &&
>         cat >expect <<-\EOF &&
> --
> 2.35.0.rc0.227.g00780c9af4-goog

Patch looks good to me:

Reviewed-by: Elijah Newren <newren@gmail.com>