fetch/pull: recurse into submodules when necessary
[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
JA
10--depth=<depth>::
11 Deepen the history of a 'shallow' repository created by
12 `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
13 by the specified number of commits.
2c620a1a 14
28a15401
JS
15ifndef::git-pull[]
16--dry-run::
17 Show what would be done, without making any changes.
18endif::git-pull[]
19
3240240f
SB
20-f::
21--force::
0b444cdb 22 When 'git fetch' is used with `<rbranch>:<lbranch>`
a3e3dc46
JH
23 refspec, it refuses to update the local branch
24 `<lbranch>` unless the remote branch `<rbranch>` it
25 fetches is a descendant of `<lbranch>`. This option
26 overrides that check.
93d69d86 27
6b276e19
JA
28-k::
29--keep::
30 Keep downloaded pack.
31
16679e37
BG
32ifndef::git-pull[]
33--multiple::
34 Allow several <repository> and <group> arguments to be
35 specified. No <refspec>s may be specified.
f360d844 36
1b79d1c2 37-p::
f360d844 38--prune::
0e615b25 39 After fetching, remove any remote-tracking branches which
f360d844 40 no longer exist on the remote.
16679e37
BG
41endif::git-pull[]
42
10eb64f5 43ifdef::git-pull[]
3240240f 44--no-tags::
10eb64f5
MV
45endif::git-pull[]
46ifndef::git-pull[]
3240240f
SB
47-n::
48--no-tags::
10eb64f5
MV
49endif::git-pull[]
50 By default, tags that point at objects that are downloaded
51 from the remote repository are fetched and stored locally.
ed368546
DJ
52 This option disables this automatic tag following. The default
53 behavior for a remote may be specified with the remote.<name>.tagopt
54 setting. See linkgit:git-config[1].
03febf99 55
2e5955f3 56ifndef::git-pull[]
3240240f
SB
57-t::
58--tags::
03febf99
JH
59 Most of the tags are fetched automatically as branch
60 heads are downloaded, but tags that do not point at
61 objects reachable from the branch heads that are being
62 tracked will not be fetched by this mechanism. This
63 flag lets all tags and their associated objects be
ed368546
DJ
64 downloaded. The default behavior for a remote may be
65 specified with the remote.<name>.tagopt setting. See
66 linkgit:git-config[1].
93d69d86 67
be254a0e
JL
68--[no-]recurse-submodules::
69 This option controls if new commits of all populated submodules should
c1a3c364 70 be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
7dce19d3 71
7dce19d3
JL
72--submodule-prefix=<path>::
73 Prepend <path> to paths printed in informative messages
74 such as "Fetching submodule foo". This option is used
75 internally when recursing over submodules.
88a21979
JL
76
77--recurse-submodules-default=[yes|on-demand]::
78 This option is used internally to temporarily provide a
79 non-negative default value for the --recurse-submodules
80 option. All other methods of configuring fetch's submodule
81 recursion (such as settings in linkgit:gitmodules[5] and
82 linkgit:git-config[1]) override this option, as does
83 specifying --[no-]recurse-submodules directly.
7dce19d3 84endif::git-pull[]
93d69d86 85
3240240f
SB
86-u::
87--update-head-ok::
0b444cdb 88 By default 'git fetch' refuses to update the head which
93d69d86 89 corresponds to the current branch. This flag disables the
0b444cdb
TR
90 check. This is purely for the internal use for 'git pull'
91 to communicate with 'git fetch', and unless you are
a597fb0e
JH
92 implementing your own Porcelain you are not supposed to
93 use it.
03febf99 94
6b276e19
JA
95--upload-pack <upload-pack>::
96 When given, and the repository to fetch from is handled
0b444cdb 97 by 'git fetch-pack', '--exec=<upload-pack>' is passed to
6b276e19
JA
98 the command to specify non-default path for the command
99 run on the other end.
100
101ifndef::git-pull[]
102-q::
103--quiet::
104 Pass --quiet to git-fetch-pack and silence any other internally
9839018e
TRC
105 used git commands. Progress is not reported to the standard error
106 stream.
6b276e19
JA
107
108-v::
109--verbose::
110 Be verbose.
111endif::git-pull[]
9839018e
TRC
112
113--progress::
114 Progress status is reported on the standard error stream
115 by default when it is attached to a terminal, unless -q
116 is specified. This flag forces progress status even if the
117 standard error stream is not directed to a terminal.