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