Re: [PATCH 3/3] fsck: mention file path for index errors
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- May 11, 2023, 16:28 UTC
- Message-ID
- <CAPig+cQP736+944k40wgE8Vybk=ajD-kLTDHM6Y92dKEeWMB8g@mail.gmail.com>
- In-Reply-To
- <20230511161757.GA1973344@coredump.intra.peff.net>
On Thu, May 11, 2023 at 12:17 PM Jeff King <peff@peff.net> wrote:
Show 21 quoted lines
> On Thu, May 11, 2023 at 02:39:59AM -0400, Eric Sunshine wrote:
> > > +static void fsck_index(struct index_state *istate, const char *index_path,
> > > + int is_main_index)
> >
> > This adds an `is_main_index` flag, but...
> >
> > > @@ -993,12 +998,19 @@ int cmd_fsck(int argc, const char **argv, const char *prefix)
> > > + fsck_index(&istate, path, wt->is_current);
> >
> > ...this accesses `is_current`, the value of which is "true" only for the
> > worktree in which the Git command was run, which is not necessarily the main
> > worktree. The main worktree, on the other hand, is guaranteed to be the
> > first entry returned by get_worktrees(), so shouldn't this instead be:
> >
> > for (p = worktrees; *p; p++) {
> > fsck_index(&istate, path, p == worktrees);
>
> I think "current" is what we want here, since the point was to return
> the short-but-syntactically-correct ":path-in-index" for the current
> worktree, which is where "rev-parse :path-in-index", etc, would look
> when resolving that name.Okay, that makes sense.
Show 5 quoted lines
> So the code is working as intended, but I may have misused the term > "main" with respect to other worktree code. I didn't even know that was > a concept, not having dealt much with worktrees. > > Maybe it's worth s/main/current/ here (and I guess in t1450)?
Yes, s/main/current/ probably would be helpful for future readers of the code. It's unfortunate that the term "current" can ambiguously also be read as meaning "the up-to-date index" or "the present-time index" as opposed to "the index in this directory/worktree", which is the intention here. But "current" is consistent with the existing `struct worktree.is_current`, so hopefully should not be too confusing.