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