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