summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2020-05-08 14:25:08 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-05-08 14:25:08 -0700
commit4c2941a5fa6c99cb204c48d2fe6f3b55a7211012 (patch)
treed82509c96a7eeb7260cbd46c423f4b1d978ac04b /Documentation
parentMerge branch 'jk/arith-expansion-coding-guidelines' (diff)
parentrestore: default to HEAD when combining --staged and --worktree (diff)
downloadtgif-4c2941a5fa6c99cb204c48d2fe6f3b55a7211012.tar.xz
Merge branch 'es/restore-staged-from-head-by-default'
"git restore --staged --worktree" now defaults to take the contents out of "HEAD", instead of erring out. * es/restore-staged-from-head-by-default: restore: default to HEAD when combining --staged and --worktree
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-restore.txt11
1 files changed, 4 insertions, 7 deletions
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index 8e3b339802..84c6c40010 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::