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         origin/master in your repository
  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 ------------
  56           A---B---C origin/master
  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
  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.
  68
  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].
  73
  74 OPTIONS
  75 -------
  76
  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.
  82
  83 -v::
  84 --verbose::
  85         Pass --verbose to git-fetch and git-merge.
  86
  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.
  95
  96 Options related to merging
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 :git-pull: 1
 100
 101 include::merge-options.txt[]
 102
 103 -r::
 104 --rebase[=false|true|preserve]::
 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.
 110 +
 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.
 113 +
 114 When false, merge the current branch into the upstream branch.
 115 +
 116 See `pull.rebase`, `branch.<name>.rebase` and `branch.autoSetupRebase` in
 117 linkgit:git-config[1] if you want to make `git pull` always use
 118 `--rebase` instead of merging.
 119 +
 120 [NOTE]
 121 This is a potentially _dangerous_ mode of operation.
 122 It rewrites history, which does not bode well when you
 123 published that history already.  Do *not* use this option
 124 unless you have read linkgit:git-rebase[1] carefully.
 125
 126 --no-rebase::
 127         Override earlier --rebase.
 128
 129 Options related to fetching
 130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 131
 132 include::fetch-options.txt[]
 133
 134 include::pull-fetch-param.txt[]
 135
 136 include::urls-remotes.txt[]
 137
 138 include::merge-strategies.txt[]
 139
 140 DEFAULT BEHAVIOUR
 141 -----------------
 142
 143 Often people use `git pull` without giving any parameter.
 144 Traditionally, this has been equivalent to saying `git pull
 145 origin`.  However, when configuration `branch.<name>.remote` is
 146 present while on branch `<name>`, that value is used instead of
 147 `origin`.
 148
 149 In order to determine what URL to use to fetch from, the value
 150 of the configuration `remote.<origin>.url` is consulted
 151 and if there is not any such variable, the value on `URL: ` line
 152 in `$GIT_DIR/remotes/<origin>` file is used.
 153
 154 In order to determine what remote branches to fetch (and
 155 optionally store in the remote-tracking branches) when the command is
 156 run without any refspec parameters on the command line, values
 157 of the configuration variable `remote.<origin>.fetch` are
 158 consulted, and if there aren't any, `$GIT_DIR/remotes/<origin>`
 159 file is consulted and its `Pull: ` lines are used.
 160 In addition to the refspec formats described in the OPTIONS
 161 section, you can have a globbing refspec that looks like this:
 162
 163 ------------
 164 refs/heads/*:refs/remotes/origin/*
 165 ------------
 166
 167 A globbing refspec must have a non-empty RHS (i.e. must store
 168 what were fetched in remote-tracking branches), and its LHS and RHS
 169 must end with `/*`.  The above specifies that all remote
 170 branches are tracked using remote-tracking branches in
 171 `refs/remotes/origin/` hierarchy under the same name.
 172
 173 The rule to determine which remote branch to merge after
 174 fetching is a bit involved, in order not to break backward
 175 compatibility.
 176
 177 If explicit refspecs were given on the command
 178 line of `git pull`, they are all merged.
 179
 180 When no refspec was given on the command line, then `git pull`
 181 uses the refspec from the configuration or
 182 `$GIT_DIR/remotes/<origin>`.  In such cases, the following
 183 rules apply:
 184
 185 . If `branch.<name>.merge` configuration for the current
 186   branch `<name>` exists, that is the name of the branch at the
 187   remote site that is merged.
 188
 189 . If the refspec is a globbing one, nothing is merged.
 190
 191 . Otherwise the remote branch of the first refspec is merged.
 192
 193
 194 EXAMPLES
 195 --------
 196
 197 * Update the remote-tracking branches for the repository
 198   you cloned from, then merge one of them into your
 199   current branch:
 200 +
 201 ------------------------------------------------
 202 $ git pull, git pull origin
 203 ------------------------------------------------
 204 +
 205 Normally the branch merged in is the HEAD of the remote repository,
 206 but the choice is determined by the branch.<name>.remote and
 207 branch.<name>.merge options; see linkgit:git-config[1] for details.
 208
 209 * Merge into the current branch the remote branch `next`:
 210 +
 211 ------------------------------------------------
 212 $ git pull origin next
 213 ------------------------------------------------
 214 +
 215 This leaves a copy of `next` temporarily in FETCH_HEAD, but
 216 does not update any remote-tracking branches. Using remote-tracking
 217 branches, the same can be done by invoking fetch and merge:
 218 +
 219 ------------------------------------------------
 220 $ git fetch origin
 221 $ git merge origin/next
 222 ------------------------------------------------
 223
 224
 225 If you tried a pull which resulted in complex conflicts and
 226 would want to start over, you can recover with 'git reset'.
 227
 228
 229 BUGS
 230 ----
 231 Using --recurse-submodules can only fetch new commits in already checked
 232 out submodules right now. When e.g. upstream added a new submodule in the
 233 just fetched commits of the superproject the submodule itself can not be
 234 fetched, making it impossible to check out that submodule later without
 235 having to do a fetch again. This is expected to be fixed in a future Git
 236 version.
 237
 238 SEE ALSO
 239 --------
 240 linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
 241
 242 GIT
 243 ---
 244 Part of the linkgit:git[1] suite