summaryrefslogtreecommitdiff
path: root/Documentation/git-reset.txt
diff options
context:
space:
mode:
authorDamien Robert <damien.olivier.robert@gmail.com>2020-04-06 13:57:06 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-04-06 20:42:43 (GMT)
commitb3cec57338db7b01681716d072f36c29b7f770f4 (patch)
tree3bb3ddfb2070f0b524b7761b53e661b22cd40045 /Documentation/git-reset.txt
parentdd0cb7dffabf18e0e7251b04fda53d110151e811 (diff)
downloadgit-b3cec57338db7b01681716d072f36c29b7f770f4.zip
git-b3cec57338db7b01681716d072f36c29b7f770f4.tar.gz
git-b3cec57338db7b01681716d072f36c29b7f770f4.tar.bz2
doc: document --recurse-submodules for reset and restore
Also unify the formulation about --no-recurse-submodules for checkout and switch, which we reuse for restore. And correct the formulation about submodules' HEAD in read-tree, which we reuse in reset. Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-reset.txt')
-rw-r--r--Documentation/git-reset.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 932080c..252e2d4 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -87,6 +87,12 @@ but carries forward unmerged index entries.
different between `<commit>` and `HEAD`.
If a file that is different between `<commit>` and `HEAD` has local
changes, reset is aborted.
+
+--[no-]recurse-submodules::
+ When the working tree is updated, using --recurse-submodules will
+ also recursively reset the working tree of all active submodules
+ according to the commit recorded in the superproject, also setting
+ the submodules' HEAD to be detached at that commit.
--
See "Reset, restore and revert" in linkgit:git[1] for the differences