6 git-pull - Fetch from and integrate with another repository or a local branch
12 'git pull' [<options>] [<repository> [<refspec>...]]
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`.
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'.
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
30 a collection of refs with corresponding remote-tracking branches
31 (e.g., refs/heads/{asterisk}:refs/remotes/origin/{asterisk}),
32 but usually it is the name of a branch in the remote repository.
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`.
38 Assume the following history exists and the current branch is
42 A---B---C master on origin
46 origin/master in your repository
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.
56 A---B---C origin/master
58 D---E---F---G---H master
61 See linkgit:git-merge[1] for details, including how conflicts
62 are presented and handled.
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'
66 with uncommitted changes is discouraged: while possible, it leaves you
67 in a state that may be hard to back out of in the case of a conflict.
69 If any of the remote changes overlap with local uncommitted changes,
70 the merge will be automatically canceled and the work tree untouched.
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].
79 This is passed to both underlying git-fetch to squelch reporting of
80 during transfer, and underlying git-merge to squelch output during
85 Pass --verbose to git-fetch and git-merge.
87 --[no-]recurse-submodules[=yes|on-demand|no]::
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
91 linkgit:gitmodules[5]).
93 If the checkout is done via rebase, local submodule commits are rebased as well.
95 If the update is done via merge, the submodule conflicts are resolved and checked out.
97 Options related to merging
98 ~~~~~~~~~~~~~~~~~~~~~~~~~~
102 include::merge-options.txt[]
105 --rebase[=false|true|merges|preserve|interactive]::
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.
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).
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.
120 When false, merge the current branch into the upstream branch.
122 When `interactive`, enable the interactive mode of rebase.
124 See `pull.rebase`, `branch.<name>.rebase` and `branch.autoSetupRebase` in
125 linkgit:git-config[1] if you want to make `git pull` always use
126 `--rebase` instead of merging.
129 This is a potentially _dangerous_ mode of operation.
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.
135 Override earlier --rebase.
139 Before starting rebase, stash local modifications away (see
140 linkgit:git-stash[1]) if needed, and apply the stash entry when
141 done. `--no-autostash` is useful to override the `rebase.autoStash`
142 configuration variable (see linkgit:git-config[1]).
144 This option is only valid when "--rebase" is used.
146 Options related to fetching
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
149 include::fetch-options.txt[]
151 include::pull-fetch-param.txt[]
153 include::urls-remotes.txt[]
155 include::merge-strategies.txt[]
160 Often people use `git pull` without giving any parameter.
161 Traditionally, this has been equivalent to saying `git pull
162 origin`. However, when configuration `branch.<name>.remote` is
163 present while on branch `<name>`, that value is used instead of
166 In order to determine what URL to use to fetch from, the value
167 of the configuration `remote.<origin>.url` is consulted
168 and if there is not any such variable, the value on the `URL:` line
169 in `$GIT_DIR/remotes/<origin>` is used.
171 In order to determine what remote branches to fetch (and
172 optionally store in the remote-tracking branches) when the command is
173 run without any refspec parameters on the command line, values
174 of the configuration variable `remote.<origin>.fetch` are
175 consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>`
176 is consulted and its `Pull:` lines are used.
177 In addition to the refspec formats described in the OPTIONS
178 section, you can have a globbing refspec that looks like this:
181 refs/heads/*:refs/remotes/origin/*
184 A globbing refspec must have a non-empty RHS (i.e. must store
185 what were fetched in remote-tracking branches), and its LHS and RHS
186 must end with `/*`. The above specifies that all remote
187 branches are tracked using remote-tracking branches in
188 `refs/remotes/origin/` hierarchy under the same name.
190 The rule to determine which remote branch to merge after
191 fetching is a bit involved, in order not to break backward
194 If explicit refspecs were given on the command
195 line of `git pull`, they are all merged.
197 When no refspec was given on the command line, then `git pull`
198 uses the refspec from the configuration or
199 `$GIT_DIR/remotes/<origin>`. In such cases, the following
202 . If `branch.<name>.merge` configuration for the current
203 branch `<name>` exists, that is the name of the branch at the
204 remote site that is merged.
206 . If the refspec is a globbing one, nothing is merged.
208 . Otherwise the remote branch of the first refspec is merged.
214 * Update the remote-tracking branches for the repository
215 you cloned from, then merge one of them into your
218 ------------------------------------------------
221 ------------------------------------------------
223 Normally the branch merged in is the HEAD of the remote repository,
224 but the choice is determined by the branch.<name>.remote and
225 branch.<name>.merge options; see linkgit:git-config[1] for details.
227 * Merge into the current branch the remote branch `next`:
229 ------------------------------------------------
230 $ git pull origin next
231 ------------------------------------------------
233 This leaves a copy of `next` temporarily in FETCH_HEAD, and
234 updates the remote-tracking branch `origin/next`.
235 The same can be done by invoking fetch and merge:
237 ------------------------------------------------
239 $ git merge origin/next
240 ------------------------------------------------
243 If you tried a pull which resulted in complex conflicts and
244 would want to start over, you can recover with 'git reset'.
247 include::transfer-data-leaks.txt[]
251 Using --recurse-submodules can only fetch new commits in already checked
252 out submodules right now. When e.g. upstream added a new submodule in the
253 just fetched commits of the superproject the submodule itself cannot be
254 fetched, making it impossible to check out that submodule later without
255 having to do a fetch again. This is expected to be fixed in a future Git
260 linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
264 Part of the linkgit:git[1] suite