Re: [PATCH v2 02/18] setup: stop using `the_repository` in `is_inside_worktree()`
- From
Karthik Nayak <karthik.188@gmail.com>
- Date
- May 19, 2026, 08:23 UTC
- Message-ID
- <CAOLa=ZT2Qo+oJ1rx2iM3QRcXMGaucFRJdxBAgxBdz3ZtgSb=Qg@mail.gmail.com>
- In-Reply-To
- <20260518-pks-setup-wo-the-repository-v2-2-6933c0f1d568@pks.im>
Patrick Steinhardt <ps@pks.im> writes:
> The function `is_inside_worktree()` verifies whether or not the current
Nit: Here and the subject s/is_inside_worktree/is_inside_work_tree/
Honestly, I would prefer `worktree` as that's what we've used through out the code base, but that is probably out of scope here.
Show 20 quoted lines
> working directory is located inside the worktree of `the_repository`. > This is done by taking the worktree path and verifying that it's a > prefix of the current working directory. > > This information is cached so that we don't have to re-do this change > multiple times. Furthermore, we proactively set the value in multiple > locations so that we don't even have to perform the check when we have > discovered the repository. > > While we could simply move the caching variable into the repository, the > current layout doesn't really feel sensible in the first place: > > - It can easily lead to false positives or negatives if at any point > in time we may switch the current working directory. > > - We don't call the function in a hot loop, and neither is it overly > expensive to compute. > > Drop the caching infrastructure and instead compute the property ad-hoc > via an injected repository.
So the caching mechanism is simply a global variable pre-set to -1. Okay, so that's a good improvement.
Show 8 quoted lines
> > Note that there is one small gotcha: we sometimes may end up with > relative directory paths, and if so `is_inside_dir()` might fail. This > wasn't an issue before because of how we proactively set the cached > value during repository discovery. Now that we stop doing that it > becomes a problem though, but it is worked around by resolving the > repository directory via `realpath()`. >
Curious if you discovered this via a test. But running the tests without `realpath()` didn't trigger any failures. Is this something we can add a test for?
[snip]