Re: [PATCH v5 4/5] doc: be more precise on (fetch|push).recurseSubmodules
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Apr 5, 2020, 21:57 UTC
- Message-ID
- <xmqqk12twq7x.fsf@gitster.c.googlers.com>
- In-Reply-To
- <20200405201633.704987-5-damien.olivier.robert+git@gmail.com>
Damien Robert <damien.olivier.robert@gmail.com> writes:
Show 36 quoted lines
> The default value also depends on the value of submodule.recurse. > Use this opportunity to correct some grammar mistakes in > Documentation/config/fetch.txt signaled by Robert P. J. Day. > > Also mention `fetch.recurseSubmodules` in fetch-options.txt. In > git-push.txt, `push.recurseSubmodules` is implicitly mentioned (by > explaining how to disable it), so no need to add it there. > > Lastly add a link to `git-fetch` in `git-pull.txt` to explain the > meaning of `--recurse-submodules` there. > > Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com> > --- > Documentation/config/fetch.txt | 13 ++++++++----- > Documentation/config/push.txt | 2 ++ > Documentation/fetch-options.txt | 3 ++- > Documentation/git-pull.txt | 3 +-- > 4 files changed, 13 insertions(+), 8 deletions(-) > > diff --git a/Documentation/config/fetch.txt b/Documentation/config/fetch.txt > index f11940280f..4114af4b3b 100644 > --- a/Documentation/config/fetch.txt > +++ b/Documentation/config/fetch.txt > @@ -1,11 +1,14 @@ > fetch.recurseSubmodules:: > - This option can be either set to a boolean value or to 'on-demand'. > + This option controls whether `git fetch` (and the underlying fetch > + in `git pull`) will recursively fetch into populated submodules. > + This option can be set either to a boolean value or to 'on-demand'. > Setting it to a boolean changes the behavior of fetch and pull to > - unconditionally recurse into submodules when set to true or to not > - recurse at all when set to false. When set to 'on-demand' (the default > - value), fetch and pull will only recurse into a populated submodule > - when its superproject retrieves a commit that updates the submodule's > + recurse unconditionally into submodules when set to true or to not > + recurse at all when set to false. When set to on-demand, fetch and
Why did you lose quotes around on-demand on this line? Shouldn't it be typeset the same way as the other one in the sentence "Defaults to ..."?
> + pull will only recurse into a populated submodule when its > + superproject retrieves a commit that updates the submodule's > reference. > + Defaults to 'on-demand', or to the value of 'submodule.recurse' if set.