Merge branch 'mg/signature-doc' into maint
[git.git] / Documentation / git-pull.txt
blobd033b258e5ee7c6e16c7d96c6339282a849b1b02
1 git-pull(1)
2 ===========
4 NAME
5 ----
6 git-pull - Fetch from and integrate with another repository or a local branch
9 SYNOPSIS
10 --------
11 [verse]
12 'git pull' [options] [<repository> [<refspec>...]]
15 DESCRIPTION
16 -----------
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
39 "`master`":
41 ------------
42           A---B---C master on origin
43          /
44     D---E---F---G master
45         ^
46         origin/master in your repository
47 ------------
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.
55 ------------
56           A---B---C origin/master
57          /         \
58     D---E---F---G---H master
59 ------------
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 cancelled 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].
74 OPTIONS
75 -------
77 -q::
78 --quiet::
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.
83 -v::
84 --verbose::
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 all populated submodules should
89         be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
90         That might be necessary to get the data needed for merging submodule
91         commits, a feature Git learned in 1.7.3. Notice that the result of a
92         merge will not be checked out in the submodule, "git submodule update"
93         has to be called afterwards to bring the work tree up to date with the
94         merge result.
96 Options related to merging
97 ~~~~~~~~~~~~~~~~~~~~~~~~~~
99 :git-pull: 1
101 include::merge-options.txt[]
103 -r::
104 --rebase[=false|true|preserve|interactive]::
105         When true, rebase the current branch on top of the upstream
106         branch after fetching. If there is a remote-tracking branch
107         corresponding to the upstream branch and the upstream branch
108         was rebased since last fetched, the rebase uses that information
109         to avoid rebasing non-local changes.
111 When set to preserve, rebase with the `--preserve-merges` option passed
112 to `git rebase` so that locally created merge commits will not be flattened.
114 When false, merge the current branch into the upstream branch.
116 When `interactive`, enable the interactive mode of rebase.
118 See `pull.rebase`, `branch.<name>.rebase` and `branch.autoSetupRebase` in
119 linkgit:git-config[1] if you want to make `git pull` always use
120 `--rebase` instead of merging.
122 [NOTE]
123 This is a potentially _dangerous_ mode of operation.
124 It rewrites history, which does not bode well when you
125 published that history already.  Do *not* use this option
126 unless you have read linkgit:git-rebase[1] carefully.
128 --no-rebase::
129         Override earlier --rebase.
131 --autostash::
132 --no-autostash::
133         Before starting rebase, stash local modifications away (see
134         linkgit:git-stash[1]) if needed, and apply the stash when
135         done. `--no-autostash` is useful to override the `rebase.autoStash`
136         configuration variable (see linkgit:git-config[1]).
138 This option is only valid when "--rebase" is used.
140 Options related to fetching
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
143 include::fetch-options.txt[]
145 include::pull-fetch-param.txt[]
147 include::urls-remotes.txt[]
149 include::merge-strategies.txt[]
151 DEFAULT BEHAVIOUR
152 -----------------
154 Often people use `git pull` without giving any parameter.
155 Traditionally, this has been equivalent to saying `git pull
156 origin`.  However, when configuration `branch.<name>.remote` is
157 present while on branch `<name>`, that value is used instead of
158 `origin`.
160 In order to determine what URL to use to fetch from, the value
161 of the configuration `remote.<origin>.url` is consulted
162 and if there is not any such variable, the value on `URL: ` line
163 in `$GIT_DIR/remotes/<origin>` file is used.
165 In order to determine what remote branches to fetch (and
166 optionally store in the remote-tracking branches) when the command is
167 run without any refspec parameters on the command line, values
168 of the configuration variable `remote.<origin>.fetch` are
169 consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>`
170 file is consulted and its `Pull: ` lines are used.
171 In addition to the refspec formats described in the OPTIONS
172 section, you can have a globbing refspec that looks like this:
174 ------------
175 refs/heads/*:refs/remotes/origin/*
176 ------------
178 A globbing refspec must have a non-empty RHS (i.e. must store
179 what were fetched in remote-tracking branches), and its LHS and RHS
180 must end with `/*`.  The above specifies that all remote
181 branches are tracked using remote-tracking branches in
182 `refs/remotes/origin/` hierarchy under the same name.
184 The rule to determine which remote branch to merge after
185 fetching is a bit involved, in order not to break backward
186 compatibility.
188 If explicit refspecs were given on the command
189 line of `git pull`, they are all merged.
191 When no refspec was given on the command line, then `git pull`
192 uses the refspec from the configuration or
193 `$GIT_DIR/remotes/<origin>`.  In such cases, the following
194 rules apply:
196 . If `branch.<name>.merge` configuration for the current
197   branch `<name>` exists, that is the name of the branch at the
198   remote site that is merged.
200 . If the refspec is a globbing one, nothing is merged.
202 . Otherwise the remote branch of the first refspec is merged.
205 EXAMPLES
206 --------
208 * Update the remote-tracking branches for the repository
209   you cloned from, then merge one of them into your
210   current branch:
212 ------------------------------------------------
213 $ git pull, git pull origin
214 ------------------------------------------------
216 Normally the branch merged in is the HEAD of the remote repository,
217 but the choice is determined by the branch.<name>.remote and
218 branch.<name>.merge options; see linkgit:git-config[1] for details.
220 * Merge into the current branch the remote branch `next`:
222 ------------------------------------------------
223 $ git pull origin next
224 ------------------------------------------------
226 This leaves a copy of `next` temporarily in FETCH_HEAD, but
227 does not update any remote-tracking branches. Using remote-tracking
228 branches, the same can be done by invoking fetch and merge:
230 ------------------------------------------------
231 $ git fetch origin
232 $ git merge origin/next
233 ------------------------------------------------
236 If you tried a pull which resulted in complex conflicts and
237 would want to start over, you can recover with 'git reset'.
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
244 just fetched commits of the superproject the submodule itself can not be
245 fetched, making it impossible to check out that submodule later without
246 having to do a fetch again. This is expected to be fixed in a future Git
247 version.
249 SEE ALSO
250 --------
251 linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
255 Part of the linkgit:git[1] suite