Re: [PATCH] rebase, cherry-pick, revert: only run from toplevel

From: Jeff King <peff@peff.net>
Date: Aug 31, 2021, 07:01 UTC
Message-ID: <YS3Tv7UfNkF+adry@coredump.intra.peff.net>
In-Reply-To: <pull.1083.git.git.1630379030665.gitgitgadget@gmail.com>

On Tue, Aug 31, 2021 at 03:03:50AM +0000, Elijah Newren via GitGitGadget wrote:

Show 12 quoted lines

> From: Elijah Newren <newren@gmail.com>
> 
> Allowing rebase, cherry-pick and revert to run from subdirectories
> inevitably leads to eventual user confusion.  For example, if they
> are within a directory that was created by one of the patches being
> rebased, then the rebase operation could hit a conflict before the
> directory is restored leading the user to be running from a directory
> that no longer exists.  Similarly with cherry-pick and revert, those
> operations could result in the directory being removed.
> 
> Similar to bisect, simply require that these commands be run from the
> toplevel to avoid such problems.

IMHO this is too draconian. You are occasionally helping people who are in a directory which goes away over the course of the operation. But you are hurting everyone who _isn't_ in that situation, and who needlessly has to re-issue their command after doing a "cd".

I think we'd be much better served to do even a rudimentary analysis of whether the operation will be a problem. E.g., if we taught the checkout code to error out when the cwd is going to disappear, then:

  - we'd protect the user from confusion during regular sight-seeing via
    "git checkout v0.99" and so forth

  - we'd protect the most common cases for git-rebase (your patches
    introduce "subdir/", but it is not yet in the parent directory). We
    wouldn't preemptively avoid a rebase where subdir/ disappears and
    then reappears in the middle of the series. We could find such a
    case by iterating over the patches, but IMHO it's not worth the
    computation.

  - we could likewise protect git-bisect, making it more reasonable to
    loosen its current restriction

  - we might want to teach similar logic to sequencer operations, so
    that applying a patch would likewise error-out. That would protect
    cherry-pick and revert, but also make the "subdir/ disappears
    mid-patch-series" case pretty nice: the specific patch that deletes
    it would fail to apply, and then you could "cd .. && git rebase
    --continue".

    I suspect that the "oops, we're going to delete cwd" code would end
    up in unpack-trees anyway, which means that both checkout and all of
    this sequencer operations would use the same code.

Now I have spent zero time looking into actually coding this, so it may turn out to be much trickier than I am suggesting. But this seems like a much more fruitful direction, where we can protect users in cases where they benefit (and give them sensible and actionable error messages), without bothering people in the majority of cases where their cwd doesn't go away.

-Peff