blob: c08ddb54dce8af57ae770572edf281a5c284e372 [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-push(1)</title>
</head>
<body>
<div id="header">
<h1>
git-push(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-push -
Update remote refs along with associated objects
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>git push</em> [--all] [--dry-run] [--tags] [--receive-pack=&lt;git-receive-pack&gt;]
[--repo=all] [-f | --force] [-v | --verbose] [&lt;repository&gt; &lt;refspec&gt;&#8230;]</div></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="para"><p>Updates remote refs using local refs, while sending objects
necessary to complete the given refs.</p></div>
<div class="para"><p>You can make interesting things happen to a repository
every time you push into it, by setting up <em>hooks</em> there. See
documentation for <a href="git-receive-pack.html">git-receive-pack(1)</a>.</p></div>
</div>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
&lt;repository&gt;
</dt>
<dd>
<p>
The "remote" repository that is destination of a push
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><tt>?&lt;src&gt;:&lt;dst&gt;</tt>; that is, an optional plus <tt></tt></tt>, followed
by the source ref, followed by a colon <tt>:</tt>, followed by
the destination ref.
</p>
<div class="para"><p>The &lt;src&gt; side represents the source branch (or arbitrary
"SHA1 expression", such as <tt>master~4</tt> (four parents before the
tip of <tt>master</tt> branch); see <a href="git-rev-parse.html">git-rev-parse(1)</a>) that you
want to push. The &lt;dst&gt; side represents the destination location.</p></div>
<div class="para"><p>The local ref that matches &lt;src&gt; is used
to fast forward the remote ref that matches &lt;dst&gt; (or, if no &lt;dst&gt; was
specified, the same ref that &lt;src&gt; referred to locally). If
the optional leading plus <tt>+</tt> is used, the remote ref is updated
even if it does not result in a fast forward update.</p></div>
<div class="para"><p><tt>tag &lt;tag&gt;</tt> means the same as <tt>refs/tags/&lt;tag&gt;:refs/tags/&lt;tag&gt;</tt>.</p></div>
<div class="para"><p>A parameter &lt;ref&gt; without a colon pushes the &lt;ref&gt; from the source
repository to the destination repository under the same name.</p></div>
<div class="para"><p>Pushing an empty &lt;src&gt; allows you to delete the &lt;dst&gt; ref from
the remote repository.</p></div>
<div class="para"><p>The special refspec <tt>:</tt> (or <tt>+:</tt> to allow non-fast forward updates)
directs git to push "matching" heads: for every head that exists on
the local side, the remote side is updated if a head of the same name
already exists on the remote side. This is the default operation mode
if no explicit refspec is found (that is neither on the command line
nor in any Push line of the corresponding remotes file---see below).</p></div>
</dd>
<dt>
--all
</dt>
<dd>
<p>
Instead of naming each ref to push, specifies that all
refs under <tt>$GIT_DIR/refs/heads/</tt> be pushed.
</p>
</dd>
<dt>
--mirror
</dt>
<dd>
<p>
Instead of naming each ref to push, specifies that all
refs under <tt>$GIT_DIR/refs/</tt> (which includes but is not
limited to <tt>refs/heads/</tt>, <tt>refs/remotes/</tt>, and <tt>refs/tags/</tt>)
be mirrored to the remote repository. Newly created local
refs will be pushed to the remote end, locally updated refs
will be force updated on the remote end, and deleted refs
will be removed from the remote end. This is the default
if the configuration option <tt>remote.&lt;remote&gt;.mirror</tt> is
set.
</p>
</dd>
<dt>
--dry-run
</dt>
<dd>
<p>
Do everything except actually send the updates.
</p>
</dd>
<dt>
--tags
</dt>
<dd>
<p>
All refs under <tt>$GIT_DIR/refs/tags</tt> are pushed, in
addition to refspecs explicitly listed on the command
line.
</p>
</dd>
<dt>
--receive-pack=&lt;git-receive-pack&gt;
</dt>
<dd>
<p>
Path to the <em>git-receive-pack</em> program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
a directory on the default $PATH.
</p>
</dd>
<dt>
--exec=&lt;git-receive-pack&gt;
</dt>
<dd>
<p>
Same as --receive-pack=&lt;git-receive-pack&gt;.
</p>
</dd>
<dt>
-f
</dt>
<dt>
--force
</dt>
<dd>
<p>
Usually, the command refuses to update a remote ref that is
not an ancestor of the local ref used to overwrite it.
This flag disables the check. This can cause the
remote repository to lose commits; use it with care.
</p>
</dd>
<dt>
--repo=&lt;repo&gt;
</dt>
<dd>
<p>
When no repository is specified the command defaults to
"origin"; this overrides it.
</p>
</dd>
<dt>
--thin
</dt>
<dt>
--no-thin
</dt>
<dd>
<p>
These options are passed to <em>git-send-pack</em>. Thin
transfer spends extra cycles to minimize the number of
objects to be sent and meant to be used on slower connection.
</p>
</dd>
<dt>
-v
</dt>
<dt>
--verbose
</dt>
<dd>
<p>
Run verbosely.
</p>
</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="_output">OUTPUT</h2>
<div class="sectionbody">
<div class="para"><p>The output of "git push" depends on the transport method used; this
section describes the output when pushing over the git protocol (either
locally or via ssh).</p></div>
<div class="para"><p>The status of the push is output in tabular form, with each line
representing the status of a single ref. Each line is of the form:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> &lt;flag&gt; &lt;summary&gt; &lt;from&gt; -&gt; &lt;to&gt; (&lt;reason&gt;)</tt></pre>
</div></div>
<div class="vlist"><dl>
<dt>
flag
</dt>
<dd>
<p>
A single character indicating the status of the ref. This is
blank for a successfully pushed ref, <tt>!</tt> for a ref that was
rejected or failed to push, and <em>=</em> for a ref that was up to
date and did not need pushing (note that the status of up to
date refs is shown only when <tt>git push</tt> is running verbosely).
</p>
</dd>
<dt>
summary
</dt>
<dd>
<p>
For a successfully pushed ref, the summary shows the old and new
values of the ref in a form suitable for using as an argument to
<tt>git log</tt> (this is <tt>&lt;old&gt;..&lt;new&gt;</tt> in most cases, and
<tt>&lt;old&gt;&#8230;&lt;new&gt;</tt> for forced non-fast forward updates). For a
failed update, more details are given for the failure.
The string <tt>rejected</tt> indicates that git did not try to send the
ref at all (typically because it is not a fast forward). The
string <tt>remote rejected</tt> indicates that the remote end refused
the update; this rejection is typically caused by a hook on the
remote side. The string <tt>remote failure</tt> indicates that the
remote end did not report the successful update of the ref
(perhaps because of a temporary error on the remote side, a
break in the network connection, or other transient error).
</p>
</dd>
<dt>
from
</dt>
<dd>
<p>
The name of the local ref being pushed, minus its
<tt>refs/&lt;type&gt;/</tt> prefix. In the case of deletion, the
name of the local ref is omitted.
</p>
</dd>
<dt>
to
</dt>
<dd>
<p>
The name of the remote ref being updated, minus its
<tt>refs/&lt;type&gt;/</tt> prefix.
</p>
</dd>
<dt>
reason
</dt>
<dd>
<p>
A human-readable explanation. In the case of successfully pushed
refs, no explanation is needed. For a failed ref, the reason for
failure is described.
</p>
</dd>
</dl></div>
</div>
<h2 id="_examples">Examples</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
git push origin master
</dt>
<dd>
<p>
Find a ref that matches <tt>master</tt> in the source repository
(most likely, it would find <tt>refs/heads/master</tt>), and update
the same ref (e.g. <tt>refs/heads/master</tt>) in <tt>origin</tt> repository
with it. If <tt>master</tt> did not exist remotely, it would be
created.
</p>
</dd>
<dt>
git push origin :experimental
</dt>
<dd>
<p>
Find a ref that matches <tt>experimental</tt> in the <tt>origin</tt> repository
(e.g. <tt>refs/heads/experimental</tt>), and delete it.
</p>
</dd>
<dt>
git push origin master:satellite/master
</dt>
<dd>
<p>
Find a ref that matches <tt>master</tt> in the source repository
(most likely, it would find <tt>refs/heads/master</tt>), and update
the ref that matches <tt>satellite/master</tt> (most likely, it would
be <tt>refs/remotes/satellite/master</tt>) in <tt>origin</tt> repository with it.
</p>
</dd>
<dt>
git push origin master:refs/heads/experimental
</dt>
<dd>
<p>
Create the branch <tt>experimental</tt> in the <tt>origin</tt> repository
by copying the current <tt>master</tt> branch. This form is only
needed to create a new branch or tag in the remote repository when
the local name and the remote name are different; otherwise,
the ref name on its own will work.
</p>
</dd>
</dl></div>
</div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="para"><p>Written by Junio C Hamano &lt;junkio@cox.net&gt;, later rewritten in C
by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="para"><p>Documentation by 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-07-06 05:16:57 UTC
</div>
</div>
</body>
</html>