From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id DCC5FC433EF for ; Thu, 9 Dec 2021 05:09:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230037AbhLIFMs (ORCPT ); Thu, 9 Dec 2021 00:12:48 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45120 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230097AbhLIFMp (ORCPT ); Thu, 9 Dec 2021 00:12:45 -0500 Received: from mail-ed1-x534.google.com (mail-ed1-x534.google.com [IPv6:2a00:1450:4864:20::534]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 16F83C061746 for ; Wed, 8 Dec 2021 21:09:12 -0800 (PST) Received: by mail-ed1-x534.google.com with SMTP id z5so15693594edd.3 for ; Wed, 08 Dec 2021 21:09:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=+4Gwe9jVL2TmT4giulEHz7bQu3tEDWmkDY3/+vifST4=; b=ABr0aRLuiof069EyjVn4ZyWaewg7qBOOMBo4natsucbKQk29S4M2k+DMhGcWRSGGfR NKgtPpYlDLyX5jbd1B6wsz0hQCabIBXvfykKXaVJgm4ANfrJJe+nmpLmsHXF6wksZc4P Tbya4A6oQs1qmiS7YA94Is0h8wV9FHg5iAnMoSFB1zlwG8STii543f79p0S/SuqusIT3 WylcAVlNPiCcKTKv+qF6GywOrvKUUPUJ9witaFgm7A6tICWnykbwIH+yzABezP4F89fQ xjGEM+mW9E7UYUiXX1TSDAcDCHk+svO2/X2dLdTgkghRUKVEvA+7lVOgzplDGiesEMVw 4a1w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=+4Gwe9jVL2TmT4giulEHz7bQu3tEDWmkDY3/+vifST4=; b=1MalZqUbBkbC3OaN4jxprq6vlpdirseA6zX3UnjKBm643uqer/LGqt2Tqb/ZFpe1SC 2GI9u9sben4j5WuB0RIe0w78+7J3VpPIPx561zWXuhCNrYy2aPmDiGVUdTiAGuW9rrYa jEl1bHYxl8xUulM7zhK+AveZYStOjDEfCOsah+arWrDPXu7DlClfmjzS4Er+a36jt9by GvXCSpi9+24wNhk6HMjIM3oOTh0WVnQfa33NqDjpjGKoYcYh10+Hku9/NDHdCFsHvwK9 4usV7KasQ5HyqPP5cHZ340qc+yOGGzwKsBnGLavszN+YjXeEpasBTaBa74MxJEUeHE4N N4Ag== X-Gm-Message-State: AOAM530nRhUmzJT8Xsdw/q6pd/0mw9jItWaeFBLgDY85nvK5sP0Cg0Vj XV6VDnMpxFZD1E6b/zJ9piAXsnCT1TXnMb9Yf9zyYA1W X-Google-Smtp-Source: ABdhPJzcsmDji218iGcxtA8n/ZYQNWb+8sd1JXyJozvsaCNUh60w2xp73H5EvdCk60XrBPPySfBDVi2p8NgL5D34GTs= X-Received: by 2002:a05:6402:491:: with SMTP id k17mr25863390edv.333.1639026550563; Wed, 08 Dec 2021 21:09:10 -0800 (PST) MIME-Version: 1.0 References: <58b5eca483502b0d45601490f6b4255f6419e6bd.1638992396.git.gitgitgadget@gmail.com> In-Reply-To: <58b5eca483502b0d45601490f6b4255f6419e6bd.1638992396.git.gitgitgadget@gmail.com> From: Elijah Newren Date: Wed, 8 Dec 2021 21:08:59 -0800 Message-ID: Subject: Re: [PATCH v2 2/5] ls-files: add --sparse option To: Derrick Stolee via GitGitGadget Cc: Git Mailing List , Junio C Hamano , Victoria Dye , Derrick Stolee , =?UTF-8?B?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= , Derrick Stolee , Derrick Stolee Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org On Wed, Dec 8, 2021 at 11:39 AM Derrick Stolee via GitGitGadget wrote: > > From: Derrick Stolee > > Existing callers to 'git ls-files' are expecting file names, not > directories. It is best to expand a sparse index to show all of the > contained files in this case. > > However, expert users may want to inspect the contents of the index > itself including which directories are sparse. Add a --sparse option to > allow users to request this information. > > During testing, I noticed that options such as --modified did not affect > the output when the files in question were outside the sparse-checkout > definition. Tests are added to document this preexisting behavior and > how it remains unchanged with the sparse index and the --sparse option. > > Signed-off-by: Derrick Stolee > --- > Documentation/git-ls-files.txt | 4 ++ > builtin/ls-files.c | 12 +++- > t/t1092-sparse-checkout-compatibility.sh | 90 ++++++++++++++++++++++++ > 3 files changed, 104 insertions(+), 2 deletions(-) > > diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt > index 6d11ab506b7..1c5d5f85ec5 100644 > --- a/Documentation/git-ls-files.txt > +++ b/Documentation/git-ls-files.txt > @@ -187,6 +187,10 @@ Both the in the index ("i/") > and in the working tree ("w/") are shown for regular files, > followed by the ("attr/"). > > +--sparse:: > + If the index is sparse, show the sparse directories without expanding > + to the contained files. > + > \--:: > Do not interpret any more arguments as options. > > diff --git a/builtin/ls-files.c b/builtin/ls-files.c > index 031fef1bcaa..c151eb1fb77 100644 > --- a/builtin/ls-files.c > +++ b/builtin/ls-files.c > @@ -37,6 +37,7 @@ static int debug_mode; > static int show_eol; > static int recurse_submodules; > static int skipping_duplicates; > +static int show_sparse_dirs; > > static const char *prefix; > static int max_prefix_len; > @@ -315,8 +316,10 @@ static void show_files(struct repository *repo, struct dir_struct *dir) > > if (!(show_cached || show_stage || show_deleted || show_modified)) > return; > - /* TODO: audit for interaction with sparse-index. */ > - ensure_full_index(repo->index); > + > + if (!show_sparse_dirs) > + ensure_full_index(repo->index); > + > for (i = 0; i < repo->index->cache_nr; i++) { > const struct cache_entry *ce = repo->index->cache[i]; > struct stat st; > @@ -670,6 +673,8 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix) > OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")), > OPT_BOOL(0, "deduplicate", &skipping_duplicates, > N_("suppress duplicate entries")), > + OPT_BOOL(0, "sparse", &show_sparse_dirs, > + N_("show sparse directories in the presence of a sparse index")), > OPT_END() > }; > int ret = 0; > @@ -677,6 +682,9 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix) > if (argc == 2 && !strcmp(argv[1], "-h")) > usage_with_options(ls_files_usage, builtin_ls_files_options); > > + prepare_repo_settings(the_repository); > + the_repository->settings.command_requires_full_index = 0; > + > prefix = cmd_prefix; > if (prefix) > prefix_len = strlen(prefix); > diff --git a/t/t1092-sparse-checkout-compatibility.sh b/t/t1092-sparse-checkout-compatibility.sh > index 3ba19ba1c14..bf2c6b169b9 100755 > --- a/t/t1092-sparse-checkout-compatibility.sh > +++ b/t/t1092-sparse-checkout-compatibility.sh > @@ -802,6 +802,12 @@ test_expect_success 'sparse-index is expanded and converted back' ' > GIT_TRACE2_EVENT="$(pwd)/trace2.txt" GIT_TRACE2_EVENT_NESTING=10 \ > git -C sparse-index reset -- folder1/a && > test_region index convert_to_sparse trace2.txt && > + test_region index ensure_full_index trace2.txt && > + > + # ls-files expands on read, but does not write. > + rm trace2.txt && > + GIT_TRACE2_EVENT="$(pwd)/trace2.txt" GIT_TRACE2_EVENT_NESTING=10 \ > + git -C sparse-index ls-files && > test_region index ensure_full_index trace2.txt > ' > > @@ -826,6 +832,7 @@ test_expect_success 'sparse-index is not expanded' ' > init_repos && > > ensure_not_expanded status && > + ensure_not_expanded ls-files --sparse && > ensure_not_expanded commit --allow-empty -m empty && > echo >>sparse-index/a && > ensure_not_expanded commit -a -m a && > @@ -974,6 +981,89 @@ test_expect_success 'sparse index is not expanded: fetch/pull' ' > ensure_not_expanded pull full base > ' > > +test_expect_success 'ls-files' ' > + init_repos && > + > + # Behavior agrees by default. Sparse index is expanded. > + test_all_match git ls-files && > + > + # With --sparse, the sparse index data changes behavior. > + git -C sparse-index ls-files >dense && > + git -C sparse-index ls-files --sparse >sparse && > + > + cat >expect <<-\EOF && > + @@ -13,13 +13,9 @@ > + e > + folder1- > + folder1.x > + -folder1/0/0/0 > + -folder1/0/1 > + -folder1/a > + +folder1/ > + folder10 > + -folder2/0/0/0 > + -folder2/0/1 > + -folder2/a > + +folder2/ > + g > + -x/a > + +x/ > + z > + EOF > + > + diff -u dense sparse | tail -n +3 >actual && > + test_cmp expect actual && > + > + # With --sparse and no sparse index, nothing changes. > + git -C sparse-checkout ls-files >dense && > + git -C sparse-checkout ls-files --sparse >sparse && > + test_cmp dense sparse && > + I still believe this next section deserves a comment; something like # Set up an erroneous condition: folder1/a present despite SKIP_WORKTREE. # We do this just to verify consistency between sparse-index and non-sparse-index # with such files. > + write_script edit-content <<-\EOF && > + mkdir folder1 && > + echo content >>folder1/a > + EOF > + run_on_sparse ../edit-content && > + > + # ls-files does not notice modified files whose > + # cache entries are marked SKIP_WORKTREE. I also believe this still deserves a slight change, e.g. # ls-files does not currently notice modified files whose # cache entries are marked SKIP_WORKTREE; this # may change in the future, but we test here that # sparse-index and non-sparse-index at least match. > + test_sparse_match git ls-files --modified && > + test_must_be_empty sparse-checkout-out && > + test_must_be_empty sparse-index-out && > + > + git -C sparse-index ls-files --sparse --modified >sparse-index-out && > + test_must_be_empty sparse-index-out && > + > + # Add folder1 to the sparse-checkout cone and > + # check that ls-files shows the expanded files. > + test_sparse_match git sparse-checkout add folder1 && > + test_sparse_match git ls-files --modified && > + > + git -C sparse-index ls-files >dense && > + git -C sparse-index ls-files --sparse >sparse && > + > + cat >expect <<-\EOF && > + @@ -17,9 +17,7 @@ > + folder1/0/1 > + folder1/a > + folder10 > + -folder2/0/0/0 > + -folder2/0/1 > + -folder2/a > + +folder2/ > + g > + -x/a > + +x/ > + z > + EOF > + > + diff -u dense sparse | tail -n +3 >actual && > + test_cmp expect actual && > + > + # Double-check index expansion is avoided > + ensure_not_expanded ls-files --sparse > +' > + > # NEEDSWORK: a sparse-checkout behaves differently from a full checkout > # in this scenario, but it shouldn't. > test_expect_success 'reset mixed and checkout orphan' ' > -- > gitgitgadget