From: Damien Robert Date: Fri, 28 Feb 2020 10:35:56 GMT Subject: [PATCH 2/4] doc: document --recurse-submodules for reset and restore Message-ID: <20200228103558.1684937-3-damien.olivier.robert+git@gmail.com> In-Reply-To: <20200228103558.1684937-1-damien.olivier.robert+git@gmail.com> Signed-off-by: Damien Robert --- Documentation/git-reset.txt | 6 ++++++ Documentation/git-restore.txt | 9 +++++++++ 2 files changed, 15 insertions(+) diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 932080c55d..838c0f1101 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 content 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..b94b2559c7 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -107,6 +107,15 @@ in linkgit:git-checkout[1] for details. patterns and unconditionally restores any files in ``. +--recurse-submodules:: +--no-recurse-submodules:: + Using `--recurse-submodules` will update the content of all + restored submodules according to the commit recorded in the + superproject. Local modifications in a restored submodule are + overwritten. If nothing (or `--no-recurse-submodules`) is used, the + work trees of submodules will not be updated. Just like + linkgit:git-submodule[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.25.1-377-g2d2118b814 (git version 2.25.1)