fetch: support fetching from a shallow repository
[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>::
cfb70e1f 11 Deepen or shorten the history of a 'shallow' repository created by
6b276e19 12 `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
bc40deab
PO
13 to the specified number of commits from the tip of each remote
14 branch history. Tags for the deepened commits are not fetched.
2c620a1a 15
4dcb167f
NTND
16--unshallow::
17 Convert a shallow repository to a complete one, removing all
18 the limitations imposed by shallow repositories.
19
28a15401
JS
20ifndef::git-pull[]
21--dry-run::
22 Show what would be done, without making any changes.
23endif::git-pull[]
24
3240240f
SB
25-f::
26--force::
0b444cdb 27 When 'git fetch' is used with `<rbranch>:<lbranch>`
a3e3dc46
JH
28 refspec, it refuses to update the local branch
29 `<lbranch>` unless the remote branch `<rbranch>` it
30 fetches is a descendant of `<lbranch>`. This option
31 overrides that check.
93d69d86 32
6b276e19
JA
33-k::
34--keep::
35 Keep downloaded pack.
36
16679e37
BG
37ifndef::git-pull[]
38--multiple::
39 Allow several <repository> and <group> arguments to be
40 specified. No <refspec>s may be specified.
f360d844 41
1b79d1c2 42-p::
f360d844 43--prune::
0e615b25 44 After fetching, remove any remote-tracking branches which
f360d844 45 no longer exist on the remote.
16679e37
BG
46endif::git-pull[]
47
10eb64f5 48ifdef::git-pull[]
3240240f 49--no-tags::
10eb64f5
MV
50endif::git-pull[]
51ifndef::git-pull[]
3240240f
SB
52-n::
53--no-tags::
10eb64f5
MV
54endif::git-pull[]
55 By default, tags that point at objects that are downloaded
56 from the remote repository are fetched and stored locally.
ed368546
DJ
57 This option disables this automatic tag following. The default
58 behavior for a remote may be specified with the remote.<name>.tagopt
59 setting. See linkgit:git-config[1].
03febf99 60
2e5955f3 61ifndef::git-pull[]
3240240f
SB
62-t::
63--tags::
9eb4754d 64 This is a short-hand for giving `refs/tags/*:refs/tags/*`
f0cb2f13
JH
65 refspec from the command line, to ask all tags to be fetched
66 and stored locally. Because this acts as an explicit
67 refspec, the default refspecs (configured with the
68 remote.$name.fetch variable) are overridden and not used.
93d69d86 69
8f0700dd
JL
70--recurse-submodules[=yes|on-demand|no]::
71 This option controls if and under what conditions new commits of
72 populated submodules should be fetched too. It can be used as a
73 boolean option to completely disable recursion when set to 'no' or to
74 unconditionally recurse into all populated submodules when set to
75 'yes', which is the default when this option is used without any
76 value. Use 'on-demand' to only recurse into a populated submodule
77 when the superproject retrieves a commit that updates the submodule's
c16c3e40
JL
78 reference to a commit that isn't already in the local submodule
79 clone.
8f0700dd
JL
80
81--no-recurse-submodules::
82 Disable recursive fetching of submodules (this has the same effect as
83 using the '--recurse-submodules=no' option).
7dce19d3 84
7dce19d3
JL
85--submodule-prefix=<path>::
86 Prepend <path> to paths printed in informative messages
87 such as "Fetching submodule foo". This option is used
88 internally when recursing over submodules.
88a21979
JL
89
90--recurse-submodules-default=[yes|on-demand]::
91 This option is used internally to temporarily provide a
92 non-negative default value for the --recurse-submodules
93 option. All other methods of configuring fetch's submodule
94 recursion (such as settings in linkgit:gitmodules[5] and
95 linkgit:git-config[1]) override this option, as does
96 specifying --[no-]recurse-submodules directly.
7dce19d3 97endif::git-pull[]
93d69d86 98
3240240f
SB
99-u::
100--update-head-ok::
0b444cdb 101 By default 'git fetch' refuses to update the head which
93d69d86 102 corresponds to the current branch. This flag disables the
0b444cdb
TR
103 check. This is purely for the internal use for 'git pull'
104 to communicate with 'git fetch', and unless you are
a597fb0e
JH
105 implementing your own Porcelain you are not supposed to
106 use it.
03febf99 107
6b276e19
JA
108--upload-pack <upload-pack>::
109 When given, and the repository to fetch from is handled
0b444cdb 110 by 'git fetch-pack', '--exec=<upload-pack>' is passed to
6b276e19
JA
111 the command to specify non-default path for the command
112 run on the other end.
113
114ifndef::git-pull[]
115-q::
116--quiet::
117 Pass --quiet to git-fetch-pack and silence any other internally
9839018e
TRC
118 used git commands. Progress is not reported to the standard error
119 stream.
6b276e19
JA
120
121-v::
122--verbose::
123 Be verbose.
124endif::git-pull[]
9839018e
TRC
125
126--progress::
127 Progress status is reported on the standard error stream
128 by default when it is attached to a terminal, unless -q
129 is specified. This flag forces progress status even if the
130 standard error stream is not directed to a terminal.