enhance "git restore --worktree --staged" behavior
v2 cover enhance "git restore --worktree --staged" behavior
This is a re-roll of [1] which enhances git-restore to default --source to HEAD when --worktree and --staged are combined.
Changes since v1:
* tighten the commit message and documentation changes as requested by Junio[2]
* drop patch 1/2 since 2/2 threw away all the changes from 1/2, and the end result is the same with or without 1/2
Although the code is identical between v1 and v2, I didn't include Taylor's "Reviewed-by:"[3,4] since the documentation changes have been refined a bit.
[1]: https://lore.kernel.org/git/[email protected]/
[2]: https://lore.kernel.org/git/[email protected]/
[3]: https://lore.kernel.org/git/[email protected]/
[4]: https://lore.kernel.org/git/[email protected]/
Eric Sunshine (1):
restore: default to HEAD when combining --staged and --worktree
Documentation/git-restore.txt | 11 ++++------- builtin/checkout.c | 6 +++--- t/t2070-restore.sh | 11 +++++++++++ 3 files changed, 18 insertions(+), 10 deletions(-)
Interdiff against v1:
Documentation/git-restore.txt +4 -8
@@ -22,10 +22,8 @@ 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`. -By default, the restore source for `--worktree` is the index, and the -restore source for `--staged` is `HEAD`. When combining `--worktree` and -`--staged`, the restore source is `HEAD`. `--source` can be used to specify -a different commit as the restore source. +By default, if `--staged` is given, the contents are restored from `HEAD`, +otherwise from the index. Use `--source` to restore from a different commit. See "Reset, restore and revert" in linkgit:git[1] for the differences between the three commands.
@@ -40,10 +38,8 @@ OPTIONS tree. It is common to specify the source tree by naming a commit, branch or tag associated with it. + -If not specified, the default restore source for `--worktree` is -the index, and the default restore source for `--staged` is -`HEAD`. When both `--staged` and `--worktree` are specified, -the default restore source is `HEAD`. +If not specified, the contents are restored from `HEAD` if `--staged` is +given, otherwise from the index. -p:: --patch::
Signature · 1 line
2.26.2.672.g232c24e857
PATCH v2 1/1 restore: default to HEAD when combining --staged and --worktree
By default, files are restored from the index for --worktree, and from HEAD for --staged. When --worktree and --staged are combined, --source must be specified to disambiguate the restore source[1], thus making it cumbersome to restore a file in both the worktree and the index.
However, HEAD is also a reasonable default for --worktree when combined with --staged, so make it the default anytime --staged is used (whether combined with --worktree or not).
[1]: Due to an oversight, the --source requirement, though documented, is not actually enforced.
--- Documentation/git-restore.txt | 11 ++++------- builtin/checkout.c | 6 +++--- t/t2070-restore.sh | 11 +++++++++++ 3 files changed, 18 insertions(+), 10 deletions(-)
Documentation/git-restore.txt +4 -7
@@ -22,9 +22,8 @@ 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`. -By default, the restore sources for working tree and the index are the -index and `HEAD` respectively. `--source` could be used to specify a -commit as the restore source. +By default, if `--staged` is given, the contents are restored from `HEAD`, +otherwise from the index. Use `--source` to restore from a different commit. See "Reset, restore and revert" in linkgit:git[1] for the differences between the three commands.
@@ -39,10 +38,8 @@ OPTIONS tree. It is common to specify the source tree by naming a commit, branch or tag associated with it. + -If not specified, the default restore source for the working tree is -the index, and the default restore source for the index is -`HEAD`. When both `--staged` and `--worktree` are specified, -`--source` must also be specified. +If not specified, the contents are restored from `HEAD` if `--staged` is +given, otherwise from the index. -p:: --patch::
builtin/checkout.c +3 -3
@@ -1605,10 +1605,10 @@ static int checkout_main(int argc, const char **argv, const char *prefix,if (opts->checkout_index <0 || opts->checkout_worktree <0 )BUG ("these flags should be non-negative by now" );/* -* convenient shortcut: "git restore --staged" equals -* "git restore --staged --source HEAD" +* convenient shortcut: "git restore --staged [--worktree]" equals +* "git restore --staged [--worktree] --source HEAD" */ -if (!opts->from_treeish && opts->checkout_index && !opts->checkout_worktree) +if (!opts->from_treeish && opts->checkout_index) opts->from_treeish ="HEAD" ;/*
t/t2070-restore.sh +11 -0
@@ -69,6 +69,17 @@ test_expect_success 'restore --staged uses HEAD as source' ' test_cmp expected actual ' +test_expect_success 'restore --worktree --staged uses HEAD as source' ' + test_when_finished git reset --hard && + git show HEAD:./first.t >expected && + echo dirty >>first.t && + git add first.t && + git restore --worktree --staged first.t && + git show :./first.t >actual && + test_cmp expected actual && + test_cmp expected first.t +' + test_expect_success 'restore --ignore-unmerged ignores unmerged entries' ' git init unmerged && (
Signature · 1 line
2.26.2.672.g232c24e857
Re: [PATCH v2 1/1] restore: default to HEAD when combining --staged and --worktree
Quoted 12 lines · Eric Sunshine
By default, files are restored from the index for --worktree, and from HEAD for --staged. When --worktree and --staged are combined, --source must be specified to disambiguate the restore source[1], thus making it cumbersome to restore a file in both the worktree and the index.
However, HEAD is also a reasonable default for --worktree when combined with --staged, so make it the default anytime --staged is used (whether combined with --worktree or not).
[1]: Due to an oversight, the --source requirement, though documented, is not actually enforced.
Quoted 6 lines
Signed-off-by Eric Sunshine <[email protected]>--- Documentation/git-restore.txt | 11 ++++------- builtin/checkout.c | 6 +++--- t/t2070-restore.sh | 11 +++++++++++ 3 files changed, 18 insertions(+), 10 deletions(-)
Thanks, the new version looks good to me, too.
Thanks,
Taylor