git restore --staged --worktree does not restore the index (Git 2.24.1)

git restore --staged --worktree does not restore the index (Git 2.24.1)

[Henré Botha]

git help restore says:

    The command can also be used to restore the content in the index
with --staged, or restore both the working tree and the index with
--staged --worktree.

However, this doesn't seem to work as advertised:

    $ mkdir foo; cd foo; git init
    $ touch a b; git add a b && git commit -m "Initial commit"
    $ echo "Foo" > a; echo "Bar" > b
    $ git add a
    $ git status --short
    M  a
     M b
    $ git restore --staged --worktree .
    $ git status --short
    M  a

I'm not sure whether I expect 'a' to be empty at the end of this
sequence, but I definitely expect it not to contain staged changes.

Re: git restore --staged --worktree does not restore the index (Git 2.24.1)

[Phillip Wood]

Hi Henré

On 16/12/2019 10:51, Henré Botha wrote:
> git help restore says:
> 
>     The command can also be used to restore the content in the index
> with --staged, or restore both the working tree and the index with
> --staged --worktree.
> 
> However, this doesn't seem to work as advertised:
> 
>     $ mkdir foo; cd foo; git init
>     $ touch a b; git add a b && git commit -m "Initial commit"
>     $ echo "Foo" > a; echo "Bar" > b
>     $ git add a
>     $ git status --short
>     M  a
>      M b
>     $ git restore --staged --worktree .
>     $ git status --short
>     M  a
> 
> I'm not sure whether I expect 'a' to be empty at the end of this
> sequence, but I definitely expect it not to contain staged changes.

Thanks for taking the time to report this. The man page for git restore
states

When both `--staged` and `--worktree` are specified, `--source` must
also be specified."

So I think the bug is in the code that checks the options. It looks like
it is just restoring from the index which is why there's no change to 'a'.

Best Wishes

Phillip