blob: e967ff1874c252cdd73455f73146b4419b58f9c9 [file] [log] [blame]
Björn Gustavsson9c4a0362009-11-09 21:09:56 +01001--all::
2 Fetch all remotes.
3
Stephan Beyer32402402008-06-08 03:36:09 +02004-a::
5--append::
Jon Loeliger93d69d82005-11-06 23:30:56 -06006 Append ref names and object names of fetched refs to the
7 existing contents of `.git/FETCH_HEAD`. Without this
8 option old data in `.git/FETCH_HEAD` will be overwritten.
9
Patrick Steinhardtc7b190d2021-01-12 13:27:52 +010010--atomic::
11 Use an atomic transaction to update local refs. Either all refs are
12 updated, or on error, no refs are updated.
13
Jari Aalto6b276e12009-10-21 23:07:49 +030014--depth=<depth>::
Sebastian Schuberth60253a62016-01-08 10:32:52 +010015 Limit fetching to the specified number of commits from the tip of
16 each remote branch history. If fetching to a 'shallow' repository
17 created by `git clone` with `--depth=<depth>` option (see
18 linkgit:git-clone[1]), deepen or shorten the history to the specified
19 number of commits. Tags for the deepened commits are not fetched.
Michal Ostrowski2c620a12006-01-20 13:05:24 -050020
Nguyễn Thái Ngọc Duycccf74e2016-06-12 17:54:09 +070021--deepen=<depth>::
22 Similar to --depth, except it specifies the number of commits
23 from the current shallow boundary instead of from the tip of
24 each remote branch history.
25
Nguyễn Thái Ngọc Duy508ea882016-06-12 17:53:59 +070026--shallow-since=<date>::
27 Deepen or shorten the history of a shallow repository to
28 include all reachable commits after <date>.
29
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +070030--shallow-exclude=<revision>::
31 Deepen or shorten the history of a shallow repository to
32 exclude commits reachable from a specified remote branch or tag.
33 This option can be specified multiple times.
34
Nguyễn Thái Ngọc Duy4dcb1672013-01-11 16:05:46 +070035--unshallow::
Nguyễn Thái Ngọc Duy79d3a232013-12-05 20:02:41 +070036 If the source repository is complete, convert a shallow
37 repository to a complete one, removing all the limitations
38 imposed by shallow repositories.
39+
40If the source repository is shallow, fetch as much as possible so that
41the current repository has the same history as the source repository.
Nguyễn Thái Ngọc Duy4dcb1672013-01-11 16:05:46 +070042
Nguyễn Thái Ngọc Duy48d25ca2013-12-05 20:02:42 +070043--update-shallow::
44 By default when fetching from a shallow repository,
45 `git fetch` refuses refs that require updating
46 .git/shallow. This option updates .git/shallow and accept such
47 refs.
Jay Soffian28a15402009-11-10 09:19:43 +010048
Jonathan Tan3390e422018-07-02 15:39:44 -070049--negotiation-tip=<commit|glob>::
50 By default, Git will report, to the server, commits reachable
51 from all local refs to find common commits in an attempt to
52 reduce the size of the to-be-received packfile. If specified,
53 Git will only report commits reachable from the given tips.
54 This is useful to speed up fetches when the user knows which
55 local ref is likely to have commits in common with the
56 upstream ref being fetched.
57+
58This option may be specified more than once; if so, Git will report
59commits reachable from any of the given commits.
60+
61The argument to this option may be a glob on ref names, a ref, or the (possibly
62abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying
63this option multiple times, one for each matching ref name.
Ævar Arnfjörð Bjarmason52660822018-08-01 15:18:35 +000064+
Ævar Arnfjörð Bjarmason60fadf82021-06-30 18:38:11 +020065See also the `fetch.negotiationAlgorithm` and `push.negotiate`
66configuration variables documented in linkgit:git-config[1], and the
67`--negotiate-only` option below.
68
69--negotiate-only::
70 Do not fetch anything from the server, and instead print the
71 ancestors of the provided `--negotiation-tip=*` arguments,
72 which we have in common with the server.
73+
74Internally this is used to implement the `push.negotiate` option, see
75linkgit:git-config[1].
Jonathan Tan3390e422018-07-02 15:39:44 -070076
Jay Soffian28a15402009-11-10 09:19:43 +010077--dry-run::
78 Show what would be done, without making any changes.
Jay Soffian28a15402009-11-10 09:19:43 +010079
Junio C Hamano887952b2020-08-18 14:25:22 +000080ifndef::git-pull[]
81--[no-]write-fetch-head::
82 Write the list of remote refs fetched in the `FETCH_HEAD`
83 file directly under `$GIT_DIR`. This is the default.
84 Passing `--no-write-fetch-head` from the command line tells
85 Git not to write the file. Under `--dry-run` option, the
86 file is never written.
87endif::git-pull[]
88
Stephan Beyer32402402008-06-08 03:36:09 +020089-f::
90--force::
Ævar Arnfjörð Bjarmasonae6a4702018-08-31 20:10:03 +000091 When 'git fetch' is used with `<src>:<dst>` refspec it may
92 refuse to update the local branch as discussed
93ifdef::git-pull[]
94 in the `<refspec>` part of the linkgit:git-fetch[1]
95 documentation.
96endif::git-pull[]
97ifndef::git-pull[]
98 in the `<refspec>` part below.
99endif::git-pull[]
100 This option overrides that check.
Jon Loeliger93d69d82005-11-06 23:30:56 -0600101
Jari Aalto6b276e12009-10-21 23:07:49 +0300102-k::
103--keep::
104 Keep downloaded pack.
105
Björn Gustavsson16679e32009-11-09 21:10:32 +0100106ifndef::git-pull[]
107--multiple::
108 Allow several <repository> and <group> arguments to be
109 specified. No <refspec>s may be specified.
Jay Soffianf360d842009-11-10 09:15:47 +0100110
Derrick Stoleea95ce122020-09-17 18:11:44 +0000111--[no-]auto-maintenance::
Nguyễn Thái Ngọc Duyc3d6b702019-06-19 16:46:30 +0700112--[no-]auto-gc::
Derrick Stoleea95ce122020-09-17 18:11:44 +0000113 Run `git maintenance run --auto` at the end to perform automatic
114 repository maintenance if needed. (`--[no-]auto-gc` is a synonym.)
115 This is enabled by default.
Nguyễn Thái Ngọc Duyc3d6b702019-06-19 16:46:30 +0700116
Johannes Schindelinc14e6e72019-11-03 00:21:56 +0000117--[no-]write-commit-graph::
118 Write a commit-graph after fetching. This overrides the config
119 setting `fetch.writeCommitGraph`.
René Scharfe9c688732020-03-09 22:51:39 +0100120endif::git-pull[]
Johannes Schindelinc14e6e72019-11-03 00:21:56 +0000121
Derrick Stolee2e031152021-04-16 12:49:57 +0000122--prefetch::
123 Modify the configured refspec to place all refs into the
124 `refs/prefetch/` namespace. See the `prefetch` task in
125 linkgit:git-maintenance[1].
126
Oren Held1b79d1c2010-07-13 15:01:40 +0300127-p::
Jay Soffianf360d842009-11-10 09:15:47 +0100128--prune::
Jeff King9e702332016-06-13 19:58:51 -0400129 Before fetching, remove any remote-tracking references that no
Michael Haggerty0838bf42013-10-30 06:33:00 +0100130 longer exist on the remote. Tags are not subject to pruning
131 if they are fetched only because of the default tag
132 auto-following or due to a --tags option. However, if tags
133 are fetched due to an explicit refspec (either on the command
134 line or in the remote configuration, for example if the remote
135 was cloned with the --mirror option), then they are also
Ævar Arnfjörð Bjarmason97716d22018-02-09 20:32:15 +0000136 subject to pruning. Supplying `--prune-tags` is a shorthand for
137 providing the tag refspec.
René Scharfe9c688732020-03-09 22:51:39 +0100138ifndef::git-pull[]
Ævar Arnfjörð Bjarmason97716d22018-02-09 20:32:15 +0000139+
140See the PRUNING section below for more details.
141
142-P::
143--prune-tags::
144 Before fetching, remove any local tags that no longer exist on
145 the remote if `--prune` is enabled. This option should be used
146 more carefully, unlike `--prune` it will remove any local
147 references (local tags) that have been created. This option is
148 a shorthand for providing the explicit tag refspec along with
149 `--prune`, see the discussion about that in its documentation.
Ævar Arnfjörð Bjarmason627a1292018-02-09 20:32:13 +0000150+
151See the PRUNING section below for more details.
152
Björn Gustavsson16679e32009-11-09 21:10:32 +0100153endif::git-pull[]
154
Miklos Vajna10eb64f2008-01-25 10:17:38 +0000155ifndef::git-pull[]
Stephan Beyer32402402008-06-08 03:36:09 +0200156-n::
Miklos Vajna10eb64f2008-01-25 10:17:38 +0000157endif::git-pull[]
Michael Haggerty01ca90c2013-10-30 06:33:05 +0100158--no-tags::
Miklos Vajna10eb64f2008-01-25 10:17:38 +0000159 By default, tags that point at objects that are downloaded
160 from the remote repository are fetched and stored locally.
Daniel Johnsoned368542010-08-11 18:57:20 -0400161 This option disables this automatic tag following. The default
Nguyễn Thái Ngọc Duyda0005b2015-03-11 16:32:45 -0400162 behavior for a remote may be specified with the remote.<name>.tagOpt
Daniel Johnsoned368542010-08-11 18:57:20 -0400163 setting. See linkgit:git-config[1].
Junio C Hamano03febf92006-01-07 00:48:04 -0800164
Junio C Hamanoc5558f82014-05-29 15:21:31 -0700165--refmap=<refspec>::
166 When fetching refs listed on the command line, use the
167 specified refspec (can be given more than once) to map the
168 refs to remote-tracking branches, instead of the values of
169 `remote.*.fetch` configuration variables for the remote
Derrick Stoleeb40a5022020-01-21 01:38:12 +0000170 repository. Providing an empty `<refspec>` to the
171 `--refmap` option causes Git to ignore the configured
172 refspecs and rely entirely on the refspecs supplied as
173 command-line arguments. See section on "Configured Remote-tracking
Junio C Hamanoc5558f82014-05-29 15:21:31 -0700174 Branches" for details.
175
Stephan Beyer32402402008-06-08 03:36:09 +0200176-t::
177--tags::
Michael Haggerty0838bf42013-10-30 06:33:00 +0100178 Fetch all tags from the remote (i.e., fetch remote tags
179 `refs/tags/*` into local tags with the same name), in addition
180 to whatever else would otherwise be fetched. Using this
181 option alone does not subject tags to pruning, even if --prune
182 is used (though tags may be pruned anyway if they are also the
Matthieu Moybcf96262016-06-28 13:40:11 +0200183 destination of an explicit refspec; see `--prune`).
Jon Loeliger93d69d82005-11-06 23:30:56 -0600184
René Scharfe9c688732020-03-09 22:51:39 +0100185ifndef::git-pull[]
Jens Lehmann8f0700d2011-03-06 23:11:21 +0100186--recurse-submodules[=yes|on-demand|no]::
187 This option controls if and under what conditions new commits of
188 populated submodules should be fetched too. It can be used as a
189 boolean option to completely disable recursion when set to 'no' or to
190 unconditionally recurse into all populated submodules when set to
191 'yes', which is the default when this option is used without any
192 value. Use 'on-demand' to only recurse into a populated submodule
193 when the superproject retrieves a commit that updates the submodule's
Jens Lehmannc16c3e42011-03-06 23:12:58 +0100194 reference to a commit that isn't already in the local submodule
Damien Robert4da9e992020-04-06 15:57:08 +0200195 clone. By default, 'on-demand' is used, unless
196 `fetch.recurseSubmodules` is set (see linkgit:git-config[1]).
René Scharfe9c688732020-03-09 22:51:39 +0100197endif::git-pull[]
Jens Lehmann8f0700d2011-03-06 23:11:21 +0100198
Stefan Beller62104ba2015-12-15 16:04:12 -0800199-j::
200--jobs=<n>::
Johannes Schindelind54dea72019-10-05 11:46:40 -0700201 Number of parallel children to be used for all forms of fetching.
202+
203If the `--multiple` option was specified, the different remotes will be fetched
204in parallel. If multiple submodules are fetched, they will be fetched in
205parallel. To control them independently, use the config settings
206`fetch.parallel` and `submodule.fetchJobs` (see linkgit:git-config[1]).
207+
208Typically, parallel recursive and multi-remote fetches will be faster. By
209default fetches are performed sequentially, not in parallel.
Stefan Beller62104ba2015-12-15 16:04:12 -0800210
René Scharfe9c688732020-03-09 22:51:39 +0100211ifndef::git-pull[]
Jens Lehmann8f0700d2011-03-06 23:11:21 +0100212--no-recurse-submodules::
213 Disable recursive fetching of submodules (this has the same effect as
Matthieu Moybcf96262016-06-28 13:40:11 +0200214 using the `--recurse-submodules=no` option).
René Scharfe9c688732020-03-09 22:51:39 +0100215endif::git-pull[]
Jens Lehmann7dce19d2010-11-12 13:54:52 +0100216
Corentin BOMPARD24bc1a12019-08-19 11:11:20 +0200217--set-upstream::
Philippe Blain847b3722020-08-12 23:52:00 +0000218 If the remote is fetched successfully, add upstream
Corentin BOMPARD24bc1a12019-08-19 11:11:20 +0200219 (tracking) reference, used by argument-less
220 linkgit:git-pull[1] and other commands. For more information,
221 see `branch.<name>.merge` and `branch.<name>.remote` in
222 linkgit:git-config[1].
223
René Scharfe9c688732020-03-09 22:51:39 +0100224ifndef::git-pull[]
Jens Lehmann7dce19d2010-11-12 13:54:52 +0100225--submodule-prefix=<path>::
226 Prepend <path> to paths printed in informative messages
227 such as "Fetching submodule foo". This option is used
228 internally when recursing over submodules.
Jens Lehmann88a21972011-03-06 23:10:46 +0100229
230--recurse-submodules-default=[yes|on-demand]::
231 This option is used internally to temporarily provide a
232 non-negative default value for the --recurse-submodules
233 option. All other methods of configuring fetch's submodule
234 recursion (such as settings in linkgit:gitmodules[5] and
235 linkgit:git-config[1]) override this option, as does
236 specifying --[no-]recurse-submodules directly.
Jens Lehmann7dce19d2010-11-12 13:54:52 +0100237
Stephan Beyer32402402008-06-08 03:36:09 +0200238-u::
239--update-head-ok::
Thomas Rast0b444cd2010-01-10 00:33:00 +0100240 By default 'git fetch' refuses to update the head which
Jon Loeliger93d69d82005-11-06 23:30:56 -0600241 corresponds to the current branch. This flag disables the
Thomas Rast0b444cd2010-01-10 00:33:00 +0100242 check. This is purely for the internal use for 'git pull'
243 to communicate with 'git fetch', and unless you are
Junio C Hamanoa597fb02007-01-01 15:07:35 -0800244 implementing your own Porcelain you are not supposed to
245 use it.
René Scharfef05558f2020-03-28 15:48:33 +0100246endif::git-pull[]
Junio C Hamano03febf92006-01-07 00:48:04 -0800247
Jari Aalto6b276e12009-10-21 23:07:49 +0300248--upload-pack <upload-pack>::
249 When given, and the repository to fetch from is handled
Matthieu Moybcf96262016-06-28 13:40:11 +0200250 by 'git fetch-pack', `--exec=<upload-pack>` is passed to
Jari Aalto6b276e12009-10-21 23:07:49 +0300251 the command to specify non-default path for the command
252 run on the other end.
253
254ifndef::git-pull[]
255-q::
256--quiet::
257 Pass --quiet to git-fetch-pack and silence any other internally
Tay Ray Chuan98390182010-02-24 20:50:28 +0800258 used git commands. Progress is not reported to the standard error
259 stream.
Jari Aalto6b276e12009-10-21 23:07:49 +0300260
261-v::
262--verbose::
263 Be verbose.
264endif::git-pull[]
Tay Ray Chuan98390182010-02-24 20:50:28 +0800265
266--progress::
267 Progress status is reported on the standard error stream
268 by default when it is attached to a terminal, unless -q
269 is specified. This flag forces progress status even if the
270 standard error stream is not directed to a terminal.
Eric Wongc915f112016-02-03 04:09:14 +0000271
Brandon Williams5e3548e2018-04-23 15:46:24 -0700272-o <option>::
273--server-option=<option>::
274 Transmit the given string to the server when communicating using
275 protocol version 2. The given string must not contain a NUL or LF
Jonathan Tan6e983052019-04-12 12:51:22 -0700276 character. The server's handling of server options, including
277 unknown ones, is server-specific.
Brandon Williams5e3548e2018-04-23 15:46:24 -0700278 When multiple `--server-option=<option>` are given, they are all
279 sent to the other side in the order listed on the command line.
280
Derrick Stoleecdbd70c2019-06-18 13:25:26 -0700281--show-forced-updates::
282 By default, git checks if a branch is force-updated during
283 fetch. This can be disabled through fetch.showForcedUpdates, but
284 the --show-forced-updates option guarantees this check occurs.
285 See linkgit:git-config[1].
286
287--no-show-forced-updates::
288 By default, git checks if a branch is force-updated during
289 fetch. Pass --no-show-forced-updates or set fetch.showForcedUpdates
290 to false to skip this check for performance reasons. If used during
291 'git-pull' the --ff-only option will still check for forced updates
292 before attempting a fast-forward update. See linkgit:git-config[1].
293
Eric Wongc915f112016-02-03 04:09:14 +0000294-4::
295--ipv4::
296 Use IPv4 addresses only, ignoring IPv6 addresses.
297
298-6::
299--ipv6::
300 Use IPv6 addresses only, ignoring IPv4 addresses.