Skip to content

Commit 7811d96

Browse files
jlehmanngitster
authored andcommitted
pull: Document the "--[no-]recurse-submodules" options
In commits be254a0 and 7dce19d the handling of the new fetch options "--[no-]recurse-submodules" had been added to git-pull.sh. But they were not documented as the pull options they now are, so let's fix that. Signed-off-by: Jens Lehmann <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent cf548ca commit 7811d96

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

Documentation/fetch-options.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,11 @@ ifndef::git-pull[]
6464
downloaded. The default behavior for a remote may be
6565
specified with the remote.<name>.tagopt setting. See
6666
linkgit:git-config[1].
67-
endif::git-pull[]
6867

6968
--[no-]recurse-submodules::
7069
This option controls if new commits of all populated submodules should
7170
be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
7271

73-
ifndef::git-pull[]
7472
--submodule-prefix=<path>::
7573
Prepend <path> to paths printed in informative messages
7674
such as "Fetching submodule foo". This option is used

Documentation/git-pull.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,15 @@ must be given before the options meant for 'git fetch'.
8484
--verbose::
8585
Pass --verbose to git-fetch and git-merge.
8686

87+
--[no-]recurse-submodules::
88+
This option controls if new commits of all populated submodules should
89+
be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
90+
That might be necessary to get the data needed for merging submodule
91+
commits, a feature git learned in 1.7.3. Notice that the result of a
92+
merge will not be checked out in the submodule, "git submodule update"
93+
has to be called afterwards to bring the work tree up to date with the
94+
merge result.
95+
8796
Options related to merging
8897
~~~~~~~~~~~~~~~~~~~~~~~~~~
8998

0 commit comments

Comments
 (0)