]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-push(1) |
2 | =========== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
7bd7f280 | 6 | git-push - Update remote refs along with associated objects |
7fc9d69f JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
97925fde | 11 | [verse] |
9f67fee2 | 12 | 'git push' [--all | --mirror | --tags] [-n | --dry-run] [--receive-pack=<git-receive-pack>] |
6ddba5e2 | 13 | [--repo=<repository>] [-f | --force] [--prune] [-v | --verbose] [-u | --set-upstream] |
e3163c75 | 14 | [<repository> [<refspec>...]] |
7fc9d69f JH |
15 | |
16 | DESCRIPTION | |
17 | ----------- | |
ab9b3138 JH |
18 | |
19 | Updates remote refs using local refs, while sending objects | |
20 | necessary to complete the given refs. | |
7fc9d69f | 21 | |
cc55aaec | 22 | You can make interesting things happen to a repository |
eb0362a4 | 23 | every time you push into it, by setting up 'hooks' there. See |
5162e697 | 24 | documentation for linkgit:git-receive-pack[1]. |
eb0362a4 | 25 | |
7fc9d69f | 26 | |
d6aba61f CJ |
27 | OPTIONS[[OPTIONS]] |
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 | 36 | The format of a <refspec> parameter is an optional plus |
6cf378f0 | 37 | `+`, followed by the source ref <src>, followed |
7a0d911f JH |
38 | by a colon `:`, followed by the destination ref <dst>. |
39 | It is used to specify with what <src> object the <dst> ref | |
1ec6f488 RR |
40 | in the remote repository is to be updated. If not specified, |
41 | the behavior of the command is controlled by the `push.default` | |
42 | configuration variable. | |
3598a308 | 43 | + |
80391846 AM |
44 | The <src> is often the name of the branch you would want to push, but |
45 | it can be any arbitrary "SHA-1 expression", such as `master~4` or | |
9d83e382 | 46 | `HEAD` (see linkgit:gitrevisions[7]). |
3598a308 | 47 | + |
80391846 AM |
48 | The <dst> tells which ref on the remote side is updated with this |
49 | push. Arbitrary expressions cannot be used here, an actual ref must | |
50 | be named. If `:`<dst> is omitted, the same ref as <src> will be | |
51 | updated. | |
3598a308 | 52 | + |
149f6ddf MB |
53 | The object referenced by <src> is used to update the <dst> reference |
54 | on the remote side, but by default this is only allowed if the | |
6cf378f0 | 55 | update can fast-forward <dst>. By having the optional leading `+`, |
149f6ddf | 56 | you can tell git to update the <dst> ref even when the update is not a |
a75d7b54 | 57 | fast-forward. This does *not* attempt to merge <src> into <dst>. See |
149f6ddf | 58 | EXAMPLES below for details. |
3598a308 | 59 | + |
80391846 | 60 | `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`. |
25fb6290 JH |
61 | + |
62 | Pushing an empty <src> allows you to delete the <dst> ref from | |
63 | the remote repository. | |
a83619d6 | 64 | + |
6cf378f0 | 65 | The special refspec `:` (or `+:` to allow non-fast-forward updates) |
89edd5a9 AM |
66 | directs git to push "matching" branches: for every branch that exists on |
67 | the local side, the remote side is updated if a branch of the same name | |
a83619d6 PB |
68 | already exists on the remote side. This is the default operation mode |
69 | if no explicit refspec is found (that is neither on the command line | |
1ec6f488 RR |
70 | nor in any Push line of the corresponding remotes file---see below) and |
71 | no `push.default` configuration variable is set. | |
7fc9d69f | 72 | |
3240240f | 73 | --all:: |
cc55aaec | 74 | Instead of naming each ref to push, specifies that all |
cc1b8d8b | 75 | refs under `refs/heads/` be pushed. |
d6a73596 | 76 | |
6ddba5e2 FC |
77 | --prune:: |
78 | Remove remote branches that don't have a local counterpart. For example | |
79 | a remote branch `tmp` will be removed if a local branch with the same | |
80 | name doesn't exist any more. This also respects refspecs, e.g. | |
6cf378f0 | 81 | `git push --prune remote refs/heads/*:refs/tmp/*` would |
6ddba5e2 FC |
82 | make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo` |
83 | doesn't exist. | |
84 | ||
3240240f | 85 | --mirror:: |
ff206748 | 86 | Instead of naming each ref to push, specifies that all |
cc1b8d8b | 87 | refs under `refs/` (which includes but is not |
73f03627 | 88 | limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`) |
ff206748 AW |
89 | be mirrored to the remote repository. Newly created local |
90 | refs will be pushed to the remote end, locally updated refs | |
91 | will be force updated on the remote end, and deleted refs | |
84bb2dfd PB |
92 | will be removed from the remote end. This is the default |
93 | if the configuration option `remote.<remote>.mirror` is | |
94 | set. | |
ff206748 | 95 | |
9f67fee2 | 96 | -n:: |
3240240f | 97 | --dry-run:: |
11f2441f BE |
98 | Do everything except actually send the updates. |
99 | ||
1965ff74 LA |
100 | --porcelain:: |
101 | Produce machine-readable output. The output status line for each ref | |
102 | will be tab-separated and sent to stdout instead of stderr. The full | |
103 | symbolic names of the refs will be given. | |
104 | ||
f517f1f2 JK |
105 | --delete:: |
106 | All listed refs are deleted from the remote repository. This is | |
107 | the same as prefixing all refs with a colon. | |
108 | ||
3240240f | 109 | --tags:: |
cc1b8d8b | 110 | All refs under `refs/tags` are pushed, in |
42301e34 JH |
111 | addition to refspecs explicitly listed on the command |
112 | line. | |
113 | ||
3240240f | 114 | --receive-pack=<git-receive-pack>:: |
4fc988ef | 115 | --exec=<git-receive-pack>:: |
ba020ef5 | 116 | Path to the 'git-receive-pack' program on the remote |
5214f770 UKK |
117 | end. Sometimes useful when pushing to a remote |
118 | repository over ssh, and you do not have the program in | |
119 | a directory on the default $PATH. | |
120 | ||
3240240f SB |
121 | -f:: |
122 | --force:: | |
f0fff36e | 123 | Usually, the command refuses to update a remote ref that is |
64a476e6 | 124 | not an ancestor of the local ref used to overwrite it. |
f0fff36e BF |
125 | This flag disables the check. This can cause the |
126 | remote repository to lose commits; use it with care. | |
7fc9d69f | 127 | |
bf07cc58 JS |
128 | --repo=<repository>:: |
129 | This option is only relevant if no <repository> argument is | |
0b444cdb | 130 | passed in the invocation. In this case, 'git push' derives the |
bf07cc58 JS |
131 | remote name from the current branch: If it tracks a remote |
132 | branch, then that remote repository is pushed to. Otherwise, | |
133 | the name "origin" is used. For this latter case, this option | |
134 | can be used to override the name "origin". In other words, | |
135 | the difference between these two commands | |
136 | + | |
137 | -------------------------- | |
138 | git push public #1 | |
139 | git push --repo=public #2 | |
140 | -------------------------- | |
141 | + | |
142 | is that #1 always pushes to "public" whereas #2 pushes to "public" | |
143 | only if the current branch does not track a remote branch. This is | |
0b444cdb | 144 | useful if you write an alias or script around 'git push'. |
dc36f265 | 145 | |
0ed3a111 TR |
146 | -u:: |
147 | --set-upstream:: | |
148 | For every branch that is up to date or successfully pushed, add | |
149 | upstream (tracking) reference, used by argument-less | |
150 | linkgit:git-pull[1] and other commands. For more information, | |
151 | see 'branch.<name>.merge' in linkgit:git-config[1]. | |
152 | ||
3240240f SB |
153 | --thin:: |
154 | --no-thin:: | |
738820a9 SB |
155 | These options are passed to linkgit:git-send-pack[1]. A thin transfer |
156 | significantly reduces the amount of sent data when the sender and | |
157 | receiver share many of the same objects in common. The default is | |
158 | \--thin. | |
dc36f265 | 159 | |
989119d9 JK |
160 | -q:: |
161 | --quiet:: | |
162 | Suppress all output, including the listing of updated refs, | |
78381069 TRC |
163 | unless an error occurs. Progress is not reported to the standard |
164 | error stream. | |
989119d9 | 165 | |
3240240f SB |
166 | -v:: |
167 | --verbose:: | |
dc36f265 JH |
168 | Run verbosely. |
169 | ||
78381069 TRC |
170 | --progress:: |
171 | Progress status is reported on the standard error stream | |
172 | by default when it is attached to a terminal, unless -q | |
173 | is specified. This flag forces progress status even if the | |
174 | standard error stream is not directed to a terminal. | |
989119d9 | 175 | |
eb21c732 HV |
176 | --recurse-submodules=check|on-demand:: |
177 | Make sure all submodule commits used by the revisions to be | |
a6d3bde5 | 178 | pushed are available on a remote-tracking branch. If 'check' is |
eb21c732 HV |
179 | used git will verify that all submodule commits that changed in |
180 | the revisions to be pushed are available on at least one remote | |
181 | of the submodule. If any commits are missing the push will be | |
182 | aborted and exit with non-zero status. If 'on-demand' is used | |
183 | all submodules that changed in the revisions to be pushed will | |
184 | be pushed. If on-demand was not able to push all necessary | |
185 | revisions it will also be aborted and exit with non-zero status. | |
d2b17b32 FG |
186 | |
187 | ||
37ba0561 | 188 | include::urls-remotes.txt[] |
eb0362a4 | 189 | |
066a5268 JK |
190 | OUTPUT |
191 | ------ | |
192 | ||
193 | The output of "git push" depends on the transport method used; this | |
194 | section describes the output when pushing over the git protocol (either | |
195 | locally or via ssh). | |
196 | ||
197 | The status of the push is output in tabular form, with each line | |
198 | representing the status of a single ref. Each line is of the form: | |
199 | ||
200 | ------------------------------- | |
201 | <flag> <summary> <from> -> <to> (<reason>) | |
202 | ------------------------------- | |
203 | ||
1965ff74 LA |
204 | If --porcelain is used, then each line of the output is of the form: |
205 | ||
206 | ------------------------------- | |
207 | <flag> \t <from>:<to> \t <summary> (<reason>) | |
208 | ------------------------------- | |
209 | ||
b7047abc JH |
210 | The status of up-to-date refs is shown only if --porcelain or --verbose |
211 | option is used. | |
212 | ||
066a5268 | 213 | flag:: |
b7047abc JH |
214 | A single character indicating the status of the ref: |
215 | (space);; for a successfully pushed fast-forward; | |
6cf378f0 | 216 | `+`;; for a successful forced update; |
b7047abc JH |
217 | `-`;; for a successfully deleted ref; |
218 | `*`;; for a successfully pushed new ref; | |
219 | `!`;; for a ref that was rejected or failed to push; and | |
220 | `=`;; for a ref that was up to date and did not need pushing. | |
066a5268 JK |
221 | |
222 | summary:: | |
223 | For a successfully pushed ref, the summary shows the old and new | |
224 | values of the ref in a form suitable for using as an argument to | |
225 | `git log` (this is `<old>..<new>` in most cases, and | |
6cf378f0 | 226 | `<old>...<new>` for forced non-fast-forward updates). |
9a9fb5d3 TR |
227 | + |
228 | For a failed update, more details are given: | |
229 | + | |
230 | -- | |
231 | rejected:: | |
232 | Git did not try to send the ref at all, typically because it | |
233 | is not a fast-forward and you did not force the update. | |
234 | ||
235 | remote rejected:: | |
236 | The remote end refused the update. Usually caused by a hook | |
237 | on the remote side, or because the remote repository has one | |
238 | of the following safety options in effect: | |
239 | `receive.denyCurrentBranch` (for pushes to the checked out | |
240 | branch), `receive.denyNonFastForwards` (for forced | |
241 | non-fast-forward updates), `receive.denyDeletes` or | |
242 | `receive.denyDeleteCurrent`. See linkgit:git-config[1]. | |
243 | ||
244 | remote failure:: | |
245 | The remote end did not report the successful update of the ref, | |
246 | perhaps because of a temporary error on the remote side, a | |
247 | break in the network connection, or other transient error. | |
248 | -- | |
066a5268 JK |
249 | |
250 | from:: | |
251 | The name of the local ref being pushed, minus its | |
252 | `refs/<type>/` prefix. In the case of deletion, the | |
253 | name of the local ref is omitted. | |
254 | ||
255 | to:: | |
256 | The name of the remote ref being updated, minus its | |
257 | `refs/<type>/` prefix. | |
258 | ||
259 | reason:: | |
260 | A human-readable explanation. In the case of successfully pushed | |
261 | refs, no explanation is needed. For a failed ref, the reason for | |
262 | failure is described. | |
bb9fca80 | 263 | |
07436e43 MM |
264 | Note about fast-forwards |
265 | ------------------------ | |
266 | ||
267 | When an update changes a branch (or more in general, a ref) that used to | |
268 | point at commit A to point at another commit B, it is called a | |
269 | fast-forward update if and only if B is a descendant of A. | |
270 | ||
271 | In a fast-forward update from A to B, the set of commits that the original | |
272 | commit A built on top of is a subset of the commits the new commit B | |
273 | builds on top of. Hence, it does not lose any history. | |
274 | ||
275 | In contrast, a non-fast-forward update will lose history. For example, | |
276 | suppose you and somebody else started at the same commit X, and you built | |
277 | a history leading to commit B while the other person built a history | |
278 | leading to commit A. The history looks like this: | |
279 | ||
280 | ---------------- | |
281 | ||
282 | B | |
283 | / | |
284 | ---X---A | |
285 | ||
286 | ---------------- | |
287 | ||
288 | Further suppose that the other person already pushed changes leading to A | |
289 | back to the original repository you two obtained the original commit X. | |
290 | ||
291 | The push done by the other person updated the branch that used to point at | |
292 | commit X to point at commit A. It is a fast-forward. | |
293 | ||
294 | But if you try to push, you will attempt to update the branch (that | |
295 | now points at A) with commit B. This does _not_ fast-forward. If you did | |
296 | so, the changes introduced by commit A will be lost, because everybody | |
297 | will now start building on top of B. | |
298 | ||
299 | The command by default does not allow an update that is not a fast-forward | |
300 | to prevent such loss of history. | |
301 | ||
302 | If you do not want to lose your work (history from X to B) nor the work by | |
303 | the other person (history from X to A), you would need to first fetch the | |
304 | history from the repository, create a history that contains changes done | |
305 | by both parties, and push the result back. | |
306 | ||
307 | You can perform "git pull", resolve potential conflicts, and "git push" | |
308 | the result. A "git pull" will create a merge commit C between commits A | |
309 | and B. | |
310 | ||
311 | ---------------- | |
312 | ||
313 | B---C | |
314 | / / | |
315 | ---X---A | |
316 | ||
317 | ---------------- | |
318 | ||
319 | Updating A with the resulting merge commit will fast-forward and your | |
320 | push will be accepted. | |
321 | ||
322 | Alternatively, you can rebase your change between X and B on top of A, | |
323 | with "git pull --rebase", and push the result back. The rebase will | |
324 | create a new commit D that builds the change between X and B on top of | |
325 | A. | |
326 | ||
327 | ---------------- | |
328 | ||
329 | B D | |
330 | / / | |
331 | ---X---A | |
332 | ||
333 | ---------------- | |
334 | ||
335 | Again, updating A with this commit will fast-forward and your push will be | |
336 | accepted. | |
337 | ||
338 | There is another common situation where you may encounter non-fast-forward | |
339 | rejection when you try to push, and it is possible even when you are | |
340 | pushing into a repository nobody else pushes into. After you push commit | |
341 | A yourself (in the first picture in this section), replace it with "git | |
342 | commit --amend" to produce commit B, and you try to push it out, because | |
343 | forgot that you have pushed A out already. In such a case, and only if | |
344 | you are certain that nobody in the meantime fetched your earlier commit A | |
345 | (and started building on top of it), you can run "git push --force" to | |
346 | overwrite it. In other words, "git push --force" is a method reserved for | |
347 | a case where you do mean to lose history. | |
348 | ||
349 | ||
bb9fca80 JH |
350 | Examples |
351 | -------- | |
352 | ||
5d2fc913 | 353 | `git push`:: |
d6aba61f CJ |
354 | Works like `git push <remote>`, where <remote> is the |
355 | current branch's remote (or `origin`, if no remote is | |
356 | configured for the current branch). | |
357 | ||
5d2fc913 | 358 | `git push origin`:: |
d6aba61f CJ |
359 | Without additional configuration, works like |
360 | `git push origin :`. | |
361 | + | |
362 | The default behavior of this command when no <refspec> is given can be | |
1ec6f488 RR |
363 | configured by setting the `push` option of the remote, or the `push.default` |
364 | configuration variable. | |
d6aba61f CJ |
365 | + |
366 | For example, to default to pushing only the current branch to `origin` | |
367 | use `git config remote.origin.push HEAD`. Any valid <refspec> (like | |
368 | the ones in the examples below) can be configured as the default for | |
369 | `git push origin`. | |
370 | ||
5d2fc913 | 371 | `git push origin :`:: |
d6aba61f CJ |
372 | Push "matching" branches to `origin`. See |
373 | <refspec> in the <<OPTIONS,OPTIONS>> section above for a | |
374 | description of "matching" branches. | |
375 | ||
5d2fc913 | 376 | `git push origin master`:: |
bb9fca80 JH |
377 | Find a ref that matches `master` in the source repository |
378 | (most likely, it would find `refs/heads/master`), and update | |
379 | the same ref (e.g. `refs/heads/master`) in `origin` repository | |
491b1b11 SV |
380 | with it. If `master` did not exist remotely, it would be |
381 | created. | |
bb9fca80 | 382 | |
5d2fc913 | 383 | `git push origin HEAD`:: |
17507832 AM |
384 | A handy way to push the current branch to the same name on the |
385 | remote. | |
bb9fca80 | 386 | |
5d2fc913 | 387 | `git push origin master:satellite/master dev:satellite/dev`:: |
2c9693bd AMS |
388 | Use the source ref that matches `master` (e.g. `refs/heads/master`) |
389 | to update the ref that matches `satellite/master` (most probably | |
390 | `refs/remotes/satellite/master`) in the `origin` repository, then | |
391 | do the same for `dev` and `satellite/dev`. | |
bb9fca80 | 392 | |
5d2fc913 | 393 | `git push origin HEAD:master`:: |
17507832 AM |
394 | Push the current branch to the remote ref matching `master` in the |
395 | `origin` repository. This form is convenient to push the current | |
396 | branch without thinking about its local name. | |
397 | ||
5d2fc913 | 398 | `git push origin master:refs/heads/experimental`:: |
4e560158 | 399 | Create the branch `experimental` in the `origin` repository |
491b1b11 SV |
400 | by copying the current `master` branch. This form is only |
401 | needed to create a new branch or tag in the remote repository when | |
402 | the local name and the remote name are different; otherwise, | |
403 | the ref name on its own will work. | |
4e560158 | 404 | |
5d2fc913 | 405 | `git push origin :experimental`:: |
17507832 AM |
406 | Find a ref that matches `experimental` in the `origin` repository |
407 | (e.g. `refs/heads/experimental`), and delete it. | |
408 | ||
6cf378f0 | 409 | `git push origin +dev:master`:: |
149f6ddf | 410 | Update the origin repository's master branch with the dev branch, |
a75d7b54 | 411 | allowing non-fast-forward updates. *This can leave unreferenced |
149f6ddf | 412 | commits dangling in the origin repository.* Consider the |
a75d7b54 | 413 | following situation, where a fast-forward is not possible: |
149f6ddf MB |
414 | + |
415 | ---- | |
416 | o---o---o---A---B origin/master | |
417 | \ | |
418 | X---Y---Z dev | |
419 | ---- | |
420 | + | |
421 | The above command would change the origin repository to | |
422 | + | |
423 | ---- | |
424 | A---B (unnamed branch) | |
425 | / | |
426 | o---o---o---X---Y---Z master | |
427 | ---- | |
428 | + | |
429 | Commits A and B would no longer belong to a branch with a symbolic name, | |
430 | and so would be unreachable. As such, these commits would be removed by | |
431 | a `git gc` command on the origin repository. | |
432 | ||
7fc9d69f JH |
433 | GIT |
434 | --- | |
9e1f0a85 | 435 | Part of the linkgit:git[1] suite |