pull: document more passthru options
git pull accepts the options --dry-run, -p/--prune, --refmap, and -t/--tags since a32975f516 (pull: pass git-fetch's options to git-fetch, 2015-06-18), -j/--jobs since 62104ba14a (submodules: allow parallel fetching, add tests and documentation, 2015-12-15), and --set-upstream since 24bc1a1292 (pull, fetch: add --set-upstream option, 2019-08-19). Update its documentation to match. Signed-off-by: René Scharfe <l.s.r@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
René Scharfe committed
Mar 9, 2020 at 22:51 UTC
9c688735f68ef76237708db66b2078bbe78d8f09
1 file changed
+7
-3
Documentation/fetch-options.txt
+7
-3
@@ -61,10 +61,8 @@ this option multiple times, one for each matching ref name.
61
See also the `fetch.negotiationAlgorithm` configuration variable
62
documented in linkgit:git-config[1].
63
64
-ifndef::git-pull[]
64
--dry-run::
65
Show what would be done, without making any changes.
67
-endif::git-pull[]
66
67
-f::
68
--force::
@@ -95,6 +93,7 @@ ifndef::git-pull[]
93
--[no-]write-commit-graph::
94
Write a commit-graph after fetching. This overrides the config
95
setting `fetch.writeCommitGraph`.
96
+endif::git-pull[]
97
98
-p::
99
--prune::
@@ -107,6 +106,7 @@ ifndef::git-pull[]
106
was cloned with the --mirror option), then they are also
107
subject to pruning. Supplying `--prune-tags` is a shorthand for
108
providing the tag refspec.
109
+ifndef::git-pull[]
110
+
111
See the PRUNING section below for more details.
112
@@ -133,7 +133,6 @@ endif::git-pull[]
133
behavior for a remote may be specified with the remote.<name>.tagOpt
134
setting. See linkgit:git-config[1].
135
136
-ifndef::git-pull[]
136
--refmap=<refspec>::
137
When fetching refs listed on the command line, use the
138
specified refspec (can be given more than once) to map the
@@ -154,6 +153,7 @@ ifndef::git-pull[]
153
is used (though tags may be pruned anyway if they are also the
154
destination of an explicit refspec; see `--prune`).
155
156
+ifndef::git-pull[]
157
--recurse-submodules[=yes|on-demand|no]::
158
This option controls if and under what conditions new commits of
159
populated submodules should be fetched too. It can be used as a
@@ -164,6 +164,7 @@ ifndef::git-pull[]
164
when the superproject retrieves a commit that updates the submodule's
165
reference to a commit that isn't already in the local submodule
166
clone.
167
+endif::git-pull[]
168
169
-j::
170
--jobs=<n>::
@@ -177,9 +178,11 @@ parallel. To control them independently, use the config settings
178
Typically, parallel recursive and multi-remote fetches will be faster. By
179
default fetches are performed sequentially, not in parallel.
180
181
+ifndef::git-pull[]
182
--no-recurse-submodules::
183
Disable recursive fetching of submodules (this has the same effect as
184
using the `--recurse-submodules=no` option).
185
+endif::git-pull[]
186
187
--set-upstream::
188
If the remote is fetched successfully, pull and add upstream
@@ -188,6 +191,7 @@ default fetches are performed sequentially, not in parallel.
191
see `branch.<name>.merge` and `branch.<name>.remote` in
192
linkgit:git-config[1].
193
194
+ifndef::git-pull[]
195
--submodule-prefix=<path>::
196
Prepend <path> to paths printed in informative messages
197
such as "Fetching submodule foo". This option is used