git-quiltimport: preserve standard input to be able to read user input
[git/git.git] / Documentation / git-push.txt
CommitLineData
215a7ad1
JH
1git-push(1)
2===========
7fc9d69f
JH
3
4NAME
5----
7bd7f280 6git-push - Update remote refs along with associated objects
7fc9d69f
JH
7
8
9SYNOPSIS
10--------
97925fde 11[verse]
bed5122f 12'git push' [--all | --mirror | --tags] [--dry-run] [--receive-pack=<git-receive-pack>]
bf07cc58 13 [--repo=<repository>] [-f | --force] [-v | --verbose]
2c9693bd 14 [<repository> <refspec>...]
7fc9d69f
JH
15
16DESCRIPTION
17-----------
ab9b3138
JH
18
19Updates remote refs using local refs, while sending objects
20necessary to complete the given refs.
7fc9d69f 21
cc55aaec 22You can make interesting things happen to a repository
eb0362a4 23every time you push into it, by setting up 'hooks' there. See
5162e697 24documentation for linkgit:git-receive-pack[1].
eb0362a4 25
7fc9d69f
JH
26
27OPTIONS
28-------
3598a308 29<repository>::
85a97d4e 30 The "remote" repository that is destination of a push
98347fee
AM
31 operation. This parameter can be either a URL
32 (see the section <<URLS,GIT URLS>> below) or the name
33 of a remote (see the section <<REMOTES,REMOTES>> below).
3598a308 34
2c9693bd 35<refspec>...::
7a0d911f
JH
36 The format of a <refspec> parameter is an optional plus
37 `{plus}`, followed by the source ref <src>, followed
38 by a colon `:`, followed by the destination ref <dst>.
39 It is used to specify with what <src> object the <dst> ref
40 in the remote repository is to be updated.
3598a308 41+
80391846
AM
42The <src> is often the name of the branch you would want to push, but
43it can be any arbitrary "SHA-1 expression", such as `master~4` or
44`HEAD` (see linkgit:git-rev-parse[1]).
3598a308 45+
80391846
AM
46The <dst> tells which ref on the remote side is updated with this
47push. Arbitrary expressions cannot be used here, an actual ref must
48be named. If `:`<dst> is omitted, the same ref as <src> will be
49updated.
3598a308 50+
80391846
AM
51The object referenced by <src> is used to fast forward the ref <dst>
52on the remote side. If the optional leading plus `{plus}` is used, the
53remote ref is updated even if it does not result in a fast forward
54update.
3598a308 55+
80391846 56`tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
25fb6290
JH
57+
58Pushing an empty <src> allows you to delete the <dst> ref from
59the remote repository.
a83619d6
PB
60+
61The special refspec `:` (or `+:` to allow non-fast forward updates)
89edd5a9
AM
62directs git to push "matching" branches: for every branch that exists on
63the local side, the remote side is updated if a branch of the same name
a83619d6
PB
64already exists on the remote side. This is the default operation mode
65if no explicit refspec is found (that is neither on the command line
66nor in any Push line of the corresponding remotes file---see below).
7fc9d69f 67
3240240f 68--all::
cc55aaec 69 Instead of naming each ref to push, specifies that all
5c633a4c 70 refs under `$GIT_DIR/refs/heads/` be pushed.
d6a73596 71
3240240f 72--mirror::
ff206748 73 Instead of naming each ref to push, specifies that all
73f03627
SP
74 refs under `$GIT_DIR/refs/` (which includes but is not
75 limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
ff206748
AW
76 be mirrored to the remote repository. Newly created local
77 refs will be pushed to the remote end, locally updated refs
78 will be force updated on the remote end, and deleted refs
84bb2dfd
PB
79 will be removed from the remote end. This is the default
80 if the configuration option `remote.<remote>.mirror` is
81 set.
ff206748 82
3240240f 83--dry-run::
11f2441f
BE
84 Do everything except actually send the updates.
85
3240240f 86--tags::
42301e34
JH
87 All refs under `$GIT_DIR/refs/tags` are pushed, in
88 addition to refspecs explicitly listed on the command
89 line.
90
3240240f 91--receive-pack=<git-receive-pack>::
4fc988ef 92--exec=<git-receive-pack>::
ba020ef5 93 Path to the 'git-receive-pack' program on the remote
5214f770
UKK
94 end. Sometimes useful when pushing to a remote
95 repository over ssh, and you do not have the program in
96 a directory on the default $PATH.
97
3240240f
SB
98-f::
99--force::
f0fff36e 100 Usually, the command refuses to update a remote ref that is
64a476e6 101 not an ancestor of the local ref used to overwrite it.
f0fff36e
BF
102 This flag disables the check. This can cause the
103 remote repository to lose commits; use it with care.
7fc9d69f 104
bf07cc58
JS
105--repo=<repository>::
106 This option is only relevant if no <repository> argument is
107 passed in the invocation. In this case, 'git-push' derives the
108 remote name from the current branch: If it tracks a remote
109 branch, then that remote repository is pushed to. Otherwise,
110 the name "origin" is used. For this latter case, this option
111 can be used to override the name "origin". In other words,
112 the difference between these two commands
113+
114--------------------------
115git push public #1
116git push --repo=public #2
117--------------------------
118+
119is that #1 always pushes to "public" whereas #2 pushes to "public"
120only if the current branch does not track a remote branch. This is
121useful if you write an alias or script around 'git-push'.
dc36f265 122
3240240f
SB
123--thin::
124--no-thin::
ba020ef5 125 These options are passed to 'git-send-pack'. Thin
dc36f265
JH
126 transfer spends extra cycles to minimize the number of
127 objects to be sent and meant to be used on slower connection.
128
3240240f
SB
129-v::
130--verbose::
dc36f265
JH
131 Run verbosely.
132
37ba0561 133include::urls-remotes.txt[]
eb0362a4 134
066a5268
JK
135OUTPUT
136------
137
138The output of "git push" depends on the transport method used; this
139section describes the output when pushing over the git protocol (either
140locally or via ssh).
141
142The status of the push is output in tabular form, with each line
143representing the status of a single ref. Each line is of the form:
144
145-------------------------------
146 <flag> <summary> <from> -> <to> (<reason>)
147-------------------------------
148
149flag::
150 A single character indicating the status of the ref. This is
151 blank for a successfully pushed ref, `!` for a ref that was
152 rejected or failed to push, and '=' for a ref that was up to
153 date and did not need pushing (note that the status of up to
154 date refs is shown only when `git push` is running verbosely).
155
156summary::
157 For a successfully pushed ref, the summary shows the old and new
158 values of the ref in a form suitable for using as an argument to
159 `git log` (this is `<old>..<new>` in most cases, and
160 `<old>...<new>` for forced non-fast forward updates). For a
161 failed update, more details are given for the failure.
162 The string `rejected` indicates that git did not try to send the
163 ref at all (typically because it is not a fast forward). The
164 string `remote rejected` indicates that the remote end refused
165 the update; this rejection is typically caused by a hook on the
166 remote side. The string `remote failure` indicates that the
167 remote end did not report the successful update of the ref
168 (perhaps because of a temporary error on the remote side, a
169 break in the network connection, or other transient error).
170
171from::
172 The name of the local ref being pushed, minus its
173 `refs/<type>/` prefix. In the case of deletion, the
174 name of the local ref is omitted.
175
176to::
177 The name of the remote ref being updated, minus its
178 `refs/<type>/` prefix.
179
180reason::
181 A human-readable explanation. In the case of successfully pushed
182 refs, no explanation is needed. For a failed ref, the reason for
183 failure is described.
bb9fca80
JH
184
185Examples
186--------
187
188git push origin master::
189 Find a ref that matches `master` in the source repository
190 (most likely, it would find `refs/heads/master`), and update
191 the same ref (e.g. `refs/heads/master`) in `origin` repository
491b1b11
SV
192 with it. If `master` did not exist remotely, it would be
193 created.
bb9fca80 194
17507832
AM
195git push origin HEAD::
196 A handy way to push the current branch to the same name on the
197 remote.
bb9fca80 198
2c9693bd
AMS
199git push origin master:satellite/master dev:satellite/dev::
200 Use the source ref that matches `master` (e.g. `refs/heads/master`)
201 to update the ref that matches `satellite/master` (most probably
202 `refs/remotes/satellite/master`) in the `origin` repository, then
203 do the same for `dev` and `satellite/dev`.
bb9fca80 204
17507832
AM
205git push origin HEAD:master::
206 Push the current branch to the remote ref matching `master` in the
207 `origin` repository. This form is convenient to push the current
208 branch without thinking about its local name.
209
4e560158
SP
210git push origin master:refs/heads/experimental::
211 Create the branch `experimental` in the `origin` repository
491b1b11
SV
212 by copying the current `master` branch. This form is only
213 needed to create a new branch or tag in the remote repository when
214 the local name and the remote name are different; otherwise,
215 the ref name on its own will work.
4e560158 216
17507832
AM
217git push origin :experimental::
218 Find a ref that matches `experimental` in the `origin` repository
219 (e.g. `refs/heads/experimental`), and delete it.
220
221
7fc9d69f
JH
222Author
223------
59eb68aa 224Written by Junio C Hamano <gitster@pobox.com>, later rewritten in C
25fb6290 225by Linus Torvalds <torvalds@osdl.org>
7fc9d69f
JH
226
227Documentation
228--------------
229Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
230
231GIT
232---
9e1f0a85 233Part of the linkgit:git[1] suite