fetch doc: on pulling multiple refspecs
[git/mingw/j6t.git] / Documentation / pull-fetch-param.txt
blob9cb78d4f75d2d729b4547fa0c088ec6083d6821c
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).
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[]
14 <refspec>::
15         The format of a <refspec> parameter is an optional plus
16         `+`, followed by the source ref <src>, followed
17         by a colon `:`, followed by the destination ref <dst>.
19 The remote ref that matches <src>
20 is fetched, and if <dst> is not empty string, the local
21 ref that matches it is fast-forwarded using <src>.
22 If the optional plus `+` is used, the local ref
23 is updated even if it does not result in a fast-forward
24 update.
26 [NOTE]
27 When the remote branch you want to fetch is known to
28 be rewound and rebased regularly, it is expected that
29 its new tip will not be descendant of its previous tip
30 (as stored in your remote-tracking branch the last time
31 you fetched).  You would want
32 to use the `+` sign to indicate non-fast-forward updates
33 will be needed for such branches.  There is no way to
34 determine or declare that a branch will be made available
35 in a repository with this behavior; the pulling user simply
36 must know this is the expected usage pattern for a branch.
37 ifdef::git-pull[]
39 [NOTE]
40 There is a difference between listing multiple <refspec>
41 directly on 'git pull' command line and having multiple
42 `remote.<repository>.fetch` entries in your configuration
43 for a <repository> and running a
44 'git pull' command without any explicit <refspec> parameters.
45 <refspec>s listed explicitly on the command line are always
46 merged into the current branch after fetching.  In other words,
47 if you list more than one remote ref, 'git pull' will create
48 an Octopus merge.  On the other hand, if you do not list any
49 explicit <refspec> parameter on the command line, 'git pull'
50 will fetch all the <refspec>s it finds in the
51 `remote.<repository>.fetch` configuration and merge
52 only the first <refspec> found into the current branch.
53 This is because making an
54 Octopus from remote refs is rarely done, while keeping track
55 of multiple remote heads in one-go by fetching more than one
56 is often useful.
57 endif::git-pull[]
59 Some short-cut notations are also supported.
61 * `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`;
62   it requests fetching everything up to the given tag.
63 ifndef::git-pull[]
64 * A parameter <ref> without a colon fetches that ref into FETCH_HEAD,
65 endif::git-pull[]
66 ifdef::git-pull[]
67 * A parameter <ref> without a colon merges <ref> into the current
68   branch,
69 endif::git-pull[]
70   and updates the remote-tracking branches (if any).