log: do not segfault on gmtime errors
[git/jrn.git] / Documentation / git-push.txt
blob577d201c006ab6c72acef9bd800aa36f6cc356d3
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] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
13            [--repo=<repository>] [-f | --force] [--prune] [-v | --verbose] [-u | --set-upstream]
14            [<repository> [<refspec>...]]
16 DESCRIPTION
17 -----------
19 Updates remote refs using local refs, while sending objects
20 necessary to complete the given refs.
22 You can make interesting things happen to a repository
23 every time you push into it, by setting up 'hooks' there.  See
24 documentation for linkgit:git-receive-pack[1].
26 When the command line does not specify where to push with the
27 `<repository>` argument, `branch.*.remote` configuration for the
28 current branch is consulted to determine where to push.  If the
29 configuration is missing, it defaults to 'origin'.
31 When the command line does not specify what to push with `<refspec>...`
32 arguments or `--all`, `--mirror`, `--tags` options, the command finds
33 the default `<refspec>` by consulting `remote.*.push` configuration,
34 and if it is not found, honors `push.default` configuration to decide
35 what to push (See gitlink:git-config[1] for the meaning of `push.default`).
38 OPTIONS[[OPTIONS]]
39 ------------------
40 <repository>::
41         The "remote" repository that is destination of a push
42         operation.  This parameter can be either a URL
43         (see the section <<URLS,GIT URLS>> below) or the name
44         of a remote (see the section <<REMOTES,REMOTES>> below).
46 <refspec>...::
47         Specify what destination ref to update with what source object.
48         The format of a <refspec> parameter is an optional plus
49         `+`, followed by the source object <src>, followed
50         by a colon `:`, followed by the destination ref <dst>.
52 The <src> is often the name of the branch you would want to push, but
53 it can be any arbitrary "SHA-1 expression", such as `master~4` or
54 `HEAD` (see linkgit:gitrevisions[7]).
56 The <dst> tells which ref on the remote side is updated with this
57 push. Arbitrary expressions cannot be used here, an actual ref must
58 be named. If `:`<dst> is omitted, the same ref as <src> will be
59 updated.
61 The object referenced by <src> is used to update the <dst> reference
62 on the remote side.  By default this is only allowed if <dst> is not
63 a tag (annotated or lightweight), and then only if it can fast-forward
64 <dst>.  By having the optional leading `+`, you can tell Git to update
65 the <dst> ref even if it is not allowed by default (e.g., it is not a
66 fast-forward.)  This does *not* attempt to merge <src> into <dst>.  See
67 EXAMPLES below for details.
69 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
71 Pushing an empty <src> allows you to delete the <dst> ref from
72 the remote repository.
74 The special refspec `:` (or `+:` to allow non-fast-forward updates)
75 directs Git to push "matching" branches: for every branch that exists on
76 the local side, the remote side is updated if a branch of the same name
77 already exists on the remote side.
79 --all::
80         Instead of naming each ref to push, specifies that all
81         refs under `refs/heads/` be pushed.
83 --prune::
84         Remove remote branches that don't have a local counterpart. For example
85         a remote branch `tmp` will be removed if a local branch with the same
86         name doesn't exist any more. This also respects refspecs, e.g.
87         `git push --prune remote refs/heads/*:refs/tmp/*` would
88         make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
89         doesn't exist.
91 --mirror::
92         Instead of naming each ref to push, specifies that all
93         refs under `refs/` (which includes but is not
94         limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
95         be mirrored to the remote repository.  Newly created local
96         refs will be pushed to the remote end, locally updated refs
97         will be force updated on the remote end, and deleted refs
98         will be removed from the remote end.  This is the default
99         if the configuration option `remote.<remote>.mirror` is
100         set.
102 -n::
103 --dry-run::
104         Do everything except actually send the updates.
106 --porcelain::
107         Produce machine-readable output.  The output status line for each ref
108         will be tab-separated and sent to stdout instead of stderr.  The full
109         symbolic names of the refs will be given.
111 --delete::
112         All listed refs are deleted from the remote repository. This is
113         the same as prefixing all refs with a colon.
115 --tags::
116         All refs under `refs/tags` are pushed, in
117         addition to refspecs explicitly listed on the command
118         line.
120 --receive-pack=<git-receive-pack>::
121 --exec=<git-receive-pack>::
122         Path to the 'git-receive-pack' program on the remote
123         end.  Sometimes useful when pushing to a remote
124         repository over ssh, and you do not have the program in
125         a directory on the default $PATH.
127 -f::
128 --force::
129         Usually, the command refuses to update a remote ref that is
130         not an ancestor of the local ref used to overwrite it.
131         This flag disables the check.  This can cause the
132         remote repository to lose commits; use it with care.
134 --repo=<repository>::
135         This option is only relevant if no <repository> argument is
136         passed in the invocation. In this case, 'git push' derives the
137         remote name from the current branch: If it tracks a remote
138         branch, then that remote repository is pushed to. Otherwise,
139         the name "origin" is used. For this latter case, this option
140         can be used to override the name "origin". In other words,
141         the difference between these two commands
143 --------------------------
144 git push public         #1
145 git push --repo=public  #2
146 --------------------------
148 is that #1 always pushes to "public" whereas #2 pushes to "public"
149 only if the current branch does not track a remote branch. This is
150 useful if you write an alias or script around 'git push'.
152 -u::
153 --set-upstream::
154         For every branch that is up to date or successfully pushed, add
155         upstream (tracking) reference, used by argument-less
156         linkgit:git-pull[1] and other commands. For more information,
157         see 'branch.<name>.merge' in linkgit:git-config[1].
159 --thin::
160 --no-thin::
161         These options are passed to linkgit:git-send-pack[1]. A thin transfer
162         significantly reduces the amount of sent data when the sender and
163         receiver share many of the same objects in common. The default is
164         \--thin.
166 -q::
167 --quiet::
168         Suppress all output, including the listing of updated refs,
169         unless an error occurs. Progress is not reported to the standard
170         error stream.
172 -v::
173 --verbose::
174         Run verbosely.
176 --progress::
177         Progress status is reported on the standard error stream
178         by default when it is attached to a terminal, unless -q
179         is specified. This flag forces progress status even if the
180         standard error stream is not directed to a terminal.
182 --recurse-submodules=check|on-demand::
183         Make sure all submodule commits used by the revisions to be
184         pushed are available on a remote-tracking branch. If 'check' is
185         used Git will verify that all submodule commits that changed in
186         the revisions to be pushed are available on at least one remote
187         of the submodule. If any commits are missing the push will be
188         aborted and exit with non-zero status. If 'on-demand' is used
189         all submodules that changed in the revisions to be pushed will
190         be pushed. If on-demand was not able to push all necessary
191         revisions it will also be aborted and exit with non-zero status.
194 include::urls-remotes.txt[]
196 OUTPUT
197 ------
199 The output of "git push" depends on the transport method used; this
200 section describes the output when pushing over the Git protocol (either
201 locally or via ssh).
203 The status of the push is output in tabular form, with each line
204 representing the status of a single ref. Each line is of the form:
206 -------------------------------
207  <flag> <summary> <from> -> <to> (<reason>)
208 -------------------------------
210 If --porcelain is used, then each line of the output is of the form:
212 -------------------------------
213  <flag> \t <from>:<to> \t <summary> (<reason>)
214 -------------------------------
216 The status of up-to-date refs is shown only if --porcelain or --verbose
217 option is used.
219 flag::
220         A single character indicating the status of the ref:
221 (space);; for a successfully pushed fast-forward;
222 `+`;; for a successful forced update;
223 `-`;; for a successfully deleted ref;
224 `*`;; for a successfully pushed new ref;
225 `!`;; for a ref that was rejected or failed to push; and
226 `=`;; for a ref that was up to date and did not need pushing.
228 summary::
229         For a successfully pushed ref, the summary shows the old and new
230         values of the ref in a form suitable for using as an argument to
231         `git log` (this is `<old>..<new>` in most cases, and
232         `<old>...<new>` for forced non-fast-forward updates).
234 For a failed update, more details are given:
237 rejected::
238         Git did not try to send the ref at all, typically because it
239         is not a fast-forward and you did not force the update.
241 remote rejected::
242         The remote end refused the update.  Usually caused by a hook
243         on the remote side, or because the remote repository has one
244         of the following safety options in effect:
245         `receive.denyCurrentBranch` (for pushes to the checked out
246         branch), `receive.denyNonFastForwards` (for forced
247         non-fast-forward updates), `receive.denyDeletes` or
248         `receive.denyDeleteCurrent`.  See linkgit:git-config[1].
250 remote failure::
251         The remote end did not report the successful update of the ref,
252         perhaps because of a temporary error on the remote side, a
253         break in the network connection, or other transient error.
256 from::
257         The name of the local ref being pushed, minus its
258         `refs/<type>/` prefix. In the case of deletion, the
259         name of the local ref is omitted.
261 to::
262         The name of the remote ref being updated, minus its
263         `refs/<type>/` prefix.
265 reason::
266         A human-readable explanation. In the case of successfully pushed
267         refs, no explanation is needed. For a failed ref, the reason for
268         failure is described.
270 Note about fast-forwards
271 ------------------------
273 When an update changes a branch (or more in general, a ref) that used to
274 point at commit A to point at another commit B, it is called a
275 fast-forward update if and only if B is a descendant of A.
277 In a fast-forward update from A to B, the set of commits that the original
278 commit A built on top of is a subset of the commits the new commit B
279 builds on top of.  Hence, it does not lose any history.
281 In contrast, a non-fast-forward update will lose history.  For example,
282 suppose you and somebody else started at the same commit X, and you built
283 a history leading to commit B while the other person built a history
284 leading to commit A.  The history looks like this:
286 ----------------
288       B
289      /
290  ---X---A
292 ----------------
294 Further suppose that the other person already pushed changes leading to A
295 back to the original repository from which you two obtained the original
296 commit X.
298 The push done by the other person updated the branch that used to point at
299 commit X to point at commit A.  It is a fast-forward.
301 But if you try to push, you will attempt to update the branch (that
302 now points at A) with commit B.  This does _not_ fast-forward.  If you did
303 so, the changes introduced by commit A will be lost, because everybody
304 will now start building on top of B.
306 The command by default does not allow an update that is not a fast-forward
307 to prevent such loss of history.
309 If you do not want to lose your work (history from X to B) nor the work by
310 the other person (history from X to A), you would need to first fetch the
311 history from the repository, create a history that contains changes done
312 by both parties, and push the result back.
314 You can perform "git pull", resolve potential conflicts, and "git push"
315 the result.  A "git pull" will create a merge commit C between commits A
316 and B.
318 ----------------
320       B---C
321      /   /
322  ---X---A
324 ----------------
326 Updating A with the resulting merge commit will fast-forward and your
327 push will be accepted.
329 Alternatively, you can rebase your change between X and B on top of A,
330 with "git pull --rebase", and push the result back.  The rebase will
331 create a new commit D that builds the change between X and B on top of
334 ----------------
336       B   D
337      /   /
338  ---X---A
340 ----------------
342 Again, updating A with this commit will fast-forward and your push will be
343 accepted.
345 There is another common situation where you may encounter non-fast-forward
346 rejection when you try to push, and it is possible even when you are
347 pushing into a repository nobody else pushes into. After you push commit
348 A yourself (in the first picture in this section), replace it with "git
349 commit --amend" to produce commit B, and you try to push it out, because
350 forgot that you have pushed A out already. In such a case, and only if
351 you are certain that nobody in the meantime fetched your earlier commit A
352 (and started building on top of it), you can run "git push --force" to
353 overwrite it. In other words, "git push --force" is a method reserved for
354 a case where you do mean to lose history.
357 Examples
358 --------
360 `git push`::
361         Works like `git push <remote>`, where <remote> is the
362         current branch's remote (or `origin`, if no remote is
363         configured for the current branch).
365 `git push origin`::
366         Without additional configuration, works like
367         `git push origin :`.
369 The default behavior of this command when no <refspec> is given can be
370 configured by setting the `push` option of the remote, or the `push.default`
371 configuration variable.
373 For example, to default to pushing only the current branch to `origin`
374 use `git config remote.origin.push HEAD`.  Any valid <refspec> (like
375 the ones in the examples below) can be configured as the default for
376 `git push origin`.
378 `git push origin :`::
379         Push "matching" branches to `origin`. See
380         <refspec> in the <<OPTIONS,OPTIONS>> section above for a
381         description of "matching" branches.
383 `git push origin master`::
384         Find a ref that matches `master` in the source repository
385         (most likely, it would find `refs/heads/master`), and update
386         the same ref (e.g. `refs/heads/master`) in `origin` repository
387         with it.  If `master` did not exist remotely, it would be
388         created.
390 `git push origin HEAD`::
391         A handy way to push the current branch to the same name on the
392         remote.
394 `git push mothership master:satellite/master dev:satellite/dev`::
395         Use the source ref that matches `master` (e.g. `refs/heads/master`)
396         to update the ref that matches `satellite/master` (most probably
397         `refs/remotes/satellite/master`) in the `mothership` repository;
398         do the same for `dev` and `satellite/dev`.
400 This is to emulate `git fetch` run on the `mothership` using `git
401 push` that is run in the opposite direction in order to integrate
402 the work done on `satellite`, and is often necessary when you can
403 only make connection in one way (i.e. satellite can ssh into
404 mothership but mothership cannot initiate connection to satellite
405 because the latter is behind a firewall or does not run sshd).
407 After running this `git push` on the `satellite` machine, you would
408 ssh into the `mothership` and run `git merge` there to complete the
409 emulation of `git pull` that were run on `mothership` to pull changes
410 made on `satellite`.
412 `git push origin HEAD:master`::
413         Push the current branch to the remote ref matching `master` in the
414         `origin` repository. This form is convenient to push the current
415         branch without thinking about its local name.
417 `git push origin master:refs/heads/experimental`::
418         Create the branch `experimental` in the `origin` repository
419         by copying the current `master` branch.  This form is only
420         needed to create a new branch or tag in the remote repository when
421         the local name and the remote name are different; otherwise,
422         the ref name on its own will work.
424 `git push origin :experimental`::
425         Find a ref that matches `experimental` in the `origin` repository
426         (e.g. `refs/heads/experimental`), and delete it.
428 `git push origin +dev:master`::
429         Update the origin repository's master branch with the dev branch,
430         allowing non-fast-forward updates.  *This can leave unreferenced
431         commits dangling in the origin repository.*  Consider the
432         following situation, where a fast-forward is not possible:
434 ----
435             o---o---o---A---B  origin/master
436                      \
437                       X---Y---Z  dev
438 ----
440 The above command would change the origin repository to
442 ----
443                       A---B  (unnamed branch)
444                      /
445             o---o---o---X---Y---Z  master
446 ----
448 Commits A and B would no longer belong to a branch with a symbolic name,
449 and so would be unreachable.  As such, these commits would be removed by
450 a `git gc` command on the origin repository.
454 Part of the linkgit:git[1] suite