From: Damien Robert Date: Fri, 20 Mar 2020 21:37:26 GMT Subject: [PATCH v3 2/5] doc: document --recurse-submodules for reset and restore Message-ID: <20200320213729.571924-3-damien.olivier.robert+git@gmail.com> In-Reply-To: <20200320213729.571924-1-damien.olivier.robert+git@gmail.com> Signed-off-by: Damien Robert --- Documentation/git-reset.txt | 6 ++++++ Documentation/git-restore.txt | 10 ++++++++++ 2 files changed, 16 insertions(+) diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 932080c55d..c8623cfc34 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -87,6 +87,12 @@ but carries forward unmerged index entries. different between `` and `HEAD`. If a file that is different between `` 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 diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index 5bf60d4943..47f31d4a0f 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -107,6 +107,16 @@ in linkgit:git-checkout[1] for details. patterns and unconditionally restores any files in ``. +--recurse-submodules:: +--no-recurse-submodules:: + If `` names a submodule and the restore location includes + the working tree, the submodule will only be updated if this option + is given, in which case its working tree will be restored to the + commit recorded in the superproject, and any local modifications + overwritten. If nothing (or `--no-recurse-submodules`) is used, + the work trees of submodules will not be updated. Just like + linkgit:git-checkout[1], this will detach `HEAD` of the submodule. + --overlay:: --no-overlay:: In overlay mode, the command never removes files when -- Patched on top of v2.26.0-rc2-27-gbe8661a328 (git version 2.25.2)