push: allow --follow-tags to be set by config push.followTags
[git/debian.git] / Documentation / git-push.txt
blobcaa187be06d813606fdddfb1f56bd59609898010
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] [--atomic] [-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.  This can also be specified
132         with configuration variable 'push.followTags'.  For more
133         information, see 'push.followTags' in linkgit:git-config[1].
136 --signed::
137         GPG-sign the push request to update refs on the receiving
138         side, to allow it to be checked by the hooks and/or be
139         logged.  See linkgit:git-receive-pack[1] for the details
140         on the receiving end.
142 --[no-]atomic::
143         Use an atomic transaction on the remote side if available.
144         Either all refs are updated, or on error, no refs are updated.
145         If the server does not support atomic pushes the push will fail.
147 --receive-pack=<git-receive-pack>::
148 --exec=<git-receive-pack>::
149         Path to the 'git-receive-pack' program on the remote
150         end.  Sometimes useful when pushing to a remote
151         repository over ssh, and you do not have the program in
152         a directory on the default $PATH.
154 --[no-]force-with-lease::
155 --force-with-lease=<refname>::
156 --force-with-lease=<refname>:<expect>::
157         Usually, "git push" refuses to update a remote ref that is
158         not an ancestor of the local ref used to overwrite it.
160 This option bypasses the check, but instead requires that the
161 current value of the ref to be the expected value.  "git push"
162 fails otherwise.
164 Imagine that you have to rebase what you have already published.
165 You will have to bypass the "must fast-forward" rule in order to
166 replace the history you originally published with the rebased history.
167 If somebody else built on top of your original history while you are
168 rebasing, the tip of the branch at the remote may advance with her
169 commit, and blindly pushing with `--force` will lose her work.
171 This option allows you to say that you expect the history you are
172 updating is what you rebased and want to replace. If the remote ref
173 still points at the commit you specified, you can be sure that no
174 other people did anything to the ref (it is like taking a "lease" on
175 the ref without explicitly locking it, and you update the ref while
176 making sure that your earlier "lease" is still valid).
178 `--force-with-lease` alone, without specifying the details, will protect
179 all remote refs that are going to be updated by requiring their
180 current value to be the same as the remote-tracking branch we have
181 for them, unless specified with a `--force-with-lease=<refname>:<expect>`
182 option that explicitly states what the expected value is.
184 `--force-with-lease=<refname>`, without specifying the expected value, will
185 protect the named ref (alone), if it is going to be updated, by
186 requiring its current value to be the same as the remote-tracking
187 branch we have for it.
189 `--force-with-lease=<refname>:<expect>` will protect the named ref (alone),
190 if it is going to be updated, by requiring its current value to be
191 the same as the specified value <expect> (which is allowed to be
192 different from the remote-tracking branch we have for the refname,
193 or we do not even have to have such a remote-tracking branch when
194 this form is used).
196 Note that all forms other than `--force-with-lease=<refname>:<expect>`
197 that specifies the expected current value of the ref explicitly are
198 still experimental and their semantics may change as we gain experience
199 with this feature.
201 "--no-force-with-lease" will cancel all the previous --force-with-lease on the
202 command line.
204 -f::
205 --force::
206         Usually, the command refuses to update a remote ref that is
207         not an ancestor of the local ref used to overwrite it.
208         Also, when `--force-with-lease` option is used, the command refuses
209         to update a remote ref whose current value does not match
210         what is expected.
212 This flag disables these checks, and can cause the remote repository
213 to lose commits; use it with care.
215 Note that `--force` applies to all the refs that are pushed, hence
216 using it with `push.default` set to `matching` or with multiple push
217 destinations configured with `remote.*.push` may overwrite refs
218 other than the current branch (including local refs that are
219 strictly behind their remote counterpart).  To force a push to only
220 one branch, use a `+` in front of the refspec to push (e.g `git push
221 origin +master` to force a push to the `master` branch). See the
222 `<refspec>...` section above for details.
224 --repo=<repository>::
225         This option is only relevant if no <repository> argument is
226         passed in the invocation. In this case, 'git push' derives the
227         remote name from the current branch: If it tracks a remote
228         branch, then that remote repository is pushed to. Otherwise,
229         the name "origin" is used. For this latter case, this option
230         can be used to override the name "origin". In other words,
231         the difference between these two commands
233 --------------------------
234 git push public         #1
235 git push --repo=public  #2
236 --------------------------
238 is that #1 always pushes to "public" whereas #2 pushes to "public"
239 only if the current branch does not track a remote branch. This is
240 useful if you write an alias or script around 'git push'.
242 -u::
243 --set-upstream::
244         For every branch that is up to date or successfully pushed, add
245         upstream (tracking) reference, used by argument-less
246         linkgit:git-pull[1] and other commands. For more information,
247         see 'branch.<name>.merge' in linkgit:git-config[1].
249 --[no-]thin::
250         These options are passed to linkgit:git-send-pack[1]. A thin transfer
251         significantly reduces the amount of sent data when the sender and
252         receiver share many of the same objects in common. The default is
253         \--thin.
255 -q::
256 --quiet::
257         Suppress all output, including the listing of updated refs,
258         unless an error occurs. Progress is not reported to the standard
259         error stream.
261 -v::
262 --verbose::
263         Run verbosely.
265 --progress::
266         Progress status is reported on the standard error stream
267         by default when it is attached to a terminal, unless -q
268         is specified. This flag forces progress status even if the
269         standard error stream is not directed to a terminal.
271 --recurse-submodules=check|on-demand::
272         Make sure all submodule commits used by the revisions to be
273         pushed are available on a remote-tracking branch. If 'check' is
274         used Git will verify that all submodule commits that changed in
275         the revisions to be pushed are available on at least one remote
276         of the submodule. If any commits are missing the push will be
277         aborted and exit with non-zero status. If 'on-demand' is used
278         all submodules that changed in the revisions to be pushed will
279         be pushed. If on-demand was not able to push all necessary
280         revisions it will also be aborted and exit with non-zero status.
282 --[no-]verify::
283         Toggle the pre-push hook (see linkgit:githooks[5]).  The
284         default is \--verify, giving the hook a chance to prevent the
285         push.  With \--no-verify, the hook is bypassed completely.
288 include::urls-remotes.txt[]
290 OUTPUT
291 ------
293 The output of "git push" depends on the transport method used; this
294 section describes the output when pushing over the Git protocol (either
295 locally or via ssh).
297 The status of the push is output in tabular form, with each line
298 representing the status of a single ref. Each line is of the form:
300 -------------------------------
301  <flag> <summary> <from> -> <to> (<reason>)
302 -------------------------------
304 If --porcelain is used, then each line of the output is of the form:
306 -------------------------------
307  <flag> \t <from>:<to> \t <summary> (<reason>)
308 -------------------------------
310 The status of up-to-date refs is shown only if --porcelain or --verbose
311 option is used.
313 flag::
314         A single character indicating the status of the ref:
315 (space);; for a successfully pushed fast-forward;
316 `+`;; for a successful forced update;
317 `-`;; for a successfully deleted ref;
318 `*`;; for a successfully pushed new ref;
319 `!`;; for a ref that was rejected or failed to push; and
320 `=`;; for a ref that was up to date and did not need pushing.
322 summary::
323         For a successfully pushed ref, the summary shows the old and new
324         values of the ref in a form suitable for using as an argument to
325         `git log` (this is `<old>..<new>` in most cases, and
326         `<old>...<new>` for forced non-fast-forward updates).
328 For a failed update, more details are given:
331 rejected::
332         Git did not try to send the ref at all, typically because it
333         is not a fast-forward and you did not force the update.
335 remote rejected::
336         The remote end refused the update.  Usually caused by a hook
337         on the remote side, or because the remote repository has one
338         of the following safety options in effect:
339         `receive.denyCurrentBranch` (for pushes to the checked out
340         branch), `receive.denyNonFastForwards` (for forced
341         non-fast-forward updates), `receive.denyDeletes` or
342         `receive.denyDeleteCurrent`.  See linkgit:git-config[1].
344 remote failure::
345         The remote end did not report the successful update of the ref,
346         perhaps because of a temporary error on the remote side, a
347         break in the network connection, or other transient error.
350 from::
351         The name of the local ref being pushed, minus its
352         `refs/<type>/` prefix. In the case of deletion, the
353         name of the local ref is omitted.
355 to::
356         The name of the remote ref being updated, minus its
357         `refs/<type>/` prefix.
359 reason::
360         A human-readable explanation. In the case of successfully pushed
361         refs, no explanation is needed. For a failed ref, the reason for
362         failure is described.
364 Note about fast-forwards
365 ------------------------
367 When an update changes a branch (or more in general, a ref) that used to
368 point at commit A to point at another commit B, it is called a
369 fast-forward update if and only if B is a descendant of A.
371 In a fast-forward update from A to B, the set of commits that the original
372 commit A built on top of is a subset of the commits the new commit B
373 builds on top of.  Hence, it does not lose any history.
375 In contrast, a non-fast-forward update will lose history.  For example,
376 suppose you and somebody else started at the same commit X, and you built
377 a history leading to commit B while the other person built a history
378 leading to commit A.  The history looks like this:
380 ----------------
382       B
383      /
384  ---X---A
386 ----------------
388 Further suppose that the other person already pushed changes leading to A
389 back to the original repository from which you two obtained the original
390 commit X.
392 The push done by the other person updated the branch that used to point at
393 commit X to point at commit A.  It is a fast-forward.
395 But if you try to push, you will attempt to update the branch (that
396 now points at A) with commit B.  This does _not_ fast-forward.  If you did
397 so, the changes introduced by commit A will be lost, because everybody
398 will now start building on top of B.
400 The command by default does not allow an update that is not a fast-forward
401 to prevent such loss of history.
403 If you do not want to lose your work (history from X to B) or the work by
404 the other person (history from X to A), you would need to first fetch the
405 history from the repository, create a history that contains changes done
406 by both parties, and push the result back.
408 You can perform "git pull", resolve potential conflicts, and "git push"
409 the result.  A "git pull" will create a merge commit C between commits A
410 and B.
412 ----------------
414       B---C
415      /   /
416  ---X---A
418 ----------------
420 Updating A with the resulting merge commit will fast-forward and your
421 push will be accepted.
423 Alternatively, you can rebase your change between X and B on top of A,
424 with "git pull --rebase", and push the result back.  The rebase will
425 create a new commit D that builds the change between X and B on top of
428 ----------------
430       B   D
431      /   /
432  ---X---A
434 ----------------
436 Again, updating A with this commit will fast-forward and your push will be
437 accepted.
439 There is another common situation where you may encounter non-fast-forward
440 rejection when you try to push, and it is possible even when you are
441 pushing into a repository nobody else pushes into. After you push commit
442 A yourself (in the first picture in this section), replace it with "git
443 commit --amend" to produce commit B, and you try to push it out, because
444 forgot that you have pushed A out already. In such a case, and only if
445 you are certain that nobody in the meantime fetched your earlier commit A
446 (and started building on top of it), you can run "git push --force" to
447 overwrite it. In other words, "git push --force" is a method reserved for
448 a case where you do mean to lose history.
451 Examples
452 --------
454 `git push`::
455         Works like `git push <remote>`, where <remote> is the
456         current branch's remote (or `origin`, if no remote is
457         configured for the current branch).
459 `git push origin`::
460         Without additional configuration, pushes the current branch to
461         the configured upstream (`remote.origin.merge` configuration
462         variable) if it has the same name as the current branch, and
463         errors out without pushing otherwise.
465 The default behavior of this command when no <refspec> is given can be
466 configured by setting the `push` option of the remote, or the `push.default`
467 configuration variable.
469 For example, to default to pushing only the current branch to `origin`
470 use `git config remote.origin.push HEAD`.  Any valid <refspec> (like
471 the ones in the examples below) can be configured as the default for
472 `git push origin`.
474 `git push origin :`::
475         Push "matching" branches to `origin`. See
476         <refspec> in the <<OPTIONS,OPTIONS>> section above for a
477         description of "matching" branches.
479 `git push origin master`::
480         Find a ref that matches `master` in the source repository
481         (most likely, it would find `refs/heads/master`), and update
482         the same ref (e.g. `refs/heads/master`) in `origin` repository
483         with it.  If `master` did not exist remotely, it would be
484         created.
486 `git push origin HEAD`::
487         A handy way to push the current branch to the same name on the
488         remote.
490 `git push mothership master:satellite/master dev:satellite/dev`::
491         Use the source ref that matches `master` (e.g. `refs/heads/master`)
492         to update the ref that matches `satellite/master` (most probably
493         `refs/remotes/satellite/master`) in the `mothership` repository;
494         do the same for `dev` and `satellite/dev`.
496 This is to emulate `git fetch` run on the `mothership` using `git
497 push` that is run in the opposite direction in order to integrate
498 the work done on `satellite`, and is often necessary when you can
499 only make connection in one way (i.e. satellite can ssh into
500 mothership but mothership cannot initiate connection to satellite
501 because the latter is behind a firewall or does not run sshd).
503 After running this `git push` on the `satellite` machine, you would
504 ssh into the `mothership` and run `git merge` there to complete the
505 emulation of `git pull` that were run on `mothership` to pull changes
506 made on `satellite`.
508 `git push origin HEAD:master`::
509         Push the current branch to the remote ref matching `master` in the
510         `origin` repository. This form is convenient to push the current
511         branch without thinking about its local name.
513 `git push origin master:refs/heads/experimental`::
514         Create the branch `experimental` in the `origin` repository
515         by copying the current `master` branch.  This form is only
516         needed to create a new branch or tag in the remote repository when
517         the local name and the remote name are different; otherwise,
518         the ref name on its own will work.
520 `git push origin :experimental`::
521         Find a ref that matches `experimental` in the `origin` repository
522         (e.g. `refs/heads/experimental`), and delete it.
524 `git push origin +dev:master`::
525         Update the origin repository's master branch with the dev branch,
526         allowing non-fast-forward updates.  *This can leave unreferenced
527         commits dangling in the origin repository.*  Consider the
528         following situation, where a fast-forward is not possible:
530 ----
531             o---o---o---A---B  origin/master
532                      \
533                       X---Y---Z  dev
534 ----
536 The above command would change the origin repository to
538 ----
539                       A---B  (unnamed branch)
540                      /
541             o---o---o---X---Y---Z  master
542 ----
544 Commits A and B would no longer belong to a branch with a symbolic name,
545 and so would be unreachable.  As such, these commits would be removed by
546 a `git gc` command on the origin repository.
550 Part of the linkgit:git[1] suite