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