Documentation / fetch-options.txton commit Merge branch 'sb/submodule-helper-clone-regression-fix' into sb/submodule-init (7307dd8)
   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        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.
  15
  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.
  20+
  21If the source repository is shallow, fetch as much as possible so that
  22the current repository has the same history as the source repository.
  23
  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.
  29
  30ifndef::git-pull[]
  31--dry-run::
  32        Show what would be done, without making any changes.
  33endif::git-pull[]
  34
  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.
  42
  43-k::
  44--keep::
  45        Keep downloaded pack.
  46
  47ifndef::git-pull[]
  48--multiple::
  49        Allow several <repository> and <group> arguments to be
  50        specified. No <refspec>s may be specified.
  51
  52-p::
  53--prune::
  54        After fetching, remove any remote-tracking references that no
  55        longer exist on the remote.  Tags are not subject to pruning
  56        if they are fetched only because of the default tag
  57        auto-following or due to a --tags option.  However, if tags
  58        are fetched due to an explicit refspec (either on the command
  59        line or in the remote configuration, for example if the remote
  60        was cloned with the --mirror option), then they are also
  61        subject to pruning.
  62endif::git-pull[]
  63
  64ifndef::git-pull[]
  65-n::
  66endif::git-pull[]
  67--no-tags::
  68        By default, tags that point at objects that are downloaded
  69        from the remote repository are fetched and stored locally.
  70        This option disables this automatic tag following. The default
  71        behavior for a remote may be specified with the remote.<name>.tagOpt
  72        setting. See linkgit:git-config[1].
  73
  74ifndef::git-pull[]
  75--refmap=<refspec>::
  76        When fetching refs listed on the command line, use the
  77        specified refspec (can be given more than once) to map the
  78        refs to remote-tracking branches, instead of the values of
  79        `remote.*.fetch` configuration variables for the remote
  80        repository.  See section on "Configured Remote-tracking
  81        Branches" for details.
  82
  83-t::
  84--tags::
  85        Fetch all tags from the remote (i.e., fetch remote tags
  86        `refs/tags/*` into local tags with the same name), in addition
  87        to whatever else would otherwise be fetched.  Using this
  88        option alone does not subject tags to pruning, even if --prune
  89        is used (though tags may be pruned anyway if they are also the
  90        destination of an explicit refspec; see '--prune').
  91
  92--recurse-submodules[=yes|on-demand|no]::
  93        This option controls if and under what conditions new commits of
  94        populated submodules should be fetched too. It can be used as a
  95        boolean option to completely disable recursion when set to 'no' or to
  96        unconditionally recurse into all populated submodules when set to
  97        'yes', which is the default when this option is used without any
  98        value. Use 'on-demand' to only recurse into a populated submodule
  99        when the superproject retrieves a commit that updates the submodule's
 100        reference to a commit that isn't already in the local submodule
 101        clone.
 102
 103-j::
 104--jobs=<n>::
 105        Number of parallel children to be used for fetching submodules.
 106        Each will fetch from different submodules, such that fetching many
 107        submodules will be faster. By default submodules will be fetched
 108        one at a time.
 109
 110--no-recurse-submodules::
 111        Disable recursive fetching of submodules (this has the same effect as
 112        using the '--recurse-submodules=no' option).
 113
 114--submodule-prefix=<path>::
 115        Prepend <path> to paths printed in informative messages
 116        such as "Fetching submodule foo".  This option is used
 117        internally when recursing over submodules.
 118
 119--recurse-submodules-default=[yes|on-demand]::
 120        This option is used internally to temporarily provide a
 121        non-negative default value for the --recurse-submodules
 122        option.  All other methods of configuring fetch's submodule
 123        recursion (such as settings in linkgit:gitmodules[5] and
 124        linkgit:git-config[1]) override this option, as does
 125        specifying --[no-]recurse-submodules directly.
 126endif::git-pull[]
 127
 128-u::
 129--update-head-ok::
 130        By default 'git fetch' refuses to update the head which
 131        corresponds to the current branch.  This flag disables the
 132        check.  This is purely for the internal use for 'git pull'
 133        to communicate with 'git fetch', and unless you are
 134        implementing your own Porcelain you are not supposed to
 135        use it.
 136
 137--upload-pack <upload-pack>::
 138        When given, and the repository to fetch from is handled
 139        by 'git fetch-pack', '--exec=<upload-pack>' is passed to
 140        the command to specify non-default path for the command
 141        run on the other end.
 142
 143ifndef::git-pull[]
 144-q::
 145--quiet::
 146        Pass --quiet to git-fetch-pack and silence any other internally
 147        used git commands. Progress is not reported to the standard error
 148        stream.
 149
 150-v::
 151--verbose::
 152        Be verbose.
 153endif::git-pull[]
 154
 155--progress::
 156        Progress status is reported on the standard error stream
 157        by default when it is attached to a terminal, unless -q
 158        is specified. This flag forces progress status even if the
 159        standard error stream is not directed to a terminal.