]>
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] |
d0e8e09c | 12 | 'git push' [--all | --mirror | --tags] [--follow-tags] [--atomic] [-n | --dry-run] [--receive-pack=<git-receive-pack>] |
38a25591 | 13 | [--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-v | --verbose] |
97c5d246 | 14 | [-u | --set-upstream] [-o <string> | --push-option=<string>] |
a81383ba | 15 | [--[no-]signed|--signed=(true|false|if-asked)] |
28f5d176 | 16 | [--force-with-lease[=<refname>[:<expect>]]] |
90d32d1f | 17 | [--no-verify] [<repository> [<refspec>...]] |
7fc9d69f JH |
18 | |
19 | DESCRIPTION | |
20 | ----------- | |
ab9b3138 JH |
21 | |
22 | Updates remote refs using local refs, while sending objects | |
23 | necessary to complete the given refs. | |
7fc9d69f | 24 | |
cc55aaec | 25 | You can make interesting things happen to a repository |
eb0362a4 | 26 | every time you push into it, by setting up 'hooks' there. See |
5162e697 | 27 | documentation for linkgit:git-receive-pack[1]. |
eb0362a4 | 28 | |
cfe1348d JH |
29 | When the command line does not specify where to push with the |
30 | `<repository>` argument, `branch.*.remote` configuration for the | |
31 | current branch is consulted to determine where to push. If the | |
32 | configuration is missing, it defaults to 'origin'. | |
33 | ||
34 | When the command line does not specify what to push with `<refspec>...` | |
35 | arguments or `--all`, `--mirror`, `--tags` options, the command finds | |
36 | the default `<refspec>` by consulting `remote.*.push` configuration, | |
37 | and if it is not found, honors `push.default` configuration to decide | |
366c8d4c | 38 | what to push (See linkgit:git-config[1] for the meaning of `push.default`). |
cfe1348d | 39 | |
f6b1fb37 MM |
40 | When neither the command-line nor the configuration specify what to |
41 | push, the default behavior is used, which corresponds to the `simple` | |
42 | value for `push.default`: the current branch is pushed to the | |
43 | corresponding upstream branch, but as a safety measure, the push is | |
44 | aborted if the upstream branch does not have the same name as the | |
45 | local one. | |
46 | ||
7fc9d69f | 47 | |
d6aba61f CJ |
48 | OPTIONS[[OPTIONS]] |
49 | ------------------ | |
3598a308 | 50 | <repository>:: |
85a97d4e | 51 | The "remote" repository that is destination of a push |
98347fee AM |
52 | operation. This parameter can be either a URL |
53 | (see the section <<URLS,GIT URLS>> below) or the name | |
54 | of a remote (see the section <<REMOTES,REMOTES>> below). | |
3598a308 | 55 | |
2c9693bd | 56 | <refspec>...:: |
cfe1348d | 57 | Specify what destination ref to update with what source object. |
7a0d911f | 58 | The format of a <refspec> parameter is an optional plus |
cfe1348d | 59 | `+`, followed by the source object <src>, followed |
7a0d911f | 60 | by a colon `:`, followed by the destination ref <dst>. |
3598a308 | 61 | + |
80391846 AM |
62 | The <src> is often the name of the branch you would want to push, but |
63 | it can be any arbitrary "SHA-1 expression", such as `master~4` or | |
9d83e382 | 64 | `HEAD` (see linkgit:gitrevisions[7]). |
3598a308 | 65 | + |
80391846 AM |
66 | The <dst> tells which ref on the remote side is updated with this |
67 | push. Arbitrary expressions cannot be used here, an actual ref must | |
ca02465b JH |
68 | be named. |
69 | If `git push [<repository>]` without any `<refspec>` argument is set to | |
70 | update some ref at the destination with `<src>` with | |
71 | `remote.<repository>.push` configuration variable, `:<dst>` part can | |
3b19dba7 | 72 | be omitted--such a push will update a ref that `<src>` normally updates |
ca02465b JH |
73 | without any `<refspec>` on the command line. Otherwise, missing |
74 | `:<dst>` means to update the same ref as the `<src>`. | |
3598a308 | 75 | + |
149f6ddf | 76 | The object referenced by <src> is used to update the <dst> reference |
fe802bd2 ÆAB |
77 | on the remote side. Whether this is allowed depends on where in |
78 | `refs/*` the <dst> reference lives as described in detail below, in | |
79 | those sections "update" means any modifications except deletes, which | |
80 | as noted after the next few sections are treated differently. | |
3598a308 | 81 | + |
fe802bd2 ÆAB |
82 | The `refs/heads/*` namespace will only accept commit objects, and |
83 | updates only if they can be fast-forwarded. | |
84 | + | |
85 | The `refs/tags/*` namespace will accept any kind of object (as | |
86 | commits, trees and blobs can be tagged), and any updates to them will | |
87 | be rejected. | |
88 | + | |
89 | It's possible to push any type of object to any namespace outside of | |
90 | `refs/{tags,heads}/*`. In the case of tags and commits, these will be | |
91 | treated as if they were the commits inside `refs/heads/*` for the | |
92 | purposes of whether the update is allowed. | |
93 | + | |
94 | I.e. a fast-forward of commits and tags outside `refs/{tags,heads}/*` | |
95 | is allowed, even in cases where what's being fast-forwarded is not a | |
96 | commit, but a tag object which happens to point to a new commit which | |
97 | is a fast-forward of the commit the last tag (or commit) it's | |
98 | replacing. Replacing a tag with an entirely different tag is also | |
99 | allowed, if it points to the same commit, as well as pushing a peeled | |
100 | tag, i.e. pushing the commit that existing tag object points to, or a | |
101 | new tag object which an existing commit points to. | |
102 | + | |
103 | Tree and blob objects outside of `refs/{tags,heads}/*` will be treated | |
104 | the same way as if they were inside `refs/tags/*`, any update of them | |
105 | will be rejected. | |
106 | + | |
107 | All of the rules described above about what's not allowed as an update | |
108 | can be overridden by adding an the optional leading `+` to a refspec | |
109 | (or using `--force` command line option). The only exception to this | |
110 | is that no amount of forcing will make the `refs/heads/*` namespace | |
111 | accept a non-commit object. Hooks and configuration can also override | |
112 | or amend these rules, see e.g. `receive.denyNonFastForwards` in | |
f4ec16ad | 113 | linkgit:git-config[1] and `pre-receive` and `update` in |
fe802bd2 ÆAB |
114 | linkgit:githooks[5]. |
115 | + | |
116 | Pushing an empty <src> allows you to delete the <dst> ref from the | |
117 | remote repository. Deletions are always accepted without a leading `+` | |
118 | in the refspec (or `--force`), except when forbidden by configuration | |
119 | or hooks. See `receive.denyDeletes` in linkgit:git-config[1] and | |
120 | `pre-receive` and `update` in linkgit:githooks[5]. | |
a83619d6 | 121 | + |
6cf378f0 | 122 | The special refspec `:` (or `+:` to allow non-fast-forward updates) |
2de9b711 | 123 | directs Git to push "matching" branches: for every branch that exists on |
89edd5a9 | 124 | the local side, the remote side is updated if a branch of the same name |
cfe1348d | 125 | already exists on the remote side. |
8da6128c ÆAB |
126 | + |
127 | `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`. | |
7fc9d69f | 128 | |
3240240f | 129 | --all:: |
b2ed944a JH |
130 | Push all branches (i.e. refs under `refs/heads/`); cannot be |
131 | used with other <refspec>. | |
d6a73596 | 132 | |
6ddba5e2 FC |
133 | --prune:: |
134 | Remove remote branches that don't have a local counterpart. For example | |
135 | a remote branch `tmp` will be removed if a local branch with the same | |
136 | name doesn't exist any more. This also respects refspecs, e.g. | |
6cf378f0 | 137 | `git push --prune remote refs/heads/*:refs/tmp/*` would |
6ddba5e2 FC |
138 | make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo` |
139 | doesn't exist. | |
140 | ||
3240240f | 141 | --mirror:: |
ff206748 | 142 | Instead of naming each ref to push, specifies that all |
cc1b8d8b | 143 | refs under `refs/` (which includes but is not |
73f03627 | 144 | limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`) |
ff206748 AW |
145 | be mirrored to the remote repository. Newly created local |
146 | refs will be pushed to the remote end, locally updated refs | |
147 | will be force updated on the remote end, and deleted refs | |
84bb2dfd PB |
148 | will be removed from the remote end. This is the default |
149 | if the configuration option `remote.<remote>.mirror` is | |
150 | set. | |
ff206748 | 151 | |
9f67fee2 | 152 | -n:: |
3240240f | 153 | --dry-run:: |
11f2441f BE |
154 | Do everything except actually send the updates. |
155 | ||
1965ff74 LA |
156 | --porcelain:: |
157 | Produce machine-readable output. The output status line for each ref | |
158 | will be tab-separated and sent to stdout instead of stderr. The full | |
159 | symbolic names of the refs will be given. | |
160 | ||
97c5d246 | 161 | -d:: |
f517f1f2 JK |
162 | --delete:: |
163 | All listed refs are deleted from the remote repository. This is | |
164 | the same as prefixing all refs with a colon. | |
165 | ||
3240240f | 166 | --tags:: |
cc1b8d8b | 167 | All refs under `refs/tags` are pushed, in |
42301e34 JH |
168 | addition to refspecs explicitly listed on the command |
169 | line. | |
170 | ||
c2aba155 JH |
171 | --follow-tags:: |
172 | Push all the refs that would be pushed without this option, | |
173 | and also push annotated tags in `refs/tags` that are missing | |
a8a5406a | 174 | from the remote but are pointing at commit-ish that are |
a8bc269f | 175 | reachable from the refs being pushed. This can also be specified |
ae9f6311 TR |
176 | with configuration variable `push.followTags`. For more |
177 | information, see `push.followTags` in linkgit:git-config[1]. | |
a8bc269f | 178 | |
30261094 | 179 | --[no-]signed:: |
a81383ba | 180 | --signed=(true|false|if-asked):: |
a85b377d JH |
181 | GPG-sign the push request to update refs on the receiving |
182 | side, to allow it to be checked by the hooks and/or be | |
30261094 DB |
183 | logged. If `false` or `--no-signed`, no signing will be |
184 | attempted. If `true` or `--signed`, the push will fail if the | |
185 | server does not support signed pushes. If set to `if-asked`, | |
186 | sign if and only if the server supports signed pushes. The push | |
187 | will also fail if the actual call to `gpg --sign` fails. See | |
188 | linkgit:git-receive-pack[1] for the details on the receiving end. | |
a85b377d | 189 | |
d0e8e09c RS |
190 | --[no-]atomic:: |
191 | Use an atomic transaction on the remote side if available. | |
192 | Either all refs are updated, or on error, no refs are updated. | |
193 | If the server does not support atomic pushes the push will fail. | |
194 | ||
d8052750 MP |
195 | -o <option>:: |
196 | --push-option=<option>:: | |
f6a4e61f SB |
197 | Transmit the given string to the server, which passes them to |
198 | the pre-receive as well as the post-receive hook. The given string | |
199 | must not contain a NUL or LF character. | |
d8052750 MP |
200 | When multiple `--push-option=<option>` are given, they are |
201 | all sent to the other side in the order listed on the | |
202 | command line. | |
203 | When no `--push-option=<option>` is given from the command | |
204 | line, the values of configuration variable `push.pushOption` | |
205 | are used instead. | |
f6a4e61f | 206 | |
3240240f | 207 | --receive-pack=<git-receive-pack>:: |
4fc988ef | 208 | --exec=<git-receive-pack>:: |
ba020ef5 | 209 | Path to the 'git-receive-pack' program on the remote |
5214f770 UKK |
210 | end. Sometimes useful when pushing to a remote |
211 | repository over ssh, and you do not have the program in | |
212 | a directory on the default $PATH. | |
213 | ||
28f5d176 JH |
214 | --[no-]force-with-lease:: |
215 | --force-with-lease=<refname>:: | |
216 | --force-with-lease=<refname>:<expect>:: | |
217 | Usually, "git push" refuses to update a remote ref that is | |
218 | not an ancestor of the local ref used to overwrite it. | |
219 | + | |
fddfaf8a PH |
220 | This option overrides this restriction if the current value of the |
221 | remote ref is the expected value. "git push" fails otherwise. | |
28f5d176 JH |
222 | + |
223 | Imagine that you have to rebase what you have already published. | |
224 | You will have to bypass the "must fast-forward" rule in order to | |
225 | replace the history you originally published with the rebased history. | |
226 | If somebody else built on top of your original history while you are | |
227 | rebasing, the tip of the branch at the remote may advance with her | |
228 | commit, and blindly pushing with `--force` will lose her work. | |
229 | + | |
230 | This option allows you to say that you expect the history you are | |
231 | updating is what you rebased and want to replace. If the remote ref | |
232 | still points at the commit you specified, you can be sure that no | |
fddfaf8a PH |
233 | other people did anything to the ref. It is like taking a "lease" on |
234 | the ref without explicitly locking it, and the remote ref is updated | |
235 | only if the "lease" is still valid. | |
28f5d176 JH |
236 | + |
237 | `--force-with-lease` alone, without specifying the details, will protect | |
238 | all remote refs that are going to be updated by requiring their | |
239 | current value to be the same as the remote-tracking branch we have | |
fddfaf8a | 240 | for them. |
28f5d176 JH |
241 | + |
242 | `--force-with-lease=<refname>`, without specifying the expected value, will | |
243 | protect the named ref (alone), if it is going to be updated, by | |
244 | requiring its current value to be the same as the remote-tracking | |
245 | branch we have for it. | |
246 | + | |
247 | `--force-with-lease=<refname>:<expect>` will protect the named ref (alone), | |
248 | if it is going to be updated, by requiring its current value to be | |
d132b32b | 249 | the same as the specified value `<expect>` (which is allowed to be |
28f5d176 JH |
250 | different from the remote-tracking branch we have for the refname, |
251 | or we do not even have to have such a remote-tracking branch when | |
eee98e74 JK |
252 | this form is used). If `<expect>` is the empty string, then the named ref |
253 | must not already exist. | |
28f5d176 JH |
254 | + |
255 | Note that all forms other than `--force-with-lease=<refname>:<expect>` | |
256 | that specifies the expected current value of the ref explicitly are | |
257 | still experimental and their semantics may change as we gain experience | |
258 | with this feature. | |
259 | + | |
260 | "--no-force-with-lease" will cancel all the previous --force-with-lease on the | |
261 | command line. | |
f17d642d ÆAB |
262 | + |
263 | A general note on safety: supplying this option without an expected | |
264 | value, i.e. as `--force-with-lease` or `--force-with-lease=<refname>` | |
265 | interacts very badly with anything that implicitly runs `git fetch` on | |
266 | the remote to be pushed to in the background, e.g. `git fetch origin` | |
267 | on your repository in a cronjob. | |
268 | + | |
269 | The protection it offers over `--force` is ensuring that subsequent | |
270 | changes your work wasn't based on aren't clobbered, but this is | |
271 | trivially defeated if some background process is updating refs in the | |
272 | background. We don't have anything except the remote tracking info to | |
273 | go by as a heuristic for refs you're expected to have seen & are | |
274 | willing to clobber. | |
275 | + | |
276 | If your editor or some other system is running `git fetch` in the | |
277 | background for you a way to mitigate this is to simply set up another | |
278 | remote: | |
279 | + | |
280 | git remote add origin-push $(git config remote.origin.url) | |
281 | git fetch origin-push | |
282 | + | |
283 | Now when the background process runs `git fetch origin` the references | |
284 | on `origin-push` won't be updated, and thus commands like: | |
285 | + | |
286 | git push --force-with-lease origin-push | |
287 | + | |
288 | Will fail unless you manually run `git fetch origin-push`. This method | |
289 | is of course entirely defeated by something that runs `git fetch | |
290 | --all`, in that case you'd need to either disable it or do something | |
291 | more tedious like: | |
292 | + | |
293 | git fetch # update 'master' from remote | |
294 | git tag base master # mark our base point | |
295 | git rebase -i master # rewrite some commits | |
296 | git push --force-with-lease=master:base master:master | |
297 | + | |
298 | I.e. create a `base` tag for versions of the upstream code that you've | |
299 | seen and are willing to overwrite, then rewrite history, and finally | |
300 | force push changes to `master` if the remote version is still at | |
301 | `base`, regardless of what your local `remotes/origin/master` has been | |
302 | updated to in the background. | |
28f5d176 | 303 | |
3240240f SB |
304 | -f:: |
305 | --force:: | |
f0fff36e | 306 | Usually, the command refuses to update a remote ref that is |
64a476e6 | 307 | not an ancestor of the local ref used to overwrite it. |
28f5d176 JH |
308 | Also, when `--force-with-lease` option is used, the command refuses |
309 | to update a remote ref whose current value does not match | |
310 | what is expected. | |
311 | + | |
312 | This flag disables these checks, and can cause the remote repository | |
313 | to lose commits; use it with care. | |
314 | + | |
315 | Note that `--force` applies to all the refs that are pushed, hence | |
316 | using it with `push.default` set to `matching` or with multiple push | |
317 | destinations configured with `remote.*.push` may overwrite refs | |
318 | other than the current branch (including local refs that are | |
319 | strictly behind their remote counterpart). To force a push to only | |
320 | one branch, use a `+` in front of the refspec to push (e.g `git push | |
321 | origin +master` to force a push to the `master` branch). See the | |
322 | `<refspec>...` section above for details. | |
7fc9d69f | 323 | |
bf07cc58 | 324 | --repo=<repository>:: |
57b92a77 MG |
325 | This option is equivalent to the <repository> argument. If both |
326 | are specified, the command-line argument takes precedence. | |
dc36f265 | 327 | |
0ed3a111 TR |
328 | -u:: |
329 | --set-upstream:: | |
330 | For every branch that is up to date or successfully pushed, add | |
331 | upstream (tracking) reference, used by argument-less | |
332 | linkgit:git-pull[1] and other commands. For more information, | |
ae9f6311 | 333 | see `branch.<name>.merge` in linkgit:git-config[1]. |
0ed3a111 | 334 | |
0460ed2c | 335 | --[no-]thin:: |
738820a9 SB |
336 | These options are passed to linkgit:git-send-pack[1]. A thin transfer |
337 | significantly reduces the amount of sent data when the sender and | |
338 | receiver share many of the same objects in common. The default is | |
9e9f132f | 339 | `--thin`. |
dc36f265 | 340 | |
989119d9 JK |
341 | -q:: |
342 | --quiet:: | |
343 | Suppress all output, including the listing of updated refs, | |
78381069 TRC |
344 | unless an error occurs. Progress is not reported to the standard |
345 | error stream. | |
989119d9 | 346 | |
3240240f SB |
347 | -v:: |
348 | --verbose:: | |
dc36f265 JH |
349 | Run verbosely. |
350 | ||
78381069 TRC |
351 | --progress:: |
352 | Progress status is reported on the standard error stream | |
353 | by default when it is attached to a terminal, unless -q | |
354 | is specified. This flag forces progress status even if the | |
355 | standard error stream is not directed to a terminal. | |
989119d9 | 356 | |
b33a15b0 | 357 | --no-recurse-submodules:: |
9c24c874 | 358 | --recurse-submodules=check|on-demand|only|no:: |
b33a15b0 MC |
359 | May be used to make sure all submodule commits used by the |
360 | revisions to be pushed are available on a remote-tracking branch. | |
361 | If 'check' is used Git will verify that all submodule commits that | |
362 | changed in the revisions to be pushed are available on at least one | |
363 | remote of the submodule. If any commits are missing the push will | |
364 | be aborted and exit with non-zero status. If 'on-demand' is used | |
365 | all submodules that changed in the revisions to be pushed will be | |
9c24c874 CW |
366 | pushed. If on-demand was not able to push all necessary revisions it will |
367 | also be aborted and exit with non-zero status. If 'only' is used all | |
368 | submodules will be recursively pushed while the superproject is left | |
369 | unpushed. A value of 'no' or using `--no-recurse-submodules` can be used | |
370 | to override the push.recurseSubmodules configuration variable when no | |
371 | submodule recursion is required. | |
d2b17b32 | 372 | |
90d32d1f TR |
373 | --[no-]verify:: |
374 | Toggle the pre-push hook (see linkgit:githooks[5]). The | |
1c262bb7 JK |
375 | default is --verify, giving the hook a chance to prevent the |
376 | push. With --no-verify, the hook is bypassed completely. | |
90d32d1f | 377 | |
c915f11e EW |
378 | -4:: |
379 | --ipv4:: | |
380 | Use IPv4 addresses only, ignoring IPv6 addresses. | |
381 | ||
382 | -6:: | |
383 | --ipv6:: | |
384 | Use IPv6 addresses only, ignoring IPv4 addresses. | |
d2b17b32 | 385 | |
37ba0561 | 386 | include::urls-remotes.txt[] |
eb0362a4 | 387 | |
066a5268 JK |
388 | OUTPUT |
389 | ------ | |
390 | ||
391 | The output of "git push" depends on the transport method used; this | |
2de9b711 | 392 | section describes the output when pushing over the Git protocol (either |
066a5268 JK |
393 | locally or via ssh). |
394 | ||
395 | The status of the push is output in tabular form, with each line | |
396 | representing the status of a single ref. Each line is of the form: | |
397 | ||
398 | ------------------------------- | |
399 | <flag> <summary> <from> -> <to> (<reason>) | |
400 | ------------------------------- | |
401 | ||
1965ff74 LA |
402 | If --porcelain is used, then each line of the output is of the form: |
403 | ||
404 | ------------------------------- | |
405 | <flag> \t <from>:<to> \t <summary> (<reason>) | |
406 | ------------------------------- | |
407 | ||
b7047abc JH |
408 | The status of up-to-date refs is shown only if --porcelain or --verbose |
409 | option is used. | |
410 | ||
066a5268 | 411 | flag:: |
b7047abc JH |
412 | A single character indicating the status of the ref: |
413 | (space);; for a successfully pushed fast-forward; | |
6cf378f0 | 414 | `+`;; for a successful forced update; |
b7047abc JH |
415 | `-`;; for a successfully deleted ref; |
416 | `*`;; for a successfully pushed new ref; | |
417 | `!`;; for a ref that was rejected or failed to push; and | |
418 | `=`;; for a ref that was up to date and did not need pushing. | |
066a5268 JK |
419 | |
420 | summary:: | |
421 | For a successfully pushed ref, the summary shows the old and new | |
422 | values of the ref in a form suitable for using as an argument to | |
423 | `git log` (this is `<old>..<new>` in most cases, and | |
6cf378f0 | 424 | `<old>...<new>` for forced non-fast-forward updates). |
9a9fb5d3 TR |
425 | + |
426 | For a failed update, more details are given: | |
427 | + | |
428 | -- | |
429 | rejected:: | |
430 | Git did not try to send the ref at all, typically because it | |
431 | is not a fast-forward and you did not force the update. | |
432 | ||
433 | remote rejected:: | |
434 | The remote end refused the update. Usually caused by a hook | |
435 | on the remote side, or because the remote repository has one | |
436 | of the following safety options in effect: | |
437 | `receive.denyCurrentBranch` (for pushes to the checked out | |
438 | branch), `receive.denyNonFastForwards` (for forced | |
439 | non-fast-forward updates), `receive.denyDeletes` or | |
440 | `receive.denyDeleteCurrent`. See linkgit:git-config[1]. | |
441 | ||
442 | remote failure:: | |
443 | The remote end did not report the successful update of the ref, | |
444 | perhaps because of a temporary error on the remote side, a | |
445 | break in the network connection, or other transient error. | |
446 | -- | |
066a5268 JK |
447 | |
448 | from:: | |
449 | The name of the local ref being pushed, minus its | |
450 | `refs/<type>/` prefix. In the case of deletion, the | |
451 | name of the local ref is omitted. | |
452 | ||
453 | to:: | |
454 | The name of the remote ref being updated, minus its | |
455 | `refs/<type>/` prefix. | |
456 | ||
457 | reason:: | |
458 | A human-readable explanation. In the case of successfully pushed | |
459 | refs, no explanation is needed. For a failed ref, the reason for | |
460 | failure is described. | |
bb9fca80 | 461 | |
76a8788c | 462 | NOTE ABOUT FAST-FORWARDS |
07436e43 MM |
463 | ------------------------ |
464 | ||
465 | When an update changes a branch (or more in general, a ref) that used to | |
466 | point at commit A to point at another commit B, it is called a | |
467 | fast-forward update if and only if B is a descendant of A. | |
468 | ||
469 | In a fast-forward update from A to B, the set of commits that the original | |
470 | commit A built on top of is a subset of the commits the new commit B | |
471 | builds on top of. Hence, it does not lose any history. | |
472 | ||
473 | In contrast, a non-fast-forward update will lose history. For example, | |
474 | suppose you and somebody else started at the same commit X, and you built | |
475 | a history leading to commit B while the other person built a history | |
476 | leading to commit A. The history looks like this: | |
477 | ||
478 | ---------------- | |
479 | ||
480 | B | |
481 | / | |
482 | ---X---A | |
483 | ||
484 | ---------------- | |
485 | ||
486 | Further suppose that the other person already pushed changes leading to A | |
6b6e063c MS |
487 | back to the original repository from which you two obtained the original |
488 | commit X. | |
07436e43 MM |
489 | |
490 | The push done by the other person updated the branch that used to point at | |
491 | commit X to point at commit A. It is a fast-forward. | |
492 | ||
493 | But if you try to push, you will attempt to update the branch (that | |
494 | now points at A) with commit B. This does _not_ fast-forward. If you did | |
495 | so, the changes introduced by commit A will be lost, because everybody | |
496 | will now start building on top of B. | |
497 | ||
498 | The command by default does not allow an update that is not a fast-forward | |
499 | to prevent such loss of history. | |
500 | ||
a58088ab | 501 | If you do not want to lose your work (history from X to B) or the work by |
07436e43 MM |
502 | the other person (history from X to A), you would need to first fetch the |
503 | history from the repository, create a history that contains changes done | |
504 | by both parties, and push the result back. | |
505 | ||
506 | You can perform "git pull", resolve potential conflicts, and "git push" | |
507 | the result. A "git pull" will create a merge commit C between commits A | |
508 | and B. | |
509 | ||
510 | ---------------- | |
511 | ||
512 | B---C | |
513 | / / | |
514 | ---X---A | |
515 | ||
516 | ---------------- | |
517 | ||
518 | Updating A with the resulting merge commit will fast-forward and your | |
519 | push will be accepted. | |
520 | ||
521 | Alternatively, you can rebase your change between X and B on top of A, | |
522 | with "git pull --rebase", and push the result back. The rebase will | |
523 | create a new commit D that builds the change between X and B on top of | |
524 | A. | |
525 | ||
526 | ---------------- | |
527 | ||
528 | B D | |
529 | / / | |
530 | ---X---A | |
531 | ||
532 | ---------------- | |
533 | ||
534 | Again, updating A with this commit will fast-forward and your push will be | |
535 | accepted. | |
536 | ||
537 | There is another common situation where you may encounter non-fast-forward | |
538 | rejection when you try to push, and it is possible even when you are | |
539 | pushing into a repository nobody else pushes into. After you push commit | |
540 | A yourself (in the first picture in this section), replace it with "git | |
541 | commit --amend" to produce commit B, and you try to push it out, because | |
542 | forgot that you have pushed A out already. In such a case, and only if | |
543 | you are certain that nobody in the meantime fetched your earlier commit A | |
544 | (and started building on top of it), you can run "git push --force" to | |
545 | overwrite it. In other words, "git push --force" is a method reserved for | |
546 | a case where you do mean to lose history. | |
547 | ||
548 | ||
76a8788c | 549 | EXAMPLES |
bb9fca80 JH |
550 | -------- |
551 | ||
5d2fc913 | 552 | `git push`:: |
d6aba61f CJ |
553 | Works like `git push <remote>`, where <remote> is the |
554 | current branch's remote (or `origin`, if no remote is | |
555 | configured for the current branch). | |
556 | ||
5d2fc913 | 557 | `git push origin`:: |
b2ed944a JH |
558 | Without additional configuration, pushes the current branch to |
559 | the configured upstream (`remote.origin.merge` configuration | |
560 | variable) if it has the same name as the current branch, and | |
561 | errors out without pushing otherwise. | |
d6aba61f CJ |
562 | + |
563 | The default behavior of this command when no <refspec> is given can be | |
1ec6f488 RR |
564 | configured by setting the `push` option of the remote, or the `push.default` |
565 | configuration variable. | |
d6aba61f CJ |
566 | + |
567 | For example, to default to pushing only the current branch to `origin` | |
568 | use `git config remote.origin.push HEAD`. Any valid <refspec> (like | |
569 | the ones in the examples below) can be configured as the default for | |
570 | `git push origin`. | |
571 | ||
5d2fc913 | 572 | `git push origin :`:: |
d6aba61f CJ |
573 | Push "matching" branches to `origin`. See |
574 | <refspec> in the <<OPTIONS,OPTIONS>> section above for a | |
575 | description of "matching" branches. | |
576 | ||
5d2fc913 | 577 | `git push origin master`:: |
bb9fca80 JH |
578 | Find a ref that matches `master` in the source repository |
579 | (most likely, it would find `refs/heads/master`), and update | |
580 | the same ref (e.g. `refs/heads/master`) in `origin` repository | |
491b1b11 SV |
581 | with it. If `master` did not exist remotely, it would be |
582 | created. | |
bb9fca80 | 583 | |
5d2fc913 | 584 | `git push origin HEAD`:: |
17507832 AM |
585 | A handy way to push the current branch to the same name on the |
586 | remote. | |
bb9fca80 | 587 | |
b48990e7 | 588 | `git push mothership master:satellite/master dev:satellite/dev`:: |
2c9693bd AMS |
589 | Use the source ref that matches `master` (e.g. `refs/heads/master`) |
590 | to update the ref that matches `satellite/master` (most probably | |
b48990e7 | 591 | `refs/remotes/satellite/master`) in the `mothership` repository; |
2c9693bd | 592 | do the same for `dev` and `satellite/dev`. |
b48990e7 JH |
593 | + |
594 | This is to emulate `git fetch` run on the `mothership` using `git | |
595 | push` that is run in the opposite direction in order to integrate | |
596 | the work done on `satellite`, and is often necessary when you can | |
597 | only make connection in one way (i.e. satellite can ssh into | |
598 | mothership but mothership cannot initiate connection to satellite | |
599 | because the latter is behind a firewall or does not run sshd). | |
600 | + | |
601 | After running this `git push` on the `satellite` machine, you would | |
602 | ssh into the `mothership` and run `git merge` there to complete the | |
603 | emulation of `git pull` that were run on `mothership` to pull changes | |
604 | made on `satellite`. | |
bb9fca80 | 605 | |
5d2fc913 | 606 | `git push origin HEAD:master`:: |
17507832 AM |
607 | Push the current branch to the remote ref matching `master` in the |
608 | `origin` repository. This form is convenient to push the current | |
609 | branch without thinking about its local name. | |
610 | ||
5d2fc913 | 611 | `git push origin master:refs/heads/experimental`:: |
4e560158 | 612 | Create the branch `experimental` in the `origin` repository |
491b1b11 SV |
613 | by copying the current `master` branch. This form is only |
614 | needed to create a new branch or tag in the remote repository when | |
615 | the local name and the remote name are different; otherwise, | |
616 | the ref name on its own will work. | |
4e560158 | 617 | |
5d2fc913 | 618 | `git push origin :experimental`:: |
17507832 AM |
619 | Find a ref that matches `experimental` in the `origin` repository |
620 | (e.g. `refs/heads/experimental`), and delete it. | |
621 | ||
6cf378f0 | 622 | `git push origin +dev:master`:: |
149f6ddf | 623 | Update the origin repository's master branch with the dev branch, |
a75d7b54 | 624 | allowing non-fast-forward updates. *This can leave unreferenced |
149f6ddf | 625 | commits dangling in the origin repository.* Consider the |
a75d7b54 | 626 | following situation, where a fast-forward is not possible: |
149f6ddf MB |
627 | + |
628 | ---- | |
629 | o---o---o---A---B origin/master | |
630 | \ | |
631 | X---Y---Z dev | |
632 | ---- | |
633 | + | |
634 | The above command would change the origin repository to | |
635 | + | |
636 | ---- | |
637 | A---B (unnamed branch) | |
638 | / | |
639 | o---o---o---X---Y---Z master | |
640 | ---- | |
641 | + | |
642 | Commits A and B would no longer belong to a branch with a symbolic name, | |
643 | and so would be unreachable. As such, these commits would be removed by | |
644 | a `git gc` command on the origin repository. | |
645 | ||
235ec243 MM |
646 | include::transfer-data-leaks.txt[] |
647 | ||
7fc9d69f JH |
648 | GIT |
649 | --- | |
9e1f0a85 | 650 | Part of the linkgit:git[1] suite |