From: Victoria Dye <vdye@github.com>
To: Derrick Stolee <derrickstolee@github.com>,
Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>,
git@vger.kernel.org
Cc: gitster@pobox.com, newren@gmail.com
Subject: Re: [WIP v2 2/5] mv: check if out-of-cone file exists in index with SKIP_WORKTREE bit
Date: Fri, 27 May 2022 15:38:45 -0700 [thread overview]
Message-ID: <b4c94cd9-4afe-cb0b-f60b-48a359f06ae8@github.com> (raw)
In-Reply-To: <0884b97b-0745-5cad-3034-a679be5d6c3a@github.com>
Derrick Stolee wrote:
>
>
> On 5/27/2022 6:08 AM, Shaoxuan Yuan wrote:
>> Originally, moving a <source> file which is not on-disk but exists in
>> index as a SKIP_WORKTREE enabled cache entry, "giv mv" command errors
>> out with "bad source".
>>
>> Change the checking logic, so that such <source>
>> file makes "giv mv" command warns with "advise_on_updating_sparse_paths()"
>> instead of "bad source"; also user now can supply a "--sparse" flag so
>> this operation can be carried out successfully.
>>
>> Signed-off-by: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com>
>> ---
>> builtin/mv.c | 26 +++++++++++++++++++++++++-
>> t/t7002-mv-sparse-checkout.sh | 4 ++--
>> 2 files changed, 27 insertions(+), 3 deletions(-)
>>
>> diff --git a/builtin/mv.c b/builtin/mv.c
>> index 83a465ba83..32ad4d5682 100644
>> --- a/builtin/mv.c
>> +++ b/builtin/mv.c
>> @@ -185,8 +185,32 @@ int cmd_mv(int argc, const char **argv, const char *prefix)
>>
>> length = strlen(src);
>> if (lstat(src, &st) < 0) {
>> + /*
>> + * TODO: for now, when you try to overwrite a <destination>
>> + * with your <source> as a sparse file, if you supply a "--sparse"
>> + * flag, then the action will be done without providing "--force"
>> + * and no warning.
>> + *
>> + * This is mainly because the sparse <source>
>> + * is not on-disk, and this if-else chain will be cut off early in
>> + * this check, thus the "--force" check is ignored. Need fix.
>> + */
>
> I wonder if this is worth the comment here, or if we'd rather see
> the mention in the commit message. You have documented tests that
> fail in this case, so we already have something that marks this
> as "TODO" in a more discoverable place.
>
>> + int pos = cache_name_pos(src, length);
>> + if (pos >= 0) {
>> + const struct cache_entry *ce = active_cache[pos];
>> +
>> + if (ce_skip_worktree(ce)) {
>> + if (!ignore_sparse)
>> + string_list_append(&only_match_skip_worktree, src);
>> + else
>> + modes[i] = SPARSE;
>
>
>> + }
>> + else
>> + bad = _("bad source");
>
> style nit:
>
> } else {
> bad = _("bad source");
> }
>
In case this advice seems contradictory with past style suggestions, from 'Documentation/CodingGuidelines':
- When there are multiple arms to a conditional and some of them
require braces, enclose even a single line block in braces for
consistency. E.g.:
if (foo) {
doit();
} else {
one();
two();
three();
}
>> + }
>> /* only error if existence is expected. */
>> - if (modes[i] != SPARSE)
>> + else if (modes[i] != SPARSE)
>> bad = _("bad source");
>
> For this one, the comment makes it difficult to connect the 'else
> if' to its corresponding 'if'. Perhaps:
>
> } else if (modes[i] != SPARSE) {
> /* only error if existence is expected. */
> bad = _("bad source");
> }
>
>> } else if (!strncmp(src, dst, length) &&
>> (dst[length] == 0 || dst[length] == '/')) {
>
> In general, I found this if/else-if chain hard to grok, and
> a lot of it is because we have "simple" cases at the end
> and the complicated parts have ever-increasing nesting. This
> is mostly due to the existing if/else-if chain in this method.
>
Agreed that the if/else-if chains make 'cmd_mv' complicated. The most
frustrating thing about its current state (unrelated to this patch) is how
unclear it is whether any given conditions are mutually-exclusive vs.
dependent vs. one taking precedence over another. On that note...
> Here is a diff that replaces that if/else-if chain with a
> 'goto' trick to jump ahead, allowing some code to decrease in
> tabbing:
>
...while I'm usually hesitant to add more 'goto' labels to the code if it
can be avoided, I think that model fits this use case well.
> ---- >8 ----
[cutting the proposed refactor for space]
> ---- >8 ---
>
> To me, this is a bit easier to parse, since we find the error
> cases and jump to the action before continuing on the "happy
> path". It does involve that first big refactor first, so I'd
> like to hear opinions of other contributors before you jump to
> taking this suggestion.
>
I like how the refactored version simplifies 'cmd_mv', and how it
correspondingly simplifies the new checks in this (Shaoxuan's) patch. It
does still leave us with one big, monolithic 'cmd_mv', so in an ideal world
I'd probably lean towards pulling the innards of the main for-loop(s) into a
few dedicated functions (like 'validate_move_candidate', 'move_entry').
However, I'm happy with any improvement, and this refactor would certainly
give us that!
> Thanks,
> -Stolee
next prev parent reply other threads:[~2022-05-27 22:42 UTC|newest]
Thread overview: 95+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-31 9:17 [WIP v1 0/4] mv: fix out-of-cone file/directory move logic Shaoxuan Yuan
2022-03-31 9:17 ` [WIP v1 1/4] mv: check if out-of-cone file exists in index with SKIP_WORKTREE bit Shaoxuan Yuan
2022-03-31 16:39 ` Victoria Dye
2022-04-01 14:30 ` Derrick Stolee
2022-03-31 9:17 ` [WIP v1 2/4] mv: add check_dir_in_index() and solve general dir check issue Shaoxuan Yuan
2022-03-31 10:25 ` Ævar Arnfjörð Bjarmason
2022-04-01 3:51 ` Shaoxuan Yuan
2022-03-31 21:28 ` Victoria Dye
2022-04-01 12:49 ` Shaoxuan Yuan
2022-04-01 14:49 ` Derrick Stolee
2022-04-04 7:25 ` Shaoxuan Yuan
2022-04-04 7:49 ` Shaoxuan Yuan
2022-04-04 12:43 ` Derrick Stolee
2022-03-31 9:17 ` [WIP v1 3/4] mv: add advise_to_reapply hint for moving file into cone Shaoxuan Yuan
2022-03-31 10:30 ` Ævar Arnfjörð Bjarmason
2022-04-01 4:00 ` Shaoxuan Yuan
2022-04-01 8:02 ` Ævar Arnfjörð Bjarmason
2022-04-03 2:01 ` Eric Sunshine
2022-03-31 21:56 ` Victoria Dye
2022-04-01 14:55 ` Derrick Stolee
2022-03-31 9:17 ` [WIP v1 4/4] t7002: add tests for moving out-of-cone file/directory Shaoxuan Yuan
2022-03-31 10:33 ` Ævar Arnfjörð Bjarmason
2022-03-31 22:11 ` Victoria Dye
2022-03-31 9:28 ` [WIP v1 0/4] mv: fix out-of-cone file/directory move logic Shaoxuan Yuan
2022-03-31 22:21 ` Victoria Dye
2022-04-01 12:18 ` Shaoxuan Yuan
2022-04-08 12:22 ` Shaoxuan Yuan
2022-05-27 10:07 ` [WIP v2 0/5] " Shaoxuan Yuan
2022-05-27 10:08 ` [WIP v2 1/5] t7002: add tests for moving out-of-cone file/directory Shaoxuan Yuan
2022-05-27 12:07 ` Ævar Arnfjörð Bjarmason
2022-05-27 14:48 ` Derrick Stolee
2022-05-27 15:51 ` Victoria Dye
2022-05-27 10:08 ` [WIP v2 2/5] mv: check if out-of-cone file exists in index with SKIP_WORKTREE bit Shaoxuan Yuan
2022-05-27 15:13 ` Derrick Stolee
2022-05-27 22:38 ` Victoria Dye [this message]
2022-05-31 8:06 ` Shaoxuan Yuan
2022-05-27 10:08 ` [WIP v2 3/5] mv: check if <destination> exists in index to handle overwriting Shaoxuan Yuan
2022-05-27 22:04 ` Victoria Dye
2022-05-27 10:08 ` [WIP v2 4/5] mv: add check_dir_in_index() and solve general dir check issue Shaoxuan Yuan
2022-05-27 15:27 ` Derrick Stolee
2022-05-31 9:56 ` Shaoxuan Yuan
2022-05-31 15:49 ` Derrick Stolee
2022-05-27 10:08 ` [WIP v2 5/5] mv: use update_sparsity() after touching sparse contents Shaoxuan Yuan
2022-05-27 12:10 ` Ævar Arnfjörð Bjarmason
2022-05-27 19:36 ` Victoria Dye
2022-05-27 19:59 ` Junio C Hamano
2022-05-27 21:24 ` Victoria Dye
2022-06-16 13:51 ` Shaoxuan Yuan
2022-06-16 16:42 ` Victoria Dye
2022-06-17 2:15 ` Shaoxuan Yuan
2022-06-19 3:25 ` [WIP v3 0/7] mv: fix out-of-cone file/directory move logic Shaoxuan Yuan
2022-06-19 3:25 ` [WIP v3 1/7] t7002: add tests for moving out-of-cone file/directory Shaoxuan Yuan
2022-06-21 21:23 ` Victoria Dye
2022-06-19 3:25 ` [WIP v3 2/7] mv: decouple if/else-if checks using goto Shaoxuan Yuan
2022-06-19 3:25 ` [WIP v3 3/7] mv: check if out-of-cone file exists in index with SKIP_WORKTREE bit Shaoxuan Yuan
2022-06-19 3:25 ` [WIP v3 4/7] mv: check if <destination> exists in index to handle overwriting Shaoxuan Yuan
2022-06-19 3:25 ` [WIP v3 5/7] mv: use flags mode for update_mode Shaoxuan Yuan
2022-06-21 22:32 ` Victoria Dye
2022-06-22 9:37 ` Shaoxuan Yuan
2022-06-19 3:25 ` [WIP v3 6/7] mv: add check_dir_in_index() and solve general dir check issue Shaoxuan Yuan
2022-06-21 22:55 ` Victoria Dye
2022-06-19 3:25 ` [WIP v3 7/7] mv: update sparsity after moving from out-of-cone to in-cone Shaoxuan Yuan
2022-06-21 23:11 ` Victoria Dye
2022-06-21 23:30 ` [WIP v3 0/7] mv: fix out-of-cone file/directory move logic Victoria Dye
2022-06-23 15:06 ` Derrick Stolee
2022-06-23 16:19 ` Junio C Hamano
2022-06-24 8:26 ` Shaoxuan Yuan
2022-06-23 11:41 ` [PATCH v4 " Shaoxuan Yuan
2022-06-23 11:41 ` [PATCH v4 1/7] t7002: add tests for moving out-of-cone file/directory Shaoxuan Yuan
2022-06-23 11:41 ` [PATCH v4 2/7] mv: update sparsity after moving from out-of-cone to in-cone Shaoxuan Yuan
2022-06-23 15:08 ` Derrick Stolee
2022-06-24 8:04 ` Shaoxuan Yuan
2022-06-27 13:55 ` Derrick Stolee
2022-06-23 11:41 ` [PATCH v4 3/7] mv: decouple if/else-if checks using goto Shaoxuan Yuan
2022-06-23 11:41 ` [PATCH v4 4/7] mv: check if out-of-cone file exists in index with SKIP_WORKTREE bit Shaoxuan Yuan
2022-06-23 11:41 ` [PATCH v4 5/7] mv: check if <destination> exists in index to handle overwriting Shaoxuan Yuan
2022-06-23 11:41 ` [PATCH v4 6/7] mv: use flags mode for update_mode Shaoxuan Yuan
2022-06-23 15:10 ` Derrick Stolee
2022-06-23 11:41 ` [PATCH v4 7/7] mv: add check_dir_in_index() and solve general dir check issue Shaoxuan Yuan
2022-06-23 15:14 ` Derrick Stolee
2022-06-24 7:57 ` Shaoxuan Yuan
2022-06-27 13:59 ` Derrick Stolee
2022-06-23 15:16 ` [PATCH v4 0/7] mv: fix out-of-cone file/directory move logic Derrick Stolee
2022-06-23 18:05 ` Junio C Hamano
2022-06-30 2:37 ` [PATCH v5 0/8] " Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 1/8] t7002: add tests for moving out-of-cone file/directory Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 2/8] t1092: mv directory from out-of-cone to in-cone Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 3/8] mv: update sparsity after moving " Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 4/8] mv: decouple if/else-if checks using goto Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 5/8] mv: check if out-of-cone file exists in index with SKIP_WORKTREE bit Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 6/8] mv: check if <destination> exists in index to handle overwriting Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 7/8] mv: use flags mode for update_mode Shaoxuan Yuan
2022-06-30 2:37 ` [PATCH v5 8/8] mv: add check_dir_in_index() and solve general dir check issue Shaoxuan Yuan
2022-07-01 19:43 ` [PATCH v5 0/8] mv: fix out-of-cone file/directory move logic Derrick Stolee
2022-07-01 21:50 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b4c94cd9-4afe-cb0b-f60b-48a359f06ae8@github.com \
--to=vdye@github.com \
--cc=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=newren@gmail.com \
--cc=shaoxuan.yuan02@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).