Re: Suggestion: make git checkout safer

From: Jeff King <peff@peff.net>
Date: Jun 3, 2015, 09:35 UTC
Message-ID: <20150603093514.GF32000@peff.net>
In-Reply-To: <loom.20150603T110826-777@post.gmane.org>

On Wed, Jun 03, 2015 at 09:21:59AM +0000, Ed Avis wrote:

> I had expected that 'git checkout .' would fix up my working tree to make it
> match the repository (in this case, the current revision of the master
> branch).

It did. :)

Show 12 quoted lines

> The user interface might be something like:
> 
> % git checkout .
> error: Your local changes to the following files would be overwritten:
>         foo
> You may want to commit or stash these changes, or delete the files if you
> don't want them.  Use 'git checkout --force' to proceed, throwing away
> local changes.
> Aborting
> 
> If the checkout operation would only involve creating some files on disk
> which aren't currently there, then it would proceed without prompting.

Thanks for explaining. I see where you are coming from, though I'm still a bit lukewarm on the idea, if only because the vast majority of invocations would involve "--force".

It also seems a bit special-cased to treat restoring deletions specially. I would say the more "usual" way to use checkout like this is to give specific paths. I.e., run "git status", say "oh, I need to restore the contents of 'foo', but not 'bar'", and run "git checkout foo". That works regardless of the type of change to "foo" and "bar".

If we want to introduce more safety here, I'd be inclined to perform the operation by default, but give a better escape hatch. For example, by creating a loose object for any file we're about to overwrite, and possibly writing an entry into a log. That's a lot more work, but has a few advantages:

  1. It helps even when you just ran with "--force" followed by an
     "oops, why did I do that?" moment.

  2. It can help other commands like "git clean".

  3. That log could form a basis for a "git undo" program to help with
     "oops" moments in general (e.g., if you use "git reset ." to
     overwrite what is in the index, we have all of the old file content
     in objects, but it can sometimes be a pain to figure out _which_
     objects went where.

-Peff