Google Git
Sign in
chromium / external / gitster / git-htmldocs / f9e04eb9a776f91e487bc56bd35c2d6cff4a4cc3 / . / git-fetch.html
blob: 10a5b6a0a5ea06db53c7d90cf1ee088721a9f603 [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 8.2.5" />
<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;
text-decoration: underline;
}
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, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
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.1em;
}
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 {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
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;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
include1::./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;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>git-fetch(1)</title>
</head>
<body>
<div id="header">
<h1>
git-fetch(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-fetch -
Download objects and refs from another repository
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="para"><p><em>git fetch</em> &lt;options&gt; &lt;repository&gt; &lt;refspec&gt;&#8230;</p></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="para"><p>Fetches named heads or tags from another repository, along with
the objects necessary to complete them.</p></div>
<div class="para"><p>The ref names and their object names of fetched refs are stored
in <tt>.git/FETCH_HEAD</tt>. This information is left for a later merge
operation done by <em>git-merge</em>.</p></div>
<div class="para"><p>When &lt;refspec&gt; stores the fetched result in tracking branches,
the tags that point at these branches are automatically
followed. This is done by first fetching from the remote using
the given &lt;refspec&gt;s, and if the repository has objects that are
pointed by remote tags that it does not yet have, then fetch
those missing tags. If the other end has tags that point at
branches you are not interested in, you will not get them.</p></div>
</div>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
-q
</dt>
<dt>
--quiet
</dt>
<dd>
<p>
Pass --quiet to git-fetch-pack and silence any other internally
used programs.
</p>
</dd>
<dt>
-v
</dt>
<dt>
--verbose
</dt>
<dd>
<p>
Be verbose.
</p>
</dd>
<dt>
-a
</dt>
<dt>
--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
</dt>
<dt>
--force
</dt>
<dd>
<p>
When <em>git-fetch</em> 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>
-n
</dt>
<dt>
--no-tags
</dt>
<dd>
<p>
By default, tags that point at objects that are downloaded
from the remote repository are fetched and stored locally.
This option disables this automatic tag following.
</p>
</dd>
<dt>
-t
</dt>
<dt>
--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
</dt>
<dt>
--keep
</dt>
<dd>
<p>
Keep downloaded pack.
</p>
</dd>
<dt>
-u
</dt>
<dt>
--update-head-ok
</dt>
<dd>
<p>
By default <em>git-fetch</em> refuses to update the head which
corresponds to the current branch. This flag disables the
check. This is purely for the internal use for <em>git-pull</em>
to communicate with <em>git-fetch</em>, and unless you are
implementing your own Porcelain you are not supposed to
use it.
</p>
</dd>
<dt>
--depth=&lt;depth&gt;
</dt>
<dd>
<p>
Deepen the history of a <em>shallow</em> repository created by
<tt>git clone</tt> with <tt>--depth=&lt;depth&gt;</tt> option (see <a href="git-clone.html">git-clone(1)</a>)
by the specified number of commits.
</p>
</dd>
<dt>
&lt;repository&gt;
</dt>
<dd>
<p>
The "remote" repository that is the source of a fetch
or pull operation. This parameter can be either a URL
(see the section <a href="#URLS">GIT URLS</a> below) or the name
of a remote (see the section <a href="#REMOTES">REMOTES</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>&#43;</tt>, followed
by the source ref, followed by a colon <tt>:</tt>, followed by
the destination ref.
</p>
<div class="para"><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>
<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 <em>git-fetch</em>. 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.</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 <em>git-pull</em> command line and having multiple
<tt>Pull:</tt> &lt;refspec&gt; lines for a &lt;repository&gt; and running
<em>git-pull</em> 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 <em>git-pull</em> 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>
<div class="para"><p>Some short-cut notations are also supported.</p></div>
<div class="ilist"><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></div>
</dd>
</dl></div>
</div>
<h2 id="_git_urls_a_id_urls_a">GIT URLS<a id="URLS"></a></h2>
<div class="sectionbody">
<div class="para"><p>One of the following notations can be used
to name the remote repository:</p></div>
<div class="exampleblock">
<div class="exampleblock-content">
<div class="ilist"><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&#91;:port&#93;/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></div>
<div class="para"><p>SSH is the default transport protocol over the network. 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, but
only the former supports port specification. The following
three are identical to the last three above, respectively:</p></div>
<div class="exampleblock">
<div class="exampleblock-content">
<div class="ilist"><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></div>
<div class="para"><p>To sync with a local directory, you can use:</p></div>
<div class="exampleblock">
<div class="exampleblock-content">
<div class="ilist"><ul>
<li>
<p>
/path/to/repo.git/
</p>
</li>
<li>
<p>
file:///path/to/repo.git/
</p>
</li>
</ul></div>
</div></div>
<div class="para"><p>They are mostly equivalent, except when cloning. See
<a href="git-clone.html">git-clone(1)</a> for details.</p></div>
<div class="para"><p>If there are a large number of similarly-named remote repositories and
you want to use a different format for them (such that the URLs you
use will be rewritten into URLs that work), you can create a
configuration section of the form:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> [url "&lt;actual url base&gt;"]
insteadOf = &lt;other url base&gt;</tt></pre>
</div></div>
<div class="para"><p>For example, with this:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> [url "git://git.host.xz/"]
insteadOf = host.xz:/path/to/
insteadOf = work:</tt></pre>
</div></div>
<div class="para"><p>a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be
rewritten in any context that takes a URL to be "git://git.host.xz/repo.git".</p></div>
</div>
<h2 id="_remotes_a_id_remotes_a">REMOTES<a id="REMOTES"></a></h2>
<div class="sectionbody">
<div class="para"><p>The name of one of the following can be used instead
of a URL as <tt>&lt;repository&gt;</tt> argument:</p></div>
<div class="ilist"><ul>
<li>
<p>
a remote in the git configuration file: <tt>$GIT_DIR/config</tt>,
</p>
</li>
<li>
<p>
a file in the <tt>$GIT_DIR/remotes</tt> directory, or
</p>
</li>
<li>
<p>
a file in the <tt>$GIT_DIR/branches</tt> directory.
</p>
</li>
</ul></div>
<div class="para"><p>All of these also allow you to omit the refspec from the command line
because they each contain a refspec which git will use by default.</p></div>
<h3 id="_named_remote_in_configuration_file">Named remote in configuration file</h3><div style="clear:left"></div>
<div class="para"><p>You can choose to provide the name of a remote which you had previously
configured using <a href="git-remote.html">git-remote(1)</a>, <a href="git-config.html">git-config(1)</a>
or even by a manual edit to the <tt>$GIT_DIR/config</tt> file. The URL of
this remote will be used to access the repository. The refspec
of this remote will be used by default when you do
not provide a refspec on the command line. The entry in the
config file would appear like this:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> [remote "&lt;name&gt;"]
url = &lt;url&gt;
push = &lt;refspec&gt;
fetch = &lt;refspec&gt;</tt></pre>
</div></div>
<h3 id="_named_file_in_tt_git_dir_remotes_tt">Named file in <tt>$GIT_DIR/remotes</tt></h3><div style="clear:left"></div>
<div class="para"><p>You can choose to provide the name of a
file in <tt>$GIT_DIR/remotes</tt>. The URL
in this file will be used to access the repository. The refspec
in this file will be used as default when you do not
provide a refspec on the command line. This file should have the
following format:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> URL: one of the above URL format
Push: &lt;refspec&gt;
Pull: &lt;refspec&gt;
</tt></pre>
</div></div>
<div class="para"><p><tt>Push:</tt> lines are used by <em>git-push</em> and
<tt>Pull:</tt> lines are used by <em>git-pull</em> and <em>git-fetch</em>.
Multiple <tt>Push:</tt> and <tt>Pull:</tt> lines may
be specified for additional branch mappings.</p></div>
<h3 id="_named_file_in_tt_git_dir_branches_tt">Named file in <tt>$GIT_DIR/branches</tt></h3><div style="clear:left"></div>
<div class="para"><p>You can choose to provide the name of a
file in <tt>$GIT_DIR/branches</tt>.
The URL in this file will be used to access the repository.
This file should have the following format:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> &lt;url&gt;#&lt;head&gt;</tt></pre>
</div></div>
<div class="para"><p><tt>&lt;url&gt;</tt> is required; <tt>#&lt;head&gt;</tt> is optional.
When you do not provide a refspec on the command line,
git will use the following refspec, where <tt>&lt;head&gt;</tt> defaults to <tt>master</tt>,
and <tt>&lt;repository&gt;</tt> is the name of this file
you provided in the command line.</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> refs/heads/&lt;head&gt;:&lt;repository&gt;</tt></pre>
</div></div>
</div>
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="para"><p><a href="git-pull.html">git-pull(1)</a></p></div>
</div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and
Junio C Hamano &lt;gitster@pobox.com&gt;</p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
</div>
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2008-08-10 03:55:18 UTC
</div>
</div>
</body>
</html>