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