git remote doc: correct dangerous lies about what prune does
[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
28a15401
JS
45ifndef::git-pull[]
46--dry-run::
47 Show what would be done, without making any changes.
48endif::git-pull[]
49
3240240f
SB
50-f::
51--force::
0b444cdb 52 When 'git fetch' is used with `<rbranch>:<lbranch>`
a3e3dc46
JH
53 refspec, it refuses to update the local branch
54 `<lbranch>` unless the remote branch `<rbranch>` it
55 fetches is a descendant of `<lbranch>`. This option
56 overrides that check.
93d69d86 57
6b276e19
JA
58-k::
59--keep::
60 Keep downloaded pack.
61
16679e37
BG
62ifndef::git-pull[]
63--multiple::
64 Allow several <repository> and <group> arguments to be
65 specified. No <refspec>s may be specified.
f360d844 66
1b79d1c2 67-p::
f360d844 68--prune::
9e70233a 69 Before fetching, remove any remote-tracking references that no
0838bf47
MH
70 longer exist on the remote. Tags are not subject to pruning
71 if they are fetched only because of the default tag
72 auto-following or due to a --tags option. However, if tags
73 are fetched due to an explicit refspec (either on the command
74 line or in the remote configuration, for example if the remote
75 was cloned with the --mirror option), then they are also
76 subject to pruning.
16679e37
BG
77endif::git-pull[]
78
10eb64f5 79ifndef::git-pull[]
3240240f 80-n::
10eb64f5 81endif::git-pull[]
01ca90c2 82--no-tags::
10eb64f5
MV
83 By default, tags that point at objects that are downloaded
84 from the remote repository are fetched and stored locally.
ed368546 85 This option disables this automatic tag following. The default
da0005b8 86 behavior for a remote may be specified with the remote.<name>.tagOpt
ed368546 87 setting. See linkgit:git-config[1].
03febf99 88
2e5955f3 89ifndef::git-pull[]
c5558f80
JH
90--refmap=<refspec>::
91 When fetching refs listed on the command line, use the
92 specified refspec (can be given more than once) to map the
93 refs to remote-tracking branches, instead of the values of
94 `remote.*.fetch` configuration variables for the remote
95 repository. See section on "Configured Remote-tracking
96 Branches" for details.
97
3240240f
SB
98-t::
99--tags::
0838bf47
MH
100 Fetch all tags from the remote (i.e., fetch remote tags
101 `refs/tags/*` into local tags with the same name), in addition
102 to whatever else would otherwise be fetched. Using this
103 option alone does not subject tags to pruning, even if --prune
104 is used (though tags may be pruned anyway if they are also the
bcf9626a 105 destination of an explicit refspec; see `--prune`).
93d69d86 106
8f0700dd
JL
107--recurse-submodules[=yes|on-demand|no]::
108 This option controls if and under what conditions new commits of
109 populated submodules should be fetched too. It can be used as a
110 boolean option to completely disable recursion when set to 'no' or to
111 unconditionally recurse into all populated submodules when set to
112 'yes', which is the default when this option is used without any
113 value. Use 'on-demand' to only recurse into a populated submodule
114 when the superproject retrieves a commit that updates the submodule's
c16c3e40
JL
115 reference to a commit that isn't already in the local submodule
116 clone.
8f0700dd 117
62104ba1
SB
118-j::
119--jobs=<n>::
120 Number of parallel children to be used for fetching submodules.
121 Each will fetch from different submodules, such that fetching many
122 submodules will be faster. By default submodules will be fetched
123 one at a time.
124
8f0700dd
JL
125--no-recurse-submodules::
126 Disable recursive fetching of submodules (this has the same effect as
bcf9626a 127 using the `--recurse-submodules=no` option).
7dce19d3 128
7dce19d3
JL
129--submodule-prefix=<path>::
130 Prepend <path> to paths printed in informative messages
131 such as "Fetching submodule foo". This option is used
132 internally when recursing over submodules.
88a21979
JL
133
134--recurse-submodules-default=[yes|on-demand]::
135 This option is used internally to temporarily provide a
136 non-negative default value for the --recurse-submodules
137 option. All other methods of configuring fetch's submodule
138 recursion (such as settings in linkgit:gitmodules[5] and
139 linkgit:git-config[1]) override this option, as does
140 specifying --[no-]recurse-submodules directly.
7dce19d3 141endif::git-pull[]
93d69d86 142
3240240f
SB
143-u::
144--update-head-ok::
0b444cdb 145 By default 'git fetch' refuses to update the head which
93d69d86 146 corresponds to the current branch. This flag disables the
0b444cdb
TR
147 check. This is purely for the internal use for 'git pull'
148 to communicate with 'git fetch', and unless you are
a597fb0e
JH
149 implementing your own Porcelain you are not supposed to
150 use it.
03febf99 151
6b276e19
JA
152--upload-pack <upload-pack>::
153 When given, and the repository to fetch from is handled
bcf9626a 154 by 'git fetch-pack', `--exec=<upload-pack>` is passed to
6b276e19
JA
155 the command to specify non-default path for the command
156 run on the other end.
157
158ifndef::git-pull[]
159-q::
160--quiet::
161 Pass --quiet to git-fetch-pack and silence any other internally
9839018e
TRC
162 used git commands. Progress is not reported to the standard error
163 stream.
6b276e19
JA
164
165-v::
166--verbose::
167 Be verbose.
168endif::git-pull[]
9839018e
TRC
169
170--progress::
171 Progress status is reported on the standard error stream
172 by default when it is attached to a terminal, unless -q
173 is specified. This flag forces progress status even if the
174 standard error stream is not directed to a terminal.
c915f11e
EW
175
176-4::
177--ipv4::
178 Use IPv4 addresses only, ignoring IPv6 addresses.
179
180-6::
181--ipv6::
182 Use IPv6 addresses only, ignoring IPv4 addresses.