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