]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-pull(1) |
2 | =========== | |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
153d7265 | 6 | git-pull - Fetch from and integrate with another repository or a local branch |
2cf565c5 DG |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
de613050 | 12 | 'git pull' [<options>] [<repository> [<refspec>...]] |
0c04094b | 13 | |
2cf565c5 DG |
14 | |
15 | DESCRIPTION | |
16 | ----------- | |
ab9b3138 | 17 | |
3f8fc184 JN |
18 | Incorporates changes from a remote repository into the current |
19 | branch. In its default mode, `git pull` is shorthand for | |
20 | `git fetch` followed by `git merge FETCH_HEAD`. | |
0c04094b | 21 | |
3f8fc184 JN |
22 | More precisely, 'git pull' runs 'git fetch' with the given |
23 | parameters and calls 'git merge' to merge the retrieved branch | |
24 | heads into the current branch. | |
25 | With `--rebase`, it runs 'git rebase' instead of 'git merge'. | |
93d69d86 | 26 | |
3f8fc184 JN |
27 | <repository> should be the name of a remote repository as |
28 | passed to linkgit:git-fetch[1]. <refspec> can name an | |
29 | arbitrary remote ref (for example, the name of a tag) or even | |
0e615b25 | 30 | a collection of refs with corresponding remote-tracking branches |
3bae8d4d JN |
31 | (e.g., refs/heads/{asterisk}:refs/remotes/origin/{asterisk}), |
32 | but usually it is the name of a branch in the remote repository. | |
3f8fc184 JN |
33 | |
34 | Default values for <repository> and <branch> are read from the | |
35 | "remote" and "merge" configuration for the current branch | |
36 | as set by linkgit:git-branch[1] `--track`. | |
37 | ||
38 | Assume the following history exists and the current branch is | |
39 | "`master`": | |
40 | ||
41 | ------------ | |
42 | A---B---C master on origin | |
43 | / | |
44 | D---E---F---G master | |
5a3fd6af JH |
45 | ^ |
46 | origin/master in your repository | |
3f8fc184 JN |
47 | ------------ |
48 | ||
49 | Then "`git pull`" will fetch and replay the changes from the remote | |
50 | `master` branch since it diverged from the local `master` (i.e., `E`) | |
51 | until its current commit (`C`) on top of `master` and record the | |
52 | result in a new commit along with the names of the two parent commits | |
53 | and a log message from the user describing the changes. | |
54 | ||
55 | ------------ | |
5a3fd6af | 56 | A---B---C origin/master |
3f8fc184 JN |
57 | / \ |
58 | D---E---F---G---H master | |
59 | ------------ | |
60 | ||
61 | See linkgit:git-merge[1] for details, including how conflicts | |
62 | are presented and handled. | |
63 | ||
2de9b711 TA |
64 | In Git 1.7.0 or later, to cancel a conflicting merge, use |
65 | `git reset --merge`. *Warning*: In older versions of Git, running 'git pull' | |
e330d8ca | 66 | with uncommitted changes is discouraged: while possible, it leaves you |
3f8fc184 JN |
67 | in a state that may be hard to back out of in the case of a conflict. |
68 | ||
69 | If any of the remote changes overlap with local uncommitted changes, | |
d395745d | 70 | the merge will be automatically canceled and the work tree untouched. |
3f8fc184 JN |
71 | It is generally best to get any local changes in working order before |
72 | pulling or stash them away with linkgit:git-stash[1]. | |
e330d8ca | 73 | |
0c04094b JH |
74 | OPTIONS |
75 | ------- | |
3f7a9b5a | 76 | |
409b8d82 TRC |
77 | -q:: |
78 | --quiet:: | |
9839018e TRC |
79 | This is passed to both underlying git-fetch to squelch reporting of |
80 | during transfer, and underlying git-merge to squelch output during | |
81 | merging. | |
409b8d82 TRC |
82 | |
83 | -v:: | |
84 | --verbose:: | |
85 | Pass --verbose to git-fetch and git-merge. | |
86 | ||
8f0700dd | 87 | --[no-]recurse-submodules[=yes|on-demand|no]:: |
acbfae32 DR |
88 | This option controls if new commits of populated submodules should |
89 | be fetched, and if the working trees of active submodules should be | |
90 | updated, too (see linkgit:git-fetch[1], linkgit:git-config[1] and | |
a6d7eb2c SB |
91 | linkgit:gitmodules[5]). |
92 | + | |
93 | If the checkout is done via rebase, local submodule commits are rebased as well. | |
94 | + | |
95 | If the update is done via merge, the submodule conflicts are resolved and checked out. | |
7811d960 | 96 | |
3f7a9b5a JA |
97 | Options related to merging |
98 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
99 | ||
10eb64f5 | 100 | :git-pull: 1 |
37465016 | 101 | |
d51a4755 JH |
102 | include::merge-options.txt[] |
103 | ||
d9aa3610 | 104 | -r:: |
1131ec98 | 105 | --rebase[=false|true|merges|preserve|interactive]:: |
66713ef3 SH |
106 | When true, rebase the current branch on top of the upstream |
107 | branch after fetching. If there is a remote-tracking branch | |
108 | corresponding to the upstream branch and the upstream branch | |
109 | was rebased since last fetched, the rebase uses that information | |
110 | to avoid rebasing non-local changes. | |
111 | + | |
1131ec98 JS |
112 | When set to `merges`, rebase using `git rebase --rebase-merges` so that |
113 | the local merge commits are included in the rebase (see | |
114 | linkgit:git-rebase[1] for details). | |
115 | + | |
7401ab92 JS |
116 | When set to `preserve` (deprecated in favor of `merges`), rebase with the |
117 | `--preserve-merges` option passed to `git rebase` so that locally created | |
118 | merge commits will not be flattened. | |
66713ef3 SH |
119 | + |
120 | When false, merge the current branch into the upstream branch. | |
11fe3f73 | 121 | + |
f5eb87b9 JS |
122 | When `interactive`, enable the interactive mode of rebase. |
123 | + | |
da0005b8 | 124 | See `pull.rebase`, `branch.<name>.rebase` and `branch.autoSetupRebase` in |
c4f4157e | 125 | linkgit:git-config[1] if you want to make `git pull` always use |
6cf378f0 | 126 | `--rebase` instead of merging. |
473d3316 | 127 | + |
6bfa3c99 JH |
128 | [NOTE] |
129 | This is a potentially _dangerous_ mode of operation. | |
473d3316 JH |
130 | It rewrites history, which does not bode well when you |
131 | published that history already. Do *not* use this option | |
132 | unless you have read linkgit:git-rebase[1] carefully. | |
cd67e4d4 | 133 | |
3240240f SB |
134 | --no-rebase:: |
135 | Override earlier --rebase. | |
cd67e4d4 | 136 | |
3f7a9b5a JA |
137 | Options related to fetching |
138 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
139 | ||
a288394e JS |
140 | include::fetch-options.txt[] |
141 | ||
142 | include::pull-fetch-param.txt[] | |
143 | ||
144 | include::urls-remotes.txt[] | |
145 | ||
146 | include::merge-strategies.txt[] | |
147 | ||
9e2586ff JH |
148 | DEFAULT BEHAVIOUR |
149 | ----------------- | |
150 | ||
151 | Often people use `git pull` without giving any parameter. | |
152 | Traditionally, this has been equivalent to saying `git pull | |
153 | origin`. However, when configuration `branch.<name>.remote` is | |
154 | present while on branch `<name>`, that value is used instead of | |
155 | `origin`. | |
156 | ||
157 | In order to determine what URL to use to fetch from, the value | |
158 | of the configuration `remote.<origin>.url` is consulted | |
0c79cee6 AD |
159 | and if there is not any such variable, the value on the `URL:` line |
160 | in `$GIT_DIR/remotes/<origin>` is used. | |
9e2586ff JH |
161 | |
162 | In order to determine what remote branches to fetch (and | |
8b3f3f84 | 163 | optionally store in the remote-tracking branches) when the command is |
9e2586ff JH |
164 | run without any refspec parameters on the command line, values |
165 | of the configuration variable `remote.<origin>.fetch` are | |
166 | consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>` | |
0c79cee6 | 167 | is consulted and its `Pull:` lines are used. |
9e2586ff JH |
168 | In addition to the refspec formats described in the OPTIONS |
169 | section, you can have a globbing refspec that looks like this: | |
170 | ||
171 | ------------ | |
172 | refs/heads/*:refs/remotes/origin/* | |
173 | ------------ | |
174 | ||
175 | A globbing refspec must have a non-empty RHS (i.e. must store | |
8b3f3f84 | 176 | what were fetched in remote-tracking branches), and its LHS and RHS |
9e2586ff | 177 | must end with `/*`. The above specifies that all remote |
8b3f3f84 | 178 | branches are tracked using remote-tracking branches in |
9e2586ff JH |
179 | `refs/remotes/origin/` hierarchy under the same name. |
180 | ||
181 | The rule to determine which remote branch to merge after | |
182 | fetching is a bit involved, in order not to break backward | |
183 | compatibility. | |
184 | ||
185 | If explicit refspecs were given on the command | |
186 | line of `git pull`, they are all merged. | |
187 | ||
188 | When no refspec was given on the command line, then `git pull` | |
189 | uses the refspec from the configuration or | |
190 | `$GIT_DIR/remotes/<origin>`. In such cases, the following | |
191 | rules apply: | |
192 | ||
193 | . If `branch.<name>.merge` configuration for the current | |
194 | branch `<name>` exists, that is the name of the branch at the | |
195 | remote site that is merged. | |
196 | ||
197 | . If the refspec is a globbing one, nothing is merged. | |
198 | ||
199 | . Otherwise the remote branch of the first refspec is merged. | |
200 | ||
201 | ||
37465016 JH |
202 | EXAMPLES |
203 | -------- | |
204 | ||
921177f5 CC |
205 | * Update the remote-tracking branches for the repository |
206 | you cloned from, then merge one of them into your | |
207 | current branch: | |
208 | + | |
209 | ------------------------------------------------ | |
d395745d RG |
210 | $ git pull |
211 | $ git pull origin | |
921177f5 CC |
212 | ------------------------------------------------ |
213 | + | |
214 | Normally the branch merged in is the HEAD of the remote repository, | |
215 | but the choice is determined by the branch.<name>.remote and | |
216 | branch.<name>.merge options; see linkgit:git-config[1] for details. | |
217 | ||
218 | * Merge into the current branch the remote branch `next`: | |
219 | + | |
220 | ------------------------------------------------ | |
221 | $ git pull origin next | |
222 | ------------------------------------------------ | |
223 | + | |
a4408843 PB |
224 | This leaves a copy of `next` temporarily in FETCH_HEAD, and |
225 | updates the remote-tracking branch `origin/next`. | |
226 | The same can be done by invoking fetch and merge: | |
921177f5 CC |
227 | + |
228 | ------------------------------------------------ | |
d504f697 CB |
229 | $ git fetch origin |
230 | $ git merge origin/next | |
921177f5 | 231 | ------------------------------------------------ |
bccf5956 | 232 | |
37465016 | 233 | |
38ef8a76 | 234 | If you tried a pull which resulted in complex conflicts and |
0b444cdb | 235 | would want to start over, you can recover with 'git reset'. |
3ae854c3 JH |
236 | |
237 | ||
235ec243 MM |
238 | include::transfer-data-leaks.txt[] |
239 | ||
794a3592 JL |
240 | BUGS |
241 | ---- | |
242 | Using --recurse-submodules can only fetch new commits in already checked | |
243 | out submodules right now. When e.g. upstream added a new submodule in the | |
6d169227 | 244 | just fetched commits of the superproject the submodule itself cannot be |
794a3592 | 245 | fetched, making it impossible to check out that submodule later without |
2de9b711 | 246 | having to do a fetch again. This is expected to be fixed in a future Git |
794a3592 JL |
247 | version. |
248 | ||
fdd08979 JH |
249 | SEE ALSO |
250 | -------- | |
5162e697 | 251 | linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1] |
fdd08979 | 252 | |
2cf565c5 DG |
253 | GIT |
254 | --- | |
9e1f0a85 | 255 | Part of the linkgit:git[1] suite |