| Message ID | 20200325210943.339240-3-damien.olivier.robert+git@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | doc: --recurse-submodules | expand |
> Le 25 mars 2020 à 17:09, Damien Robert <damien.olivier.robert@gmail.com> a écrit : > > Also unify the formulation about --no-submodules that should be '--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> > --- > Documentation/git-checkout.txt | 2 +- > Documentation/git-read-tree.txt | 2 +- > Documentation/git-reset.txt | 6 ++++++ > Documentation/git-restore.txt | 11 +++++++++++ > Documentation/git-switch.txt | 2 +- > 5 files changed, 20 insertions(+), 3 deletions(-) > > diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt > index c8fb995fa7..140bd3eabb 100644 > --- a/Documentation/git-checkout.txt > +++ b/Documentation/git-checkout.txt > @@ -296,7 +296,7 @@ Note that this option uses the no overlay mode by default (see also > submodules according to the commit recorded in the superproject. If > local modifications in a submodule would be overwritten the checkout > will fail unless `-f` is used. If nothing (or `--no-recurse-submodules`) > - is used, the work trees of submodules will not be updated. > + is used, submodules working trees will not be updated. > Just like linkgit:git-submodule[1], this will detach `HEAD` of the > submodule. > > diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt > index da33f84f33..807cad4691 100644 > --- a/Documentation/git-read-tree.txt > +++ b/Documentation/git-read-tree.txt > @@ -118,7 +118,7 @@ OPTIONS > --[no-]recurse-submodules:: > Using --recurse-submodules will update the content of all initialized > submodules according to the commit recorded in the superproject by > - calling read-tree recursively, also setting the submodules HEAD to be > + calling read-tree recursively, also setting the submodules' HEADs to be I've rethought about that and I think it should be "submodules' HEAD" (sorry!) > detached at that commit. > > --no-sparse-checkout:: > diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt > index 932080c55d..d7a09f11a0 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' HEADs to be detached at that commit. same here > -- > > 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..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 > diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt > index 197900363b..79dbc9624d 100644 > --- a/Documentation/git-switch.txt > +++ b/Documentation/git-switch.txt > @@ -183,7 +183,7 @@ name, the guessing is aborted. You can explicitly give a name with > Using `--recurse-submodules` will update the content of all > initialized submodules according to the commit recorded in the > superproject. If nothing (or `--no-recurse-submodules`) is > - used, the work trees of submodules will not be updated. Just > + used, submodules working trees will not be updated. Just > like linkgit:git-submodule[1], this will detach `HEAD` of the > submodules. > > -- > Patched on top of v2.26.0 (git version 2.25.2) >
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index c8fb995fa7..140bd3eabb 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -296,7 +296,7 @@ Note that this option uses the no overlay mode by default (see also submodules according to the commit recorded in the superproject. If local modifications in a submodule would be overwritten the checkout will fail unless `-f` is used. If nothing (or `--no-recurse-submodules`) - is used, the work trees of submodules will not be updated. + is used, submodules working trees will not be updated. Just like linkgit:git-submodule[1], this will detach `HEAD` of the submodule. diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index da33f84f33..807cad4691 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -118,7 +118,7 @@ OPTIONS --[no-]recurse-submodules:: Using --recurse-submodules will update the content of all initialized submodules according to the commit recorded in the superproject by - calling read-tree recursively, also setting the submodules HEAD to be + calling read-tree recursively, also setting the submodules' HEADs to be detached at that commit. --no-sparse-checkout:: diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 932080c55d..d7a09f11a0 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' HEADs 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..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 diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt index 197900363b..79dbc9624d 100644 --- a/Documentation/git-switch.txt +++ b/Documentation/git-switch.txt @@ -183,7 +183,7 @@ name, the guessing is aborted. You can explicitly give a name with Using `--recurse-submodules` will update the content of all initialized submodules according to the commit recorded in the superproject. If nothing (or `--no-recurse-submodules`) is - used, the work trees of submodules will not be updated. Just + used, submodules working trees will not be updated. Just like linkgit:git-submodule[1], this will detach `HEAD` of the submodules.
Also unify the formulation about --no-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> --- Documentation/git-checkout.txt | 2 +- Documentation/git-read-tree.txt | 2 +- Documentation/git-reset.txt | 6 ++++++ Documentation/git-restore.txt | 11 +++++++++++ Documentation/git-switch.txt | 2 +- 5 files changed, 20 insertions(+), 3 deletions(-)