diff options
| author | Damien Robert <damien.olivier.robert@gmail.com> | 2020-04-06 15:57:06 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2020-04-06 22:42:43 +0200 |
| commit | b3cec57338db7b01681716d072f36c29b7f770f4 (patch) | |
| tree | 3bb3ddfb2070f0b524b7761b53e661b22cd40045 /Documentation/git-restore.txt | |
| parent | doc: list all commands affected by submodule.recurse (diff) | |
| download | git-b3cec57338db7b01681716d072f36c29b7f770f4.tar.xz git-b3cec57338db7b01681716d072f36c29b7f770f4.zip | |
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-restore.txt')
| -rw-r--r-- | Documentation/git-restore.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt index 5bf60d4943..8e3b339802 100644 --- a/Documentation/git-restore.txt +++ b/Documentation/git-restore.txt @@ -107,6 +107,17 @@ in linkgit:git-checkout[1] for details. patterns and unconditionally restores any files in `<pathspec>`. +--recurse-submodules:: +--no-recurse-submodules:: + If `<pathspec>` names an active 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, submodules working trees 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 |