Merge branch 'nd/index-pack-l10n-buf-overflow' into maint-1.8.1
[git/jnareb-git.git] / Documentation / fetch-options.txt
blob6e98bdf1490a0a5718dd14a4c2d8b2baaee7383e
1 --all::
2         Fetch all remotes.
4 -a::
5 --append::
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.
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         to the specified number of commits from the tip of each remote
14         branch history. Tags for the deepened commits are not fetched.
16 ifndef::git-pull[]
17 --dry-run::
18         Show what would be done, without making any changes.
19 endif::git-pull[]
21 -f::
22 --force::
23         When 'git fetch' is used with `<rbranch>:<lbranch>`
24         refspec, it refuses to update the local branch
25         `<lbranch>` unless the remote branch `<rbranch>` it
26         fetches is a descendant of `<lbranch>`.  This option
27         overrides that check.
29 -k::
30 --keep::
31         Keep downloaded pack.
33 ifndef::git-pull[]
34 --multiple::
35         Allow several <repository> and <group> arguments to be
36         specified. No <refspec>s may be specified.
38 -p::
39 --prune::
40         After fetching, remove any remote-tracking branches which
41         no longer exist on the remote.
42 endif::git-pull[]
44 ifdef::git-pull[]
45 --no-tags::
46 endif::git-pull[]
47 ifndef::git-pull[]
48 -n::
49 --no-tags::
50 endif::git-pull[]
51         By default, tags that point at objects that are downloaded
52         from the remote repository are fetched and stored locally.
53         This option disables this automatic tag following. The default
54         behavior for a remote may be specified with the remote.<name>.tagopt
55         setting. See linkgit:git-config[1].
57 ifndef::git-pull[]
58 -t::
59 --tags::
60         This is a short-hand for giving "refs/tags/*:refs/tags/*"
61         refspec from the command line, to ask all tags to be fetched
62         and stored locally.  Because this acts as an explicit
63         refspec, the default refspecs (configured with the
64         remote.$name.fetch variable) are overridden and not used.
66 --recurse-submodules[=yes|on-demand|no]::
67         This option controls if and under what conditions new commits of
68         populated submodules should be fetched too. It can be used as a
69         boolean option to completely disable recursion when set to 'no' or to
70         unconditionally recurse into all populated submodules when set to
71         'yes', which is the default when this option is used without any
72         value. Use 'on-demand' to only recurse into a populated submodule
73         when the superproject retrieves a commit that updates the submodule's
74         reference to a commit that isn't already in the local submodule
75         clone.
77 --no-recurse-submodules::
78         Disable recursive fetching of submodules (this has the same effect as
79         using the '--recurse-submodules=no' option).
81 --submodule-prefix=<path>::
82         Prepend <path> to paths printed in informative messages
83         such as "Fetching submodule foo".  This option is used
84         internally when recursing over submodules.
86 --recurse-submodules-default=[yes|on-demand]::
87         This option is used internally to temporarily provide a
88         non-negative default value for the --recurse-submodules
89         option.  All other methods of configuring fetch's submodule
90         recursion (such as settings in linkgit:gitmodules[5] and
91         linkgit:git-config[1]) override this option, as does
92         specifying --[no-]recurse-submodules directly.
93 endif::git-pull[]
95 -u::
96 --update-head-ok::
97         By default 'git fetch' refuses to update the head which
98         corresponds to the current branch.  This flag disables the
99         check.  This is purely for the internal use for 'git pull'
100         to communicate with 'git fetch', and unless you are
101         implementing your own Porcelain you are not supposed to
102         use it.
104 --upload-pack <upload-pack>::
105         When given, and the repository to fetch from is handled
106         by 'git fetch-pack', '--exec=<upload-pack>' is passed to
107         the command to specify non-default path for the command
108         run on the other end.
110 ifndef::git-pull[]
111 -q::
112 --quiet::
113         Pass --quiet to git-fetch-pack and silence any other internally
114         used git commands. Progress is not reported to the standard error
115         stream.
117 -v::
118 --verbose::
119         Be verbose.
120 endif::git-pull[]
122 --progress::
123         Progress status is reported on the standard error stream
124         by default when it is attached to a terminal, unless -q
125         is specified. This flag forces progress status even if the
126         standard error stream is not directed to a terminal.