diff options
| author |  Eric Sunshine <sunshine@sunshineco.com> | 2020-05-05 03:17:16 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2020-05-05 11:27:38 -0700 |
| commit | 088018e34d705aad696acfeb624cfe5552ba256f (patch) | |
| tree | 9b01540e27bf191fee28c00586eaba938dc1774e /Documentation | |
| parent | Git 2.26.2 (diff) | |
| download | tgif-088018e34d705aad696acfeb624cfe5552ba256f.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-restore.txt | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index 5bf60d4943..0eb766d359 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -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:: |