Documentation / git-fetch.txton commit Merge branch 'sb/submodule-update-dot-branch' (11b5395)
   1git-fetch(1)
   2============
   3
   4NAME
   5----
   6git-fetch - Download objects and refs from another repository
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git fetch' [<options>] [<repository> [<refspec>...]]
  13'git fetch' [<options>] <group>
  14'git fetch' --multiple [<options>] [(<repository> | <group>)...]
  15'git fetch' --all [<options>]
  16
  17
  18DESCRIPTION
  19-----------
  20Fetch branches and/or tags (collectively, "refs") from one or more
  21other repositories, along with the objects necessary to complete their
  22histories.  Remote-tracking branches are updated (see the description
  23of <refspec> below for ways to control this behavior).
  24
  25By default, any tag that points into the histories being fetched is
  26also fetched; the effect is to fetch tags that
  27point at branches that you are interested in.  This default behavior
  28can be changed by using the --tags or --no-tags options or by
  29configuring remote.<name>.tagOpt.  By using a refspec that fetches tags
  30explicitly, you can fetch tags that do not point into branches you
  31are interested in as well.
  32
  33'git fetch' can fetch from either a single named repository or URL,
  34or from several repositories at once if <group> is given and
  35there is a remotes.<group> entry in the configuration file.
  36(See linkgit:git-config[1]).
  37
  38When no remote is specified, by default the `origin` remote will be used,
  39unless there's an upstream branch configured for the current branch.
  40
  41The names of refs that are fetched, together with the object names
  42they point at, are written to `.git/FETCH_HEAD`.  This information
  43may be used by scripts or other git commands, such as linkgit:git-pull[1].
  44
  45OPTIONS
  46-------
  47include::fetch-options.txt[]
  48
  49include::pull-fetch-param.txt[]
  50
  51include::urls-remotes.txt[]
  52
  53
  54CONFIGURED REMOTE-TRACKING BRANCHES[[CRTB]]
  55-------------------------------------------
  56
  57You often interact with the same remote repository by
  58regularly and repeatedly fetching from it.  In order to keep track
  59of the progress of such a remote repository, `git fetch` allows you
  60to configure `remote.<repository>.fetch` configuration variables.
  61
  62Typically such a variable may look like this:
  63
  64------------------------------------------------
  65[remote "origin"]
  66        fetch = +refs/heads/*:refs/remotes/origin/*
  67------------------------------------------------
  68
  69This configuration is used in two ways:
  70
  71* When `git fetch` is run without specifying what branches
  72  and/or tags to fetch on the command line, e.g. `git fetch origin`
  73  or `git fetch`, `remote.<repository>.fetch` values are used as
  74  the refspecs--they specify which refs to fetch and which local refs
  75  to update.  The example above will fetch
  76  all branches that exist in the `origin` (i.e. any ref that matches
  77  the left-hand side of the value, `refs/heads/*`) and update the
  78  corresponding remote-tracking branches in the `refs/remotes/origin/*`
  79  hierarchy.
  80
  81* When `git fetch` is run with explicit branches and/or tags
  82  to fetch on the command line, e.g. `git fetch origin master`, the
  83  <refspec>s given on the command line determine what are to be
  84  fetched (e.g. `master` in the example,
  85  which is a short-hand for `master:`, which in turn means
  86  "fetch the 'master' branch but I do not explicitly say what
  87  remote-tracking branch to update with it from the command line"),
  88  and the example command will
  89  fetch _only_ the 'master' branch.  The `remote.<repository>.fetch`
  90  values determine which
  91  remote-tracking branch, if any, is updated.  When used in this
  92  way, the `remote.<repository>.fetch` values do not have any
  93  effect in deciding _what_ gets fetched (i.e. the values are not
  94  used as refspecs when the command-line lists refspecs); they are
  95  only used to decide _where_ the refs that are fetched are stored
  96  by acting as a mapping.
  97
  98The latter use of the `remote.<repository>.fetch` values can be
  99overridden by giving the `--refmap=<refspec>` parameter(s) on the
 100command line.
 101
 102OUTPUT
 103------
 104
 105The output of "git fetch" depends on the transport method used; this
 106section describes the output when fetching over the Git protocol
 107(either locally or via ssh) and Smart HTTP protocol.
 108
 109The status of the fetch is output in tabular form, with each line
 110representing the status of a single ref. Each line is of the form:
 111
 112-------------------------------
 113 <flag> <summary> <from> -> <to> [<reason>]
 114-------------------------------
 115
 116The status of up-to-date refs is shown only if the --verbose option is
 117used.
 118
 119In compact output mode, specified with configuration variable
 120fetch.output, if either entire `<from>` or `<to>` is found in the
 121other string, it will be substituted with `*` in the other string. For
 122example, `master -> origin/master` becomes `master -> origin/*`.
 123
 124flag::
 125        A single character indicating the status of the ref:
 126(space);; for a successfully fetched fast-forward;
 127`+`;; for a successful forced update;
 128`-`;; for a successfully pruned ref;
 129`t`;; for a successful tag update;
 130`*`;; for a successfully fetched new ref;
 131`!`;; for a ref that was rejected or failed to update; and
 132`=`;; for a ref that was up to date and did not need fetching.
 133
 134summary::
 135        For a successfully fetched ref, the summary shows the old and new
 136        values of the ref in a form suitable for using as an argument to
 137        `git log` (this is `<old>..<new>` in most cases, and
 138        `<old>...<new>` for forced non-fast-forward updates).
 139
 140from::
 141        The name of the remote ref being fetched from, minus its
 142        `refs/<type>/` prefix. In the case of deletion, the name of
 143        the remote ref is "(none)".
 144
 145to::
 146        The name of the local ref being updated, minus its
 147        `refs/<type>/` prefix.
 148
 149reason::
 150        A human-readable explanation. In the case of successfully fetched
 151        refs, no explanation is needed. For a failed ref, the reason for
 152        failure is described.
 153
 154EXAMPLES
 155--------
 156
 157* Update the remote-tracking branches:
 158+
 159------------------------------------------------
 160$ git fetch origin
 161------------------------------------------------
 162+
 163The above command copies all branches from the remote refs/heads/
 164namespace and stores them to the local refs/remotes/origin/ namespace,
 165unless the branch.<name>.fetch option is used to specify a non-default
 166refspec.
 167
 168* Using refspecs explicitly:
 169+
 170------------------------------------------------
 171$ git fetch origin +pu:pu maint:tmp
 172------------------------------------------------
 173+
 174This updates (or creates, as necessary) branches `pu` and `tmp` in
 175the local repository by fetching from the branches (respectively)
 176`pu` and `maint` from the remote repository.
 177+
 178The `pu` branch will be updated even if it is does not fast-forward,
 179because it is prefixed with a plus sign; `tmp` will not be.
 180
 181* Peek at a remote's branch, without configuring the remote in your local
 182repository:
 183+
 184------------------------------------------------
 185$ git fetch git://git.kernel.org/pub/scm/git/git.git maint
 186$ git log FETCH_HEAD
 187------------------------------------------------
 188+
 189The first command fetches the `maint` branch from the repository at
 190`git://git.kernel.org/pub/scm/git/git.git` and the second command uses
 191`FETCH_HEAD` to examine the branch with linkgit:git-log[1].  The fetched
 192objects will eventually be removed by git's built-in housekeeping (see
 193linkgit:git-gc[1]).
 194
 195BUGS
 196----
 197Using --recurse-submodules can only fetch new commits in already checked
 198out submodules right now. When e.g. upstream added a new submodule in the
 199just fetched commits of the superproject the submodule itself can not be
 200fetched, making it impossible to check out that submodule later without
 201having to do a fetch again. This is expected to be fixed in a future Git
 202version.
 203
 204SEE ALSO
 205--------
 206linkgit:git-pull[1]
 207
 208GIT
 209---
 210Part of the linkgit:git[1] suite