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