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