blob: 10171f38ba227d2b08c6e6d25cd0641d28d85c6a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 7.0.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a { color: blue; }
a:visited { color: fuchsia; }
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.2em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.quoteblock .attribution {
text-align: right;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border-color: #527bbd;
border-width: 3px;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
include::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
</style>
<title>git-pull(1)</title>
</head>
<body>
<div id="header">
<h1>
git-pull(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-pull -
Pull and merge from another repository or a local branch
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>git-pull</em> &lt;options&gt; &lt;repository&gt; &lt;refspec&gt;&#8230;</p>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<p>Runs <tt>git-fetch</tt> with the given parameters, and calls <tt>git-merge</tt>
to merge the retrieved head(s) into the current branch.</p>
<p>Note that you can use <tt>.</tt> (current directory) as the
&lt;repository&gt; to pull from the local repository &#8212; this is useful
when merging local branches into the current branch.</p>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
<dl>
<dt>
-n, --no-summary
</dt>
<dd>
<p>
Do not show diffstat at the end of the merge.
</p>
</dd>
<dt>
--no-commit
</dt>
<dd>
<p>
Perform the merge but pretend the merge failed and do
not autocommit, to give the user a chance to inspect and
further tweak the merge result before committing.
</p>
</dd>
<dt>
--squash
</dt>
<dd>
<p>
Produce the working tree and index state as if a real
merge happened, but do not actually make a commit or
move the <tt>HEAD</tt>, nor record <tt>$GIT_DIR/MERGE_HEAD</tt> to
cause the next <tt>git commit</tt> command to create a merge
commit. This allows you to create a single commit on
top of the current branch whose effect is the same as
merging another branch (or more in case of an octopus).
</p>
</dd>
<dt>
-s &lt;strategy&gt;, --strategy=&lt;strategy&gt;
</dt>
<dd>
<p>
Use the given merge strategy; can be supplied more than
once to specify them in the order they should be tried.
If there is no <tt>-s</tt> option, a built-in list of strategies
is used instead (<tt>git-merge-recursive</tt> when merging a single
head, <tt>git-merge-octopus</tt> otherwise).
</p>
</dd>
<dt>
-a, --append
</dt>
<dd>
<p>
Append ref names and object names of fetched refs to the
existing contents of <tt>.git/FETCH_HEAD</tt>. Without this
option old data in <tt>.git/FETCH_HEAD</tt> will be overwritten.
</p>
</dd>
<dt>
--upload-pack &lt;upload-pack&gt;
</dt>
<dd>
<p>
When given, and the repository to fetch from is handled
by <em>git-fetch-pack</em>, <em>--exec=&lt;upload-pack&gt;</em> is passed to
the command to specify non-default path for the command
run on the other end.
</p>
</dd>
<dt>
-f, --force
</dt>
<dd>
<p>
When <tt>git-fetch</tt> is used with <tt>&lt;rbranch&gt;:&lt;lbranch&gt;</tt>
refspec, it refuses to update the local branch
<tt>&lt;lbranch&gt;</tt> unless the remote branch <tt>&lt;rbranch&gt;</tt> it
fetches is a descendant of <tt>&lt;lbranch&gt;</tt>. This option
overrides that check.
</p>
</dd>
<dt>
--no-tags
</dt>
<dd>
<p>
By default, <tt>git-fetch</tt> fetches tags that point at
objects that are downloaded from the remote repository
and stores them locally. This option disables this
automatic tag following.
</p>
</dd>
<dt>
-t, --tags
</dt>
<dd>
<p>
Most of the tags are fetched automatically as branch
heads are downloaded, but tags that do not point at
objects reachable from the branch heads that are being
tracked will not be fetched by this mechanism. This
flag lets all tags and their associated objects be
downloaded.
</p>
</dd>
<dt>
-k, --keep
</dt>
<dd>
<p>
Keep downloaded pack.
</p>
</dd>
<dt>
-u, --update-head-ok
</dt>
<dd>
<p>
By default <tt>git-fetch</tt> refuses to update the head which
corresponds to the current branch. This flag disables the
check. Note that fetching into the current branch will not
update the index and working directory, so use it with care.
</p>
</dd>
<dt>
&lt;repository&gt;
</dt>
<dd>
<p>
The "remote" repository that is the source of a fetch
or pull operation. See the section <a href="#URLS">GIT URLS</a> below.
</p>
</dd>
<dt>
&lt;refspec&gt;
</dt>
<dd>
<p>
The canonical format of a &lt;refspec&gt; parameter is
<tt>+?&lt;src&gt;:&lt;dst&gt;</tt>; that is, an optional plus <tt>+</tt>, followed
by the source ref, followed by a colon <tt>:</tt>, followed by
the destination ref.
</p>
<p>The remote ref that matches &lt;src&gt;
is fetched, and if &lt;dst&gt; is not empty string, the local
ref that matches it is fast forwarded using &lt;src&gt;.
Again, if the optional plus <tt>+</tt> is used, the local ref
is updated even if it does not result in a fast forward
update.</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">If the remote branch from which you want to pull is
modified in non-linear ways such as being rewound and
rebased frequently, then a pull will attempt a merge with
an older version of itself, likely conflict, and fail.
It is under these conditions that you would want to use
the <tt>+</tt> sign to indicate non-fast-forward updates will
be needed. There is currently no easy way to determine
or declare that a branch will be made available in a
repository with this behavior; the pulling user simply
must know this is the expected usage pattern for a branch.</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">You never do your own development on branches that appear
on the right hand side of a &lt;refspec&gt; colon on <tt>Pull:</tt> lines;
they are to be updated by <tt>git-fetch</tt>. If you intend to do
development derived from a remote branch <tt>B</tt>, have a <tt>Pull:</tt>
line to track it (i.e. <tt>Pull: B:remote-B</tt>), and have a separate
branch <tt>my-B</tt> to do your development on top of it. The latter
is created by <tt>git branch my-B remote-B</tt> (or its equivalent <tt>git
checkout -b my-B remote-B</tt>). Run <tt>git fetch</tt> to keep track of
the progress of the remote side, and when you see something new
on the remote branch, merge it into your development branch with
<tt>git pull . remote-B</tt>, while you are on <tt>my-B</tt> branch.
The common <tt>Pull: master:origin</tt> mapping of a remote <tt>master</tt>
branch to a local <tt>origin</tt> branch, which is then merged to a
local development branch, again typically named <tt>master</tt>, is made
when you run <tt>git clone</tt> for you to follow this pattern.</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">There is a difference between listing multiple &lt;refspec&gt;
directly on <tt>git-pull</tt> command line and having multiple
<tt>Pull:</tt> &lt;refspec&gt; lines for a &lt;repository&gt; and running
<tt>git-pull</tt> command without any explicit &lt;refspec&gt; parameters.
&lt;refspec&gt; listed explicitly on the command line are always
merged into the current branch after fetching. In other words,
if you list more than one remote refs, you would be making
an Octopus. While <tt>git-pull</tt> run without any explicit &lt;refspec&gt;
parameter takes default &lt;refspec&gt;s from <tt>Pull:</tt> lines, it
merges only the first &lt;refspec&gt; found into the current branch,
after fetching all the remote refs. This is because making an
Octopus from remote refs is rarely done, while keeping track
of multiple remote heads in one-go by fetching more than one
is often useful.</td>
</tr></table>
</div>
<p>Some short-cut notations are also supported.</p>
<ul>
<li>
<p>
<tt>tag &lt;tag&gt;</tt> means the same as <tt>refs/tags/&lt;tag&gt;:refs/tags/&lt;tag&gt;</tt>;
it requests fetching everything up to the given tag.
</p>
</li>
<li>
<p>
A parameter &lt;ref&gt; without a colon is equivalent to
&lt;ref&gt;: when pulling/fetching, so it merges &lt;ref&gt; into the current
branch without storing the remote branch anywhere locally
</p>
</li>
</ul>
</dd>
</dl>
</div>
<h2>GIT URLS<a id="URLS"></a></h2>
<div class="sectionbody">
<p>One of the following notations can be used
to name the remote repository:</p>
<div class="exampleblock">
<div class="exampleblock-content">
<ul>
<li>
<p>
rsync://host.xz/path/to/repo.git/
</p>
</li>
<li>
<p>
http://host.xz/path/to/repo.git/
</p>
</li>
<li>
<p>
https://host.xz/path/to/repo.git/
</p>
</li>
<li>
<p>
git://host.xz/path/to/repo.git/
</p>
</li>
<li>
<p>
git://host.xz/~user/path/to/repo.git/
</p>
</li>
<li>
<p>
ssh://&#91;user@&#93;host.xz/path/to/repo.git/
</p>
</li>
<li>
<p>
ssh://&#91;user@&#93;host.xz/~user/path/to/repo.git/
</p>
</li>
<li>
<p>
ssh://&#91;user@&#93;host.xz/~/path/to/repo.git
</p>
</li>
</ul>
</div></div>
<p>SSH is the default transport protocol. You can optionally specify
which user to log-in as, and an alternate, scp-like syntax is also
supported. Both syntaxes support username expansion,
as does the native git protocol. The following three are
identical to the last three above, respectively:</p>
<div class="exampleblock">
<div class="exampleblock-content">
<ul>
<li>
<p>
&#91;user@&#93;host.xz:/path/to/repo.git/
</p>
</li>
<li>
<p>
&#91;user@&#93;host.xz:~user/path/to/repo.git/
</p>
</li>
<li>
<p>
&#91;user@&#93;host.xz:path/to/repo.git
</p>
</li>
</ul>
</div></div>
<p>To sync with a local directory, use:</p>
<div class="exampleblock">
<div class="exampleblock-content">
<ul>
<li>
<p>
/path/to/repo.git/
</p>
</li>
</ul>
</div></div>
</div>
<h2>REMOTES</h2>
<div class="sectionbody">
<p>In addition to the above, as a short-hand, the name of a
file in <tt>$GIT_DIR/remotes</tt> directory can be given; the
named file should be in the following format:</p>
<div class="literalblock">
<div class="content">
<pre><tt>URL: one of the above URL format
Push: &lt;refspec&gt;
Pull: &lt;refspec&gt;</tt></pre>
</div></div>
<p>Then such a short-hand is specified in place of
&lt;repository&gt; without &lt;refspec&gt; parameters on the command
line, &lt;refspec&gt; specified on <tt>Push:</tt> lines or <tt>Pull:</tt>
lines are used for <tt>git-push</tt> and <tt>git-fetch</tt>/<tt>git-pull</tt>,
respectively. Multiple <tt>Push:</tt> and <tt>Pull:</tt> lines may
be specified for additional branch mappings.</p>
<p>Or, equivalently, in the <tt>$GIT_DIR/config</tt> (note the use
of <tt>fetch</tt> instead of <tt>Pull:</tt>):</p>
<div class="literalblock">
<div class="content">
<pre><tt>url = &lt;url&gt;
push = &lt;refspec&gt;
fetch = &lt;refspec&gt;</tt></pre>
</div></div>
<p>The name of a file in <tt>$GIT_DIR/branches</tt> directory can be
specified as an older notation short-hand; the named
file should contain a single line, a URL in one of the
above formats, optionally followed by a hash <tt>#</tt> and the
name of remote head (URL fragment notation).
<tt>$GIT_DIR/branches/&lt;remote&gt;</tt> file that stores a &lt;url&gt;
without the fragment is equivalent to have this in the
corresponding file in the <tt>$GIT_DIR/remotes/</tt> directory.</p>
<div class="literalblock">
<div class="content">
<pre><tt>URL: &lt;url&gt;
Pull: refs/heads/master:&lt;remote&gt;</tt></pre>
</div></div>
<p>while having <tt>&lt;url&gt;#&lt;head&gt;</tt> is equivalent to</p>
<div class="literalblock">
<div class="content">
<pre><tt>URL: &lt;url&gt;
Pull: refs/heads/&lt;head&gt;:&lt;remote&gt;</tt></pre>
</div></div>
</div>
<h2>MERGE STRATEGIES</h2>
<div class="sectionbody">
<dl>
<dt>
resolve
</dt>
<dd>
<p>
This can only resolve two heads (i.e. the current branch
and another branch you pulled from) using 3-way merge
algorithm. It tries to carefully detect criss-cross
merge ambiguities and is considered generally safe and
fast.
</p>
</dd>
<dt>
recursive
</dt>
<dd>
<p>
This can only resolve two heads using 3-way merge
algorithm. When there are more than one common
ancestors that can be used for 3-way merge, it creates a
merged tree of the common ancestors and uses that as
the reference tree for the 3-way merge. This has been
reported to result in fewer merge conflicts without
causing mis-merges by tests done on actual merge commits
taken from Linux 2.6 kernel development history.
Additionally this can detect and handle merges involving
renames. This is the default merge strategy when
pulling or merging one branch.
</p>
</dd>
<dt>
octopus
</dt>
<dd>
<p>
This resolves more than two-head case, but refuses to do
complex merge that needs manual resolution. It is
primarily meant to be used for bundling topic branch
heads together. This is the default merge strategy when
pulling or merging more than one branches.
</p>
</dd>
<dt>
ours
</dt>
<dd>
<p>
This resolves any number of heads, but the result of the
merge is always the current branch head. It is meant to
be used to supersede old development history of side
branches.
</p>
</dd>
</dl>
</div>
<h2>EXAMPLES</h2>
<div class="sectionbody">
<dl>
<dt>
git pull, git pull origin
</dt>
<dd>
<p>
Fetch the default head from the repository you cloned
from and merge it into your current branch.
</p>
</dd>
<dt>
git pull -s ours . obsolete
</dt>
<dd>
<p>
Merge local branch <tt>obsolete</tt> into the current branch,
using <tt>ours</tt> merge strategy.
</p>
</dd>
<dt>
git pull . fixes enhancements
</dt>
<dd>
<p>
Bundle local branch <tt>fixes</tt> and <tt>enhancements</tt> on top of
the current branch, making an Octopus merge.
</p>
</dd>
<dt>
git pull --no-commit . maint
</dt>
<dd>
<p>
Merge local branch <tt>maint</tt> into the current branch, but
do not make a commit automatically. This can be used
when you want to include further changes to the merge,
or want to write your own merge commit message.
</p>
<p>You should refrain from abusing this option to sneak substantial
changes into a merge commit. Small fixups like bumping
release/version name would be acceptable.</p>
</dd>
<dt>
Command line pull of multiple branches from one repository
</dt>
<dd>
<div class="listingblock">
<div class="content">
<pre><tt>$ cat .git/remotes/origin
URL: git://git.kernel.org/pub/scm/git/git.git
Pull: master:origin
$ git checkout master
$ git fetch origin master:origin +pu:pu maint:maint
$ git pull . origin</tt></pre>
</div></div>
<p>Here, a typical <tt>.git/remotes/origin</tt> file from a
<tt>git-clone</tt> operation is used in combination with
command line options to <tt>git-fetch</tt> to first update
multiple branches of the local repository and then
to merge the remote <tt>origin</tt> branch into the local
<tt>master</tt> branch. The local <tt>pu</tt> branch is updated
even if it does not result in a fast forward update.
Here, the pull can obtain its objects from the local
repository using <tt>.</tt>, as the previous <tt>git-fetch</tt> is
known to have already obtained and made available
all the necessary objects.</p>
</dd>
<dt>
Pull of multiple branches from one repository using <tt>.git/remotes</tt> file
</dt>
<dd>
<div class="listingblock">
<div class="content">
<pre><tt>$ cat .git/remotes/origin
URL: git://git.kernel.org/pub/scm/git/git.git
Pull: master:origin
Pull: +pu:pu
Pull: maint:maint
$ git checkout master
$ git pull origin</tt></pre>
</div></div>
<p>Here, a typical <tt>.git/remotes/origin</tt> file from a
<tt>git-clone</tt> operation has been hand-modified to include
the branch-mapping of additional remote and local
heads directly. A single <tt>git-pull</tt> operation while
in the <tt>master</tt> branch will fetch multiple heads and
merge the remote <tt>origin</tt> head into the current,
local <tt>master</tt> branch.</p>
</dd>
</dl>
<p>If you tried a pull which resulted in a complex conflicts and
would want to start over, you can recover with
<a href="git-reset.html">git-reset(1)</a>.</p>
</div>
<h2>SEE ALSO</h2>
<div class="sectionbody">
<p><a href="git-fetch.html">git-fetch(1)</a>, <a href="git-merge.html">git-merge(1)</a></p>
</div>
<h2>Author</h2>
<div class="sectionbody">
<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;
and Junio C Hamano &lt;junkio@cox.net&gt;</p>
</div>
<h2>Documentation</h2>
<div class="sectionbody">
<p>Documentation by Jon Loeliger,
David Greaves,
Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
</div>
<h2>GIT</h2>
<div class="sectionbody">
<p>Part of the <a href="git.html">git(7)</a> suite</p>
</div>
<div id="footer">
<div id="footer-text">
Last updated 29-Oct-2006 20:47:12 UTC
</div>
</div>
</body>
</html>