Documentation/fetch-options.txt

   1 --all::
   2         Fetch all remotes.
   3
   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.
   9
  10 --atomic::
  11         Use an atomic transaction to update local refs. Either all refs are
  12         updated, or on error, no refs are updated.
  13
  14 --depth=<depth>::
  15         Limit fetching to the specified number of commits from the tip of
  16         each remote branch history. If fetching to a 'shallow' repository
  17         created by `git clone` with `--depth=<depth>` option (see
  18         linkgit:git-clone[1]), deepen or shorten the history to the specified
  19         number of commits. Tags for the deepened commits are not fetched.
  20
  21 --deepen=<depth>::
  22         Similar to --depth, except it specifies the number of commits
  23         from the current shallow boundary instead of from the tip of
  24         each remote branch history.
  25
  26 --shallow-since=<date>::
  27         Deepen or shorten the history of a shallow repository to
  28         include all reachable commits after <date>.
  29
  30 --shallow-exclude=<revision>::
  31         Deepen or shorten the history of a shallow repository to
  32         exclude commits reachable from a specified remote branch or tag.
  33         This option can be specified multiple times.
  34
  35 --unshallow::
  36         If the source repository is complete, convert a shallow
  37         repository to a complete one, removing all the limitations
  38         imposed by shallow repositories.
  39 +
  40 If the source repository is shallow, fetch as much as possible so that
  41 the current repository has the same history as the source repository.
  42
  43 --update-shallow::
  44         By default when fetching from a shallow repository,
  45         `git fetch` refuses refs that require updating
  46         .git/shallow. This option updates .git/shallow and accept such
  47         refs.
  48
  49 --negotiation-tip=<commit|glob>::
  50         By default, Git will report, to the server, commits reachable
  51         from all local refs to find common commits in an attempt to
  52         reduce the size of the to-be-received packfile. If specified,
  53         Git will only report commits reachable from the given tips.
  54         This is useful to speed up fetches when the user knows which
  55         local ref is likely to have commits in common with the
  56         upstream ref being fetched.
  57 +
  58 This option may be specified more than once; if so, Git will report
  59 commits reachable from any of the given commits.
  60 +
  61 The argument to this option may be a glob on ref names, a ref, or the (possibly
  62 abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying
  63 this option multiple times, one for each matching ref name.
  64 +
  65 See also the `fetch.negotiationAlgorithm` and `push.negotiate`
  66 configuration variables documented in linkgit:git-config[1], and the
  67 `--negotiate-only` option below.
  68
  69 --negotiate-only::
  70         Do not fetch anything from the server, and instead print the
  71         ancestors of the provided `--negotiation-tip=*` arguments,
  72         which we have in common with the server.
  73 +
  74 This is incompatible with `--recurse-submodules=[yes|on-demand]`.
  75 Internally this is used to implement the `push.negotiate` option, see
  76 linkgit:git-config[1].
  77
  78 --dry-run::
  79         Show what would be done, without making any changes.
  80
  81 ifndef::git-pull[]
  82 --[no-]write-fetch-head::
  83         Write the list of remote refs fetched in the `FETCH_HEAD`
  84         file directly under `$GIT_DIR`.  This is the default.
  85         Passing `--no-write-fetch-head` from the command line tells
  86         Git not to write the file.  Under `--dry-run` option, the
  87         file is never written.
  88 endif::git-pull[]
  89
  90 -f::
  91 --force::
  92         When 'git fetch' is used with `<src>:<dst>` refspec it may
  93         refuse to update the local branch as discussed
  94 ifdef::git-pull[]
  95         in the `<refspec>` part of the linkgit:git-fetch[1]
  96         documentation.
  97 endif::git-pull[]
  98 ifndef::git-pull[]
  99         in the `<refspec>` part below.
 100 endif::git-pull[]
 101         This option overrides that check.
 102
 103 -k::
 104 --keep::
 105         Keep downloaded pack.
 106
 107 ifndef::git-pull[]
 108 --multiple::
 109         Allow several <repository> and <group> arguments to be
 110         specified. No <refspec>s may be specified.
 111
 112 --[no-]auto-maintenance::
 113 --[no-]auto-gc::
 114         Run `git maintenance run --auto` at the end to perform automatic
 115         repository maintenance if needed. (`--[no-]auto-gc` is a synonym.)
 116         This is enabled by default.
 117
 118 --[no-]write-commit-graph::
 119         Write a commit-graph after fetching. This overrides the config
 120         setting `fetch.writeCommitGraph`.
 121 endif::git-pull[]
 122
 123 --prefetch::
 124         Modify the configured refspec to place all refs into the
 125         `refs/prefetch/` namespace. See the `prefetch` task in
 126         linkgit:git-maintenance[1].
 127
 128 -p::
 129 --prune::
 130         Before fetching, remove any remote-tracking references that no
 131         longer exist on the remote.  Tags are not subject to pruning
 132         if they are fetched only because of the default tag
 133         auto-following or due to a --tags option.  However, if tags
 134         are fetched due to an explicit refspec (either on the command
 135         line or in the remote configuration, for example if the remote
 136         was cloned with the --mirror option), then they are also
 137         subject to pruning. Supplying `--prune-tags` is a shorthand for
 138         providing the tag refspec.
 139 ifndef::git-pull[]
 140 +
 141 See the PRUNING section below for more details.
 142
 143 -P::
 144 --prune-tags::
 145         Before fetching, remove any local tags that no longer exist on
 146         the remote if `--prune` is enabled. This option should be used
 147         more carefully, unlike `--prune` it will remove any local
 148         references (local tags) that have been created. This option is
 149         a shorthand for providing the explicit tag refspec along with
 150         `--prune`, see the discussion about that in its documentation.
 151 +
 152 See the PRUNING section below for more details.
 153
 154 endif::git-pull[]
 155
 156 ifndef::git-pull[]
 157 -n::
 158 endif::git-pull[]
 159 --no-tags::
 160         By default, tags that point at objects that are downloaded
 161         from the remote repository are fetched and stored locally.
 162         This option disables this automatic tag following. The default
 163         behavior for a remote may be specified with the remote.<name>.tagOpt
 164         setting. See linkgit:git-config[1].
 165
 166 ifndef::git-pull[]
 167 --refetch::
 168         Instead of negotiating with the server to avoid transferring commits and
 169         associated objects that are already present locally, this option fetches
 170         all objects as a fresh clone would. Use this to reapply a partial clone
 171         filter from configuration or using `--filter=` when the filter
 172         definition has changed. Automatic post-fetch maintenance will perform
 173         object database pack consolidation to remove any duplicate objects.
 174 endif::git-pull[]
 175
 176 --refmap=<refspec>::
 177         When fetching refs listed on the command line, use the
 178         specified refspec (can be given more than once) to map the
 179         refs to remote-tracking branches, instead of the values of
 180         `remote.*.fetch` configuration variables for the remote
 181         repository.  Providing an empty `<refspec>` to the
 182         `--refmap` option causes Git to ignore the configured
 183         refspecs and rely entirely on the refspecs supplied as
 184         command-line arguments. See section on "Configured Remote-tracking
 185         Branches" for details.
 186
 187 -t::
 188 --tags::
 189         Fetch all tags from the remote (i.e., fetch remote tags
 190         `refs/tags/*` into local tags with the same name), in addition
 191         to whatever else would otherwise be fetched.  Using this
 192         option alone does not subject tags to pruning, even if --prune
 193         is used (though tags may be pruned anyway if they are also the
 194         destination of an explicit refspec; see `--prune`).
 195
 196 ifndef::git-pull[]
 197 --recurse-submodules[=yes|on-demand|no]::
 198         This option controls if and under what conditions new commits of
 199         submodules should be fetched too. When recursing through submodules,
 200         `git fetch` always attempts to fetch "changed" submodules, that is, a
 201         submodule that has commits that are referenced by a newly fetched
 202         superproject commit but are missing in the local submodule clone. A
 203         changed submodule can be fetched as long as it is present locally e.g.
 204         in `$GIT_DIR/modules/` (see linkgit:gitsubmodules[7]); if the upstream
 205         adds a new submodule, that submodule cannot be fetched until it is
 206         cloned e.g. by `git submodule update`.
 207 +
 208 When set to 'on-demand', only changed submodules are fetched. When set
 209 to 'yes', all populated submodules are fetched and submodules that are
 210 both unpopulated and changed are fetched. When set to 'no', submodules
 211 are never fetched.
 212 +
 213 When unspecified, this uses the value of `fetch.recurseSubmodules` if it
 214 is set (see linkgit:git-config[1]), defaulting to 'on-demand' if unset.
 215 When this option is used without any value, it defaults to 'yes'.
 216 endif::git-pull[]
 217
 218 -j::
 219 --jobs=<n>::
 220         Number of parallel children to be used for all forms of fetching.
 221 +
 222 If the `--multiple` option was specified, the different remotes will be fetched
 223 in parallel. If multiple submodules are fetched, they will be fetched in
 224 parallel. To control them independently, use the config settings
 225 `fetch.parallel` and `submodule.fetchJobs` (see linkgit:git-config[1]).
 226 +
 227 Typically, parallel recursive and multi-remote fetches will be faster. By
 228 default fetches are performed sequentially, not in parallel.
 229
 230 ifndef::git-pull[]
 231 --no-recurse-submodules::
 232         Disable recursive fetching of submodules (this has the same effect as
 233         using the `--recurse-submodules=no` option).
 234 endif::git-pull[]
 235
 236 --set-upstream::
 237         If the remote is fetched successfully, add upstream
 238         (tracking) reference, used by argument-less
 239         linkgit:git-pull[1] and other commands. For more information,
 240         see `branch.<name>.merge` and `branch.<name>.remote` in
 241         linkgit:git-config[1].
 242
 243 ifndef::git-pull[]
 244 --submodule-prefix=<path>::
 245         Prepend <path> to paths printed in informative messages
 246         such as "Fetching submodule foo".  This option is used
 247         internally when recursing over submodules.
 248
 249 --recurse-submodules-default=[yes|on-demand]::
 250         This option is used internally to temporarily provide a
 251         non-negative default value for the --recurse-submodules
 252         option.  All other methods of configuring fetch's submodule
 253         recursion (such as settings in linkgit:gitmodules[5] and
 254         linkgit:git-config[1]) override this option, as does
 255         specifying --[no-]recurse-submodules directly.
 256
 257 -u::
 258 --update-head-ok::
 259         By default 'git fetch' refuses to update the head which
 260         corresponds to the current branch.  This flag disables the
 261         check.  This is purely for the internal use for 'git pull'
 262         to communicate with 'git fetch', and unless you are
 263         implementing your own Porcelain you are not supposed to
 264         use it.
 265 endif::git-pull[]
 266
 267 --upload-pack <upload-pack>::
 268         When given, and the repository to fetch from is handled
 269         by 'git fetch-pack', `--exec=<upload-pack>` is passed to
 270         the command to specify non-default path for the command
 271         run on the other end.
 272
 273 ifndef::git-pull[]
 274 -q::
 275 --quiet::
 276         Pass --quiet to git-fetch-pack and silence any other internally
 277         used git commands. Progress is not reported to the standard error
 278         stream.
 279
 280 -v::
 281 --verbose::
 282         Be verbose.
 283 endif::git-pull[]
 284
 285 --progress::
 286         Progress status is reported on the standard error stream
 287         by default when it is attached to a terminal, unless -q
 288         is specified. This flag forces progress status even if the
 289         standard error stream is not directed to a terminal.
 290
 291 -o <option>::
 292 --server-option=<option>::
 293         Transmit the given string to the server when communicating using
 294         protocol version 2.  The given string must not contain a NUL or LF
 295         character.  The server's handling of server options, including
 296         unknown ones, is server-specific.
 297         When multiple `--server-option=<option>` are given, they are all
 298         sent to the other side in the order listed on the command line.
 299
 300 --show-forced-updates::
 301         By default, git checks if a branch is force-updated during
 302         fetch. This can be disabled through fetch.showForcedUpdates, but
 303         the --show-forced-updates option guarantees this check occurs.
 304         See linkgit:git-config[1].
 305
 306 --no-show-forced-updates::
 307         By default, git checks if a branch is force-updated during
 308         fetch. Pass --no-show-forced-updates or set fetch.showForcedUpdates
 309         to false to skip this check for performance reasons. If used during
 310         'git-pull' the --ff-only option will still check for forced updates
 311         before attempting a fast-forward update. See linkgit:git-config[1].
 312
 313 -4::
 314 --ipv4::
 315         Use IPv4 addresses only, ignoring IPv6 addresses.
 316
 317 -6::
 318 --ipv6::
 319         Use IPv6 addresses only, ignoring IPv4 addresses.