Documentation/pull-fetch-param.txt

   1 <repository>::
   2         The "remote" repository that is the source of a fetch
   3         or pull operation.  This parameter can be either a URL
   4         (see the section <<URLS,GIT URLS>> below) or the name
   5         of a remote (see the section <<REMOTES,REMOTES>> below).
   6
   7 ifndef::git-pull[]
   8 <group>::
   9         A name referring to a list of repositories as the value
  10         of remotes.<group> in the configuration file.
  11         (See linkgit:git-config[1]).
  12 endif::git-pull[]
  13
  14 <refspec>::
  15         Specifies which refs to fetch and which local refs to update.
  16         When no <refspec>s appear on the command line, the refs to fetch
  17         are read from `remote.<repository>.fetch` variables instead
  18 ifndef::git-pull[]
  19         (see <<CRTB,CONFIGURED REMOTE-TRACKING BRANCHES>> below).
  20 endif::git-pull[]
  21 ifdef::git-pull[]
  22         (see linkgit:git-fetch[1]).
  23 endif::git-pull[]
  24 +
  25 The format of a <refspec> parameter is an optional plus
  26 `+`, followed by the source <src>, followed
  27 by a colon `:`, followed by the destination ref <dst>.
  28 The colon can be omitted when <dst> is empty.  <src> is
  29 typically a ref, but it can also be a fully spelled hex object
  30 name.
  31 +
  32 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`;
  33 it requests fetching everything up to the given tag.
  34 +
  35 The remote ref that matches <src>
  36 is fetched, and if <dst> is not empty string, the local
  37 ref that matches it is fast-forwarded using <src>.
  38 If the optional plus `+` is used, the local ref
  39 is updated even if it does not result in a fast-forward
  40 update.
  41 +
  42 [NOTE]
  43 When the remote branch you want to fetch is known to
  44 be rewound and rebased regularly, it is expected that
  45 its new tip will not be descendant of its previous tip
  46 (as stored in your remote-tracking branch the last time
  47 you fetched).  You would want
  48 to use the `+` sign to indicate non-fast-forward updates
  49 will be needed for such branches.  There is no way to
  50 determine or declare that a branch will be made available
  51 in a repository with this behavior; the pulling user simply
  52 must know this is the expected usage pattern for a branch.
  53 ifdef::git-pull[]
  54 +
  55 [NOTE]
  56 There is a difference between listing multiple <refspec>
  57 directly on 'git pull' command line and having multiple
  58 `remote.<repository>.fetch` entries in your configuration
  59 for a <repository> and running a
  60 'git pull' command without any explicit <refspec> parameters.
  61 <refspec>s listed explicitly on the command line are always
  62 merged into the current branch after fetching.  In other words,
  63 if you list more than one remote ref, 'git pull' will create
  64 an Octopus merge.  On the other hand, if you do not list any
  65 explicit <refspec> parameter on the command line, 'git pull'
  66 will fetch all the <refspec>s it finds in the
  67 `remote.<repository>.fetch` configuration and merge
  68 only the first <refspec> found into the current branch.
  69 This is because making an
  70 Octopus from remote refs is rarely done, while keeping track
  71 of multiple remote heads in one-go by fetching more than one
  72 is often useful.
  73 endif::git-pull[]