negotiator: unknown fetch.negotiationAlgorithm should error out
[git/git.git] / Documentation / fetch-options.txt
CommitLineData
9c4a036b
BG
1--all::
2 Fetch all remotes.
3
3240240f
SB
4-a::
5--append::
93d69d86
JL
6 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
6b276e19 10--depth=<depth>::
60253a60
SS
11 Limit fetching to the specified number of commits from the tip of
12 each remote branch history. If fetching to a 'shallow' repository
13 created by `git clone` with `--depth=<depth>` option (see
14 linkgit:git-clone[1]), deepen or shorten the history to the specified
15 number of commits. Tags for the deepened commits are not fetched.
2c620a1a 16
cccf74e2
NTND
17--deepen=<depth>::
18 Similar to --depth, except it specifies the number of commits
19 from the current shallow boundary instead of from the tip of
20 each remote branch history.
21
508ea882
NTND
22--shallow-since=<date>::
23 Deepen or shorten the history of a shallow repository to
24 include all reachable commits after <date>.
25
a45a2600
NTND
26--shallow-exclude=<revision>::
27 Deepen or shorten the history of a shallow repository to
28 exclude commits reachable from a specified remote branch or tag.
29 This option can be specified multiple times.
30
4dcb167f 31--unshallow::
79d3a236
NTND
32 If the source repository is complete, convert a shallow
33 repository to a complete one, removing all the limitations
34 imposed by shallow repositories.
35+
36If the source repository is shallow, fetch as much as possible so that
37the current repository has the same history as the source repository.
4dcb167f 38
48d25cae
NTND
39--update-shallow::
40 By default when fetching from a shallow repository,
41 `git fetch` refuses refs that require updating
42 .git/shallow. This option updates .git/shallow and accept such
43 refs.
4dcb167f 44
3390e42a
JT
45--negotiation-tip=<commit|glob>::
46 By default, Git will report, to the server, commits reachable
47 from all local refs to find common commits in an attempt to
48 reduce the size of the to-be-received packfile. If specified,
49 Git will only report commits reachable from the given tips.
50 This is useful to speed up fetches when the user knows which
51 local ref is likely to have commits in common with the
52 upstream ref being fetched.
53+
54This option may be specified more than once; if so, Git will report
55commits reachable from any of the given commits.
56+
57The argument to this option may be a glob on ref names, a ref, or the (possibly
58abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying
59this option multiple times, one for each matching ref name.
60
28a15401
JS
61ifndef::git-pull[]
62--dry-run::
63 Show what would be done, without making any changes.
64endif::git-pull[]
65
3240240f
SB
66-f::
67--force::
0b444cdb 68 When 'git fetch' is used with `<rbranch>:<lbranch>`
a3e3dc46
JH
69 refspec, it refuses to update the local branch
70 `<lbranch>` unless the remote branch `<rbranch>` it
71 fetches is a descendant of `<lbranch>`. This option
72 overrides that check.
93d69d86 73
6b276e19
JA
74-k::
75--keep::
76 Keep downloaded pack.
77
16679e37
BG
78ifndef::git-pull[]
79--multiple::
80 Allow several <repository> and <group> arguments to be
81 specified. No <refspec>s may be specified.
f360d844 82
1b79d1c2 83-p::
f360d844 84--prune::
9e70233a 85 Before fetching, remove any remote-tracking references that no
0838bf47
MH
86 longer exist on the remote. Tags are not subject to pruning
87 if they are fetched only because of the default tag
88 auto-following or due to a --tags option. However, if tags
89 are fetched due to an explicit refspec (either on the command
90 line or in the remote configuration, for example if the remote
91 was cloned with the --mirror option), then they are also
97716d21
ÆAB
92 subject to pruning. Supplying `--prune-tags` is a shorthand for
93 providing the tag refspec.
94+
95See the PRUNING section below for more details.
96
97-P::
98--prune-tags::
99 Before fetching, remove any local tags that no longer exist on
100 the remote if `--prune` is enabled. This option should be used
101 more carefully, unlike `--prune` it will remove any local
102 references (local tags) that have been created. This option is
103 a shorthand for providing the explicit tag refspec along with
104 `--prune`, see the discussion about that in its documentation.
627a129b
ÆAB
105+
106See the PRUNING section below for more details.
107
16679e37
BG
108endif::git-pull[]
109
10eb64f5 110ifndef::git-pull[]
3240240f 111-n::
10eb64f5 112endif::git-pull[]
01ca90c2 113--no-tags::
10eb64f5
MV
114 By default, tags that point at objects that are downloaded
115 from the remote repository are fetched and stored locally.
ed368546 116 This option disables this automatic tag following. The default
da0005b8 117 behavior for a remote may be specified with the remote.<name>.tagOpt
ed368546 118 setting. See linkgit:git-config[1].
03febf99 119
2e5955f3 120ifndef::git-pull[]
c5558f80
JH
121--refmap=<refspec>::
122 When fetching refs listed on the command line, use the
123 specified refspec (can be given more than once) to map the
124 refs to remote-tracking branches, instead of the values of
125 `remote.*.fetch` configuration variables for the remote
126 repository. See section on "Configured Remote-tracking
127 Branches" for details.
128
3240240f
SB
129-t::
130--tags::
0838bf47
MH
131 Fetch all tags from the remote (i.e., fetch remote tags
132 `refs/tags/*` into local tags with the same name), in addition
133 to whatever else would otherwise be fetched. Using this
134 option alone does not subject tags to pruning, even if --prune
135 is used (though tags may be pruned anyway if they are also the
bcf9626a 136 destination of an explicit refspec; see `--prune`).
93d69d86 137
8f0700dd
JL
138--recurse-submodules[=yes|on-demand|no]::
139 This option controls if and under what conditions new commits of
140 populated submodules should be fetched too. It can be used as a
141 boolean option to completely disable recursion when set to 'no' or to
142 unconditionally recurse into all populated submodules when set to
143 'yes', which is the default when this option is used without any
144 value. Use 'on-demand' to only recurse into a populated submodule
145 when the superproject retrieves a commit that updates the submodule's
c16c3e40
JL
146 reference to a commit that isn't already in the local submodule
147 clone.
8f0700dd 148
62104ba1
SB
149-j::
150--jobs=<n>::
151 Number of parallel children to be used for fetching submodules.
152 Each will fetch from different submodules, such that fetching many
153 submodules will be faster. By default submodules will be fetched
154 one at a time.
155
8f0700dd
JL
156--no-recurse-submodules::
157 Disable recursive fetching of submodules (this has the same effect as
bcf9626a 158 using the `--recurse-submodules=no` option).
7dce19d3 159
7dce19d3
JL
160--submodule-prefix=<path>::
161 Prepend <path> to paths printed in informative messages
162 such as "Fetching submodule foo". This option is used
163 internally when recursing over submodules.
88a21979
JL
164
165--recurse-submodules-default=[yes|on-demand]::
166 This option is used internally to temporarily provide a
167 non-negative default value for the --recurse-submodules
168 option. All other methods of configuring fetch's submodule
169 recursion (such as settings in linkgit:gitmodules[5] and
170 linkgit:git-config[1]) override this option, as does
171 specifying --[no-]recurse-submodules directly.
7dce19d3 172endif::git-pull[]
93d69d86 173
3240240f
SB
174-u::
175--update-head-ok::
0b444cdb 176 By default 'git fetch' refuses to update the head which
93d69d86 177 corresponds to the current branch. This flag disables the
0b444cdb
TR
178 check. This is purely for the internal use for 'git pull'
179 to communicate with 'git fetch', and unless you are
a597fb0e
JH
180 implementing your own Porcelain you are not supposed to
181 use it.
03febf99 182
6b276e19
JA
183--upload-pack <upload-pack>::
184 When given, and the repository to fetch from is handled
bcf9626a 185 by 'git fetch-pack', `--exec=<upload-pack>` is passed to
6b276e19
JA
186 the command to specify non-default path for the command
187 run on the other end.
188
189ifndef::git-pull[]
190-q::
191--quiet::
192 Pass --quiet to git-fetch-pack and silence any other internally
9839018e
TRC
193 used git commands. Progress is not reported to the standard error
194 stream.
6b276e19
JA
195
196-v::
197--verbose::
198 Be verbose.
199endif::git-pull[]
9839018e
TRC
200
201--progress::
202 Progress status is reported on the standard error stream
203 by default when it is attached to a terminal, unless -q
204 is specified. This flag forces progress status even if the
205 standard error stream is not directed to a terminal.
c915f11e 206
5e3548ef
BW
207-o <option>::
208--server-option=<option>::
209 Transmit the given string to the server when communicating using
210 protocol version 2. The given string must not contain a NUL or LF
211 character.
212 When multiple `--server-option=<option>` are given, they are all
213 sent to the other side in the order listed on the command line.
214
c915f11e
EW
215-4::
216--ipv4::
217 Use IPv4 addresses only, ignoring IPv6 addresses.
218
219-6::
220--ipv6::
221 Use IPv6 addresses only, ignoring IPv4 addresses.