Documentation/git-pull.txt

   1 git-pull(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-pull - Fetch from and integrate with another repository or a local branch
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git pull' [options] [<repository> [<refspec>...]]
  13
  14
  15 DESCRIPTION
  16 -----------
  17
  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`.
  21
  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'.
  26
  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.
  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
  45 ------------
  46
  47 Then "`git pull`" will fetch and replay the changes from the remote
  48 `master` branch since it diverged from the local `master` (i.e., `E`)
  49 until its current commit (`C`) on top of `master` and record the
  50 result in a new commit along with the names of the two parent commits
  51 and a log message from the user describing the changes.
  52
  53 ------------
  54           A---B---C remotes/origin/master
  55          /         \
  56     D---E---F---G---H master
  57 ------------
  58
  59 See linkgit:git-merge[1] for details, including how conflicts
  60 are presented and handled.
  61
  62 In Git 1.7.0 or later, to cancel a conflicting merge, use
  63 `git reset --merge`.  *Warning*: In older versions of Git, running 'git pull'
  64 with uncommitted changes is discouraged: while possible, it leaves you
  65 in a state that may be hard to back out of in the case of a conflict.
  66
  67 If any of the remote changes overlap with local uncommitted changes,
  68 the merge will be automatically cancelled and the work tree untouched.
  69 It is generally best to get any local changes in working order before
  70 pulling or stash them away with linkgit:git-stash[1].
  71
  72 OPTIONS
  73 -------
  74
  75 Options meant for 'git pull' itself and the underlying 'git merge'
  76 must be given before the options meant for 'git fetch'.
  77
  78 -q::
  79 --quiet::
  80         This is passed to both underlying git-fetch to squelch reporting of
  81         during transfer, and underlying git-merge to squelch output during
  82         merging.
  83
  84 -v::
  85 --verbose::
  86         Pass --verbose to git-fetch and git-merge.
  87
  88 --[no-]recurse-submodules[=yes|on-demand|no]::
  89         This option controls if new commits of all populated submodules should
  90         be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
  91         That might be necessary to get the data needed for merging submodule
  92         commits, a feature Git learned in 1.7.3. Notice that the result of a
  93         merge will not be checked out in the submodule, "git submodule update"
  94         has to be called afterwards to bring the work tree up to date with the
  95         merge result.
  96
  97 Options related to merging
  98 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  99
 100 include::merge-options.txt[]
 101
 102 :git-pull: 1
 103
 104 -r::
 105 --rebase[=false|true|preserve]::
 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 +
 112 When preserve, also rebase the current branch on top of the upstream
 113 branch, but pass `--preserve-merges` along to `git rebase` so that
 114 locally created merge commits will not be flattened.
 115 +
 116 When false, merge the current branch into the upstream branch.
 117 +
 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.
 121 +
 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.
 127
 128 --no-rebase::
 129         Override earlier --rebase.
 130
 131 Options related to fetching
 132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133
 134 include::fetch-options.txt[]
 135
 136 include::pull-fetch-param.txt[]
 137
 138 include::urls-remotes.txt[]
 139
 140 include::merge-strategies.txt[]
 141
 142 DEFAULT BEHAVIOUR
 143 -----------------
 144
 145 Often people use `git pull` without giving any parameter.
 146 Traditionally, this has been equivalent to saying `git pull
 147 origin`.  However, when configuration `branch.<name>.remote` is
 148 present while on branch `<name>`, that value is used instead of
 149 `origin`.
 150
 151 In order to determine what URL to use to fetch from, the value
 152 of the configuration `remote.<origin>.url` is consulted
 153 and if there is not any such variable, the value on `URL: ` line
 154 in `$GIT_DIR/remotes/<origin>` file is used.
 155
 156 In order to determine what remote branches to fetch (and
 157 optionally store in the remote-tracking branches) when the command is
 158 run without any refspec parameters on the command line, values
 159 of the configuration variable `remote.<origin>.fetch` are
 160 consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>`
 161 file is consulted and its `Pull: ` lines are used.
 162 In addition to the refspec formats described in the OPTIONS
 163 section, you can have a globbing refspec that looks like this:
 164
 165 ------------
 166 refs/heads/*:refs/remotes/origin/*
 167 ------------
 168
 169 A globbing refspec must have a non-empty RHS (i.e. must store
 170 what were fetched in remote-tracking branches), and its LHS and RHS
 171 must end with `/*`.  The above specifies that all remote
 172 branches are tracked using remote-tracking branches in
 173 `refs/remotes/origin/` hierarchy under the same name.
 174
 175 The rule to determine which remote branch to merge after
 176 fetching is a bit involved, in order not to break backward
 177 compatibility.
 178
 179 If explicit refspecs were given on the command
 180 line of `git pull`, they are all merged.
 181
 182 When no refspec was given on the command line, then `git pull`
 183 uses the refspec from the configuration or
 184 `$GIT_DIR/remotes/<origin>`.  In such cases, the following
 185 rules apply:
 186
 187 . If `branch.<name>.merge` configuration for the current
 188   branch `<name>` exists, that is the name of the branch at the
 189   remote site that is merged.
 190
 191 . If the refspec is a globbing one, nothing is merged.
 192
 193 . Otherwise the remote branch of the first refspec is merged.
 194
 195
 196 EXAMPLES
 197 --------
 198
 199 * Update the remote-tracking branches for the repository
 200   you cloned from, then merge one of them into your
 201   current branch:
 202 +
 203 ------------------------------------------------
 204 $ git pull, git pull origin
 205 ------------------------------------------------
 206 +
 207 Normally the branch merged in is the HEAD of the remote repository,
 208 but the choice is determined by the branch.<name>.remote and
 209 branch.<name>.merge options; see linkgit:git-config[1] for details.
 210
 211 * Merge into the current branch the remote branch `next`:
 212 +
 213 ------------------------------------------------
 214 $ git pull origin next
 215 ------------------------------------------------
 216 +
 217 This leaves a copy of `next` temporarily in FETCH_HEAD, but
 218 does not update any remote-tracking branches. Using remote-tracking
 219 branches, the same can be done by invoking fetch and merge:
 220 +
 221 ------------------------------------------------
 222 $ git fetch origin
 223 $ git merge origin/next
 224 ------------------------------------------------
 225
 226
 227 If you tried a pull which resulted in complex conflicts and
 228 would want to start over, you can recover with 'git reset'.
 229
 230
 231 BUGS
 232 ----
 233 Using --recurse-submodules can only fetch new commits in already checked
 234 out submodules right now. When e.g. upstream added a new submodule in the
 235 just fetched commits of the superproject the submodule itself can not be
 236 fetched, making it impossible to check out that submodule later without
 237 having to do a fetch again. This is expected to be fixed in a future Git
 238 version.
 239
 240 SEE ALSO
 241 --------
 242 linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
 243
 244 GIT
 245 ---
 246 Part of the linkgit:git[1] suite