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. Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Reviewed-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Eric Sunshine committed
May 5, 2020 at 03:17 UTC
088018e34d705aad696acfeb624cfe5552ba256f
3 files changed
+18
-10
Documentation/git-restore.txt
+4
-7
@@ -22,9 +22,8 @@ The command can also be used to restore the content in the index with
22
`--staged`, or restore both the working tree and the index with
23
`--staged --worktree`.
24
25
-By default, the restore sources for working tree and the index are the
26
-index and `HEAD` respectively. `--source` could be used to specify a
27
-commit as the restore source.
25
+By default, if `--staged` is given, the contents are restored from `HEAD`,
26
+otherwise from the index. Use `--source` to restore from a different commit.
27
28
See "Reset, restore and revert" in linkgit:git[1] for the differences
29
between the three commands.
@@ -39,10 +38,8 @@ OPTIONS
38
tree. It is common to specify the source tree by naming a
39
commit, branch or tag associated with it.
40
+
42
-If not specified, the default restore source for the working tree is
43
-the index, and the default restore source for the index is
44
-`HEAD`. When both `--staged` and `--worktree` are specified,
45
-`--source` must also be specified.
41
+If not specified, the contents are restored from `HEAD` if `--staged` is
42
+given, otherwise from the index.
43
44
-p::
45
--patch::
builtin/checkout.c
+3
-3
@@ -1581,10 +1581,10 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
1581
if (opts->checkout_index < 0 || opts->checkout_worktree < 0)
1582
BUG("these flags should be non-negative by now");
1583
/*
1584
- * convenient shortcut: "git restore --staged" equals
1585
- * "git restore --staged --source HEAD"
1584
+ * convenient shortcut: "git restore --staged [--worktree]" equals
1585
+ * "git restore --staged [--worktree] --source HEAD"
1586
*/
1587
- if (!opts->from_treeish && opts->checkout_index && !opts->checkout_worktree)
1587
+ if (!opts->from_treeish && opts->checkout_index)
1588
opts->from_treeish = "HEAD";
1589
1590
/*
t/t2070-restore.sh
+11
@@ -69,6 +69,17 @@ test_expect_success 'restore --staged uses HEAD as source' '
69
test_cmp expected actual
70
'
71
72
+test_expect_success 'restore --worktree --staged uses HEAD as source' '
73
+ test_when_finished git reset --hard &&
74
+ git show HEAD:./first.t >expected &&
75
+ echo dirty >>first.t &&
76
+ git add first.t &&
77
+ git restore --worktree --staged first.t &&
78
+ git show :./first.t >actual &&
79
+ test_cmp expected actual &&
80
+ test_cmp expected first.t
81
+'
82
+
83
test_expect_success 'restore --ignore-unmerged ignores unmerged entries' '
84
git init unmerged &&
85
(