Merge branch 'jk/pack-bitmap' into maint
[alt-git.git] / Documentation / git-push.txt
blob58cc59f20cc5a3338f782e09639b8ae8bdc97ae3
1 git-push(1)
2 ===========
4 NAME
5 ----
6 git-push - Update remote refs along with associated objects
9 SYNOPSIS
10 --------
11 [verse]
12 'git push' [--all | --mirror | --tags] [--follow-tags] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
13            [--repo=<repository>] [-f | --force] [--prune] [-v | --verbose]
14            [-u | --set-upstream] [--signed]
15            [--force-with-lease[=<refname>[:<expect>]]]
16            [--no-verify] [<repository> [<refspec>...]]
18 DESCRIPTION
19 -----------
21 Updates remote refs using local refs, while sending objects
22 necessary to complete the given refs.
24 You can make interesting things happen to a repository
25 every time you push into it, by setting up 'hooks' there.  See
26 documentation for linkgit:git-receive-pack[1].
28 When the command line does not specify where to push with the
29 `<repository>` argument, `branch.*.remote` configuration for the
30 current branch is consulted to determine where to push.  If the
31 configuration is missing, it defaults to 'origin'.
33 When the command line does not specify what to push with `<refspec>...`
34 arguments or `--all`, `--mirror`, `--tags` options, the command finds
35 the default `<refspec>` by consulting `remote.*.push` configuration,
36 and if it is not found, honors `push.default` configuration to decide
37 what to push (See linkgit:git-config[1] for the meaning of `push.default`).
40 OPTIONS[[OPTIONS]]
41 ------------------
42 <repository>::
43         The "remote" repository that is destination of a push
44         operation.  This parameter can be either a URL
45         (see the section <<URLS,GIT URLS>> below) or the name
46         of a remote (see the section <<REMOTES,REMOTES>> below).
48 <refspec>...::
49         Specify what destination ref to update with what source object.
50         The format of a <refspec> parameter is an optional plus
51         `+`, followed by the source object <src>, followed
52         by a colon `:`, followed by the destination ref <dst>.
54 The <src> is often the name of the branch you would want to push, but
55 it can be any arbitrary "SHA-1 expression", such as `master~4` or
56 `HEAD` (see linkgit:gitrevisions[7]).
58 The <dst> tells which ref on the remote side is updated with this
59 push. Arbitrary expressions cannot be used here, an actual ref must
60 be named.
61 If `git push [<repository>]` without any `<refspec>` argument is set to
62 update some ref at the destination with `<src>` with
63 `remote.<repository>.push` configuration variable, `:<dst>` part can
64 be omitted---such a push will update a ref that `<src>` normally updates
65 without any `<refspec>` on the command line.  Otherwise, missing
66 `:<dst>` means to update the same ref as the `<src>`.
68 The object referenced by <src> is used to update the <dst> reference
69 on the remote side.  By default this is only allowed if <dst> is not
70 a tag (annotated or lightweight), and then only if it can fast-forward
71 <dst>.  By having the optional leading `+`, you can tell Git to update
72 the <dst> ref even if it is not allowed by default (e.g., it is not a
73 fast-forward.)  This does *not* attempt to merge <src> into <dst>.  See
74 EXAMPLES below for details.
76 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
78 Pushing an empty <src> allows you to delete the <dst> ref from
79 the remote repository.
81 The special refspec `:` (or `+:` to allow non-fast-forward updates)
82 directs Git to push "matching" branches: for every branch that exists on
83 the local side, the remote side is updated if a branch of the same name
84 already exists on the remote side.
86 --all::
87         Push all branches (i.e. refs under `refs/heads/`); cannot be
88         used with other <refspec>.
90 --prune::
91         Remove remote branches that don't have a local counterpart. For example
92         a remote branch `tmp` will be removed if a local branch with the same
93         name doesn't exist any more. This also respects refspecs, e.g.
94         `git push --prune remote refs/heads/*:refs/tmp/*` would
95         make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
96         doesn't exist.
98 --mirror::
99         Instead of naming each ref to push, specifies that all
100         refs under `refs/` (which includes but is not
101         limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
102         be mirrored to the remote repository.  Newly created local
103         refs will be pushed to the remote end, locally updated refs
104         will be force updated on the remote end, and deleted refs
105         will be removed from the remote end.  This is the default
106         if the configuration option `remote.<remote>.mirror` is
107         set.
109 -n::
110 --dry-run::
111         Do everything except actually send the updates.
113 --porcelain::
114         Produce machine-readable output.  The output status line for each ref
115         will be tab-separated and sent to stdout instead of stderr.  The full
116         symbolic names of the refs will be given.
118 --delete::
119         All listed refs are deleted from the remote repository. This is
120         the same as prefixing all refs with a colon.
122 --tags::
123         All refs under `refs/tags` are pushed, in
124         addition to refspecs explicitly listed on the command
125         line.
127 --follow-tags::
128         Push all the refs that would be pushed without this option,
129         and also push annotated tags in `refs/tags` that are missing
130         from the remote but are pointing at commit-ish that are
131         reachable from the refs being pushed.
133 --signed::
134         GPG-sign the push request to update refs on the receiving
135         side, to allow it to be checked by the hooks and/or be
136         logged.  See linkgit:git-receive-pack[1] for the details
137         on the receiving end.
139 --receive-pack=<git-receive-pack>::
140 --exec=<git-receive-pack>::
141         Path to the 'git-receive-pack' program on the remote
142         end.  Sometimes useful when pushing to a remote
143         repository over ssh, and you do not have the program in
144         a directory on the default $PATH.
146 --[no-]force-with-lease::
147 --force-with-lease=<refname>::
148 --force-with-lease=<refname>:<expect>::
149         Usually, "git push" refuses to update a remote ref that is
150         not an ancestor of the local ref used to overwrite it.
152 This option bypasses the check, but instead requires that the
153 current value of the ref to be the expected value.  "git push"
154 fails otherwise.
156 Imagine that you have to rebase what you have already published.
157 You will have to bypass the "must fast-forward" rule in order to
158 replace the history you originally published with the rebased history.
159 If somebody else built on top of your original history while you are
160 rebasing, the tip of the branch at the remote may advance with her
161 commit, and blindly pushing with `--force` will lose her work.
163 This option allows you to say that you expect the history you are
164 updating is what you rebased and want to replace. If the remote ref
165 still points at the commit you specified, you can be sure that no
166 other people did anything to the ref (it is like taking a "lease" on
167 the ref without explicitly locking it, and you update the ref while
168 making sure that your earlier "lease" is still valid).
170 `--force-with-lease` alone, without specifying the details, will protect
171 all remote refs that are going to be updated by requiring their
172 current value to be the same as the remote-tracking branch we have
173 for them, unless specified with a `--force-with-lease=<refname>:<expect>`
174 option that explicitly states what the expected value is.
176 `--force-with-lease=<refname>`, without specifying the expected value, will
177 protect the named ref (alone), if it is going to be updated, by
178 requiring its current value to be the same as the remote-tracking
179 branch we have for it.
181 `--force-with-lease=<refname>:<expect>` will protect the named ref (alone),
182 if it is going to be updated, by requiring its current value to be
183 the same as the specified value <expect> (which is allowed to be
184 different from the remote-tracking branch we have for the refname,
185 or we do not even have to have such a remote-tracking branch when
186 this form is used).
188 Note that all forms other than `--force-with-lease=<refname>:<expect>`
189 that specifies the expected current value of the ref explicitly are
190 still experimental and their semantics may change as we gain experience
191 with this feature.
193 "--no-force-with-lease" will cancel all the previous --force-with-lease on the
194 command line.
196 -f::
197 --force::
198         Usually, the command refuses to update a remote ref that is
199         not an ancestor of the local ref used to overwrite it.
200         Also, when `--force-with-lease` option is used, the command refuses
201         to update a remote ref whose current value does not match
202         what is expected.
204 This flag disables these checks, and can cause the remote repository
205 to lose commits; use it with care.
207 Note that `--force` applies to all the refs that are pushed, hence
208 using it with `push.default` set to `matching` or with multiple push
209 destinations configured with `remote.*.push` may overwrite refs
210 other than the current branch (including local refs that are
211 strictly behind their remote counterpart).  To force a push to only
212 one branch, use a `+` in front of the refspec to push (e.g `git push
213 origin +master` to force a push to the `master` branch). See the
214 `<refspec>...` section above for details.
216 --repo=<repository>::
217         This option is equivalent to the <repository> argument. If both
218         are specified, the command-line argument takes precedence.
220 -u::
221 --set-upstream::
222         For every branch that is up to date or successfully pushed, add
223         upstream (tracking) reference, used by argument-less
224         linkgit:git-pull[1] and other commands. For more information,
225         see 'branch.<name>.merge' in linkgit:git-config[1].
227 --[no-]thin::
228         These options are passed to linkgit:git-send-pack[1]. A thin transfer
229         significantly reduces the amount of sent data when the sender and
230         receiver share many of the same objects in common. The default is
231         \--thin.
233 -q::
234 --quiet::
235         Suppress all output, including the listing of updated refs,
236         unless an error occurs. Progress is not reported to the standard
237         error stream.
239 -v::
240 --verbose::
241         Run verbosely.
243 --progress::
244         Progress status is reported on the standard error stream
245         by default when it is attached to a terminal, unless -q
246         is specified. This flag forces progress status even if the
247         standard error stream is not directed to a terminal.
249 --recurse-submodules=check|on-demand::
250         Make sure all submodule commits used by the revisions to be
251         pushed are available on a remote-tracking branch. If 'check' is
252         used Git will verify that all submodule commits that changed in
253         the revisions to be pushed are available on at least one remote
254         of the submodule. If any commits are missing the push will be
255         aborted and exit with non-zero status. If 'on-demand' is used
256         all submodules that changed in the revisions to be pushed will
257         be pushed. If on-demand was not able to push all necessary
258         revisions it will also be aborted and exit with non-zero status.
260 --[no-]verify::
261         Toggle the pre-push hook (see linkgit:githooks[5]).  The
262         default is \--verify, giving the hook a chance to prevent the
263         push.  With \--no-verify, the hook is bypassed completely.
266 include::urls-remotes.txt[]
268 OUTPUT
269 ------
271 The output of "git push" depends on the transport method used; this
272 section describes the output when pushing over the Git protocol (either
273 locally or via ssh).
275 The status of the push is output in tabular form, with each line
276 representing the status of a single ref. Each line is of the form:
278 -------------------------------
279  <flag> <summary> <from> -> <to> (<reason>)
280 -------------------------------
282 If --porcelain is used, then each line of the output is of the form:
284 -------------------------------
285  <flag> \t <from>:<to> \t <summary> (<reason>)
286 -------------------------------
288 The status of up-to-date refs is shown only if --porcelain or --verbose
289 option is used.
291 flag::
292         A single character indicating the status of the ref:
293 (space);; for a successfully pushed fast-forward;
294 `+`;; for a successful forced update;
295 `-`;; for a successfully deleted ref;
296 `*`;; for a successfully pushed new ref;
297 `!`;; for a ref that was rejected or failed to push; and
298 `=`;; for a ref that was up to date and did not need pushing.
300 summary::
301         For a successfully pushed ref, the summary shows the old and new
302         values of the ref in a form suitable for using as an argument to
303         `git log` (this is `<old>..<new>` in most cases, and
304         `<old>...<new>` for forced non-fast-forward updates).
306 For a failed update, more details are given:
309 rejected::
310         Git did not try to send the ref at all, typically because it
311         is not a fast-forward and you did not force the update.
313 remote rejected::
314         The remote end refused the update.  Usually caused by a hook
315         on the remote side, or because the remote repository has one
316         of the following safety options in effect:
317         `receive.denyCurrentBranch` (for pushes to the checked out
318         branch), `receive.denyNonFastForwards` (for forced
319         non-fast-forward updates), `receive.denyDeletes` or
320         `receive.denyDeleteCurrent`.  See linkgit:git-config[1].
322 remote failure::
323         The remote end did not report the successful update of the ref,
324         perhaps because of a temporary error on the remote side, a
325         break in the network connection, or other transient error.
328 from::
329         The name of the local ref being pushed, minus its
330         `refs/<type>/` prefix. In the case of deletion, the
331         name of the local ref is omitted.
333 to::
334         The name of the remote ref being updated, minus its
335         `refs/<type>/` prefix.
337 reason::
338         A human-readable explanation. In the case of successfully pushed
339         refs, no explanation is needed. For a failed ref, the reason for
340         failure is described.
342 Note about fast-forwards
343 ------------------------
345 When an update changes a branch (or more in general, a ref) that used to
346 point at commit A to point at another commit B, it is called a
347 fast-forward update if and only if B is a descendant of A.
349 In a fast-forward update from A to B, the set of commits that the original
350 commit A built on top of is a subset of the commits the new commit B
351 builds on top of.  Hence, it does not lose any history.
353 In contrast, a non-fast-forward update will lose history.  For example,
354 suppose you and somebody else started at the same commit X, and you built
355 a history leading to commit B while the other person built a history
356 leading to commit A.  The history looks like this:
358 ----------------
360       B
361      /
362  ---X---A
364 ----------------
366 Further suppose that the other person already pushed changes leading to A
367 back to the original repository from which you two obtained the original
368 commit X.
370 The push done by the other person updated the branch that used to point at
371 commit X to point at commit A.  It is a fast-forward.
373 But if you try to push, you will attempt to update the branch (that
374 now points at A) with commit B.  This does _not_ fast-forward.  If you did
375 so, the changes introduced by commit A will be lost, because everybody
376 will now start building on top of B.
378 The command by default does not allow an update that is not a fast-forward
379 to prevent such loss of history.
381 If you do not want to lose your work (history from X to B) or the work by
382 the other person (history from X to A), you would need to first fetch the
383 history from the repository, create a history that contains changes done
384 by both parties, and push the result back.
386 You can perform "git pull", resolve potential conflicts, and "git push"
387 the result.  A "git pull" will create a merge commit C between commits A
388 and B.
390 ----------------
392       B---C
393      /   /
394  ---X---A
396 ----------------
398 Updating A with the resulting merge commit will fast-forward and your
399 push will be accepted.
401 Alternatively, you can rebase your change between X and B on top of A,
402 with "git pull --rebase", and push the result back.  The rebase will
403 create a new commit D that builds the change between X and B on top of
406 ----------------
408       B   D
409      /   /
410  ---X---A
412 ----------------
414 Again, updating A with this commit will fast-forward and your push will be
415 accepted.
417 There is another common situation where you may encounter non-fast-forward
418 rejection when you try to push, and it is possible even when you are
419 pushing into a repository nobody else pushes into. After you push commit
420 A yourself (in the first picture in this section), replace it with "git
421 commit --amend" to produce commit B, and you try to push it out, because
422 forgot that you have pushed A out already. In such a case, and only if
423 you are certain that nobody in the meantime fetched your earlier commit A
424 (and started building on top of it), you can run "git push --force" to
425 overwrite it. In other words, "git push --force" is a method reserved for
426 a case where you do mean to lose history.
429 Examples
430 --------
432 `git push`::
433         Works like `git push <remote>`, where <remote> is the
434         current branch's remote (or `origin`, if no remote is
435         configured for the current branch).
437 `git push origin`::
438         Without additional configuration, pushes the current branch to
439         the configured upstream (`remote.origin.merge` configuration
440         variable) if it has the same name as the current branch, and
441         errors out without pushing otherwise.
443 The default behavior of this command when no <refspec> is given can be
444 configured by setting the `push` option of the remote, or the `push.default`
445 configuration variable.
447 For example, to default to pushing only the current branch to `origin`
448 use `git config remote.origin.push HEAD`.  Any valid <refspec> (like
449 the ones in the examples below) can be configured as the default for
450 `git push origin`.
452 `git push origin :`::
453         Push "matching" branches to `origin`. See
454         <refspec> in the <<OPTIONS,OPTIONS>> section above for a
455         description of "matching" branches.
457 `git push origin master`::
458         Find a ref that matches `master` in the source repository
459         (most likely, it would find `refs/heads/master`), and update
460         the same ref (e.g. `refs/heads/master`) in `origin` repository
461         with it.  If `master` did not exist remotely, it would be
462         created.
464 `git push origin HEAD`::
465         A handy way to push the current branch to the same name on the
466         remote.
468 `git push mothership master:satellite/master dev:satellite/dev`::
469         Use the source ref that matches `master` (e.g. `refs/heads/master`)
470         to update the ref that matches `satellite/master` (most probably
471         `refs/remotes/satellite/master`) in the `mothership` repository;
472         do the same for `dev` and `satellite/dev`.
474 This is to emulate `git fetch` run on the `mothership` using `git
475 push` that is run in the opposite direction in order to integrate
476 the work done on `satellite`, and is often necessary when you can
477 only make connection in one way (i.e. satellite can ssh into
478 mothership but mothership cannot initiate connection to satellite
479 because the latter is behind a firewall or does not run sshd).
481 After running this `git push` on the `satellite` machine, you would
482 ssh into the `mothership` and run `git merge` there to complete the
483 emulation of `git pull` that were run on `mothership` to pull changes
484 made on `satellite`.
486 `git push origin HEAD:master`::
487         Push the current branch to the remote ref matching `master` in the
488         `origin` repository. This form is convenient to push the current
489         branch without thinking about its local name.
491 `git push origin master:refs/heads/experimental`::
492         Create the branch `experimental` in the `origin` repository
493         by copying the current `master` branch.  This form is only
494         needed to create a new branch or tag in the remote repository when
495         the local name and the remote name are different; otherwise,
496         the ref name on its own will work.
498 `git push origin :experimental`::
499         Find a ref that matches `experimental` in the `origin` repository
500         (e.g. `refs/heads/experimental`), and delete it.
502 `git push origin +dev:master`::
503         Update the origin repository's master branch with the dev branch,
504         allowing non-fast-forward updates.  *This can leave unreferenced
505         commits dangling in the origin repository.*  Consider the
506         following situation, where a fast-forward is not possible:
508 ----
509             o---o---o---A---B  origin/master
510                      \
511                       X---Y---Z  dev
512 ----
514 The above command would change the origin repository to
516 ----
517                       A---B  (unnamed branch)
518                      /
519             o---o---o---X---Y---Z  master
520 ----
522 Commits A and B would no longer belong to a branch with a symbolic name,
523 and so would be unreachable.  As such, these commits would be removed by
524 a `git gc` command on the origin repository.
528 Part of the linkgit:git[1] suite