t7500: fix flipped actual/expect
[git/mingw/j6t.git] / Documentation / git-push.txt
blobdf5be268ba69f34fe5e91c3148f8af8c1e0091d6
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] [-u | --set-upstream]
14            [--no-verify] [<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 --follow-tags::
121         Push all the refs that would be pushed without this option,
122         and also push annotated tags in `refs/tags` that are missing
123         from the remote but are pointing at committish that are
124         reachable from the refs being pushed.
126 --receive-pack=<git-receive-pack>::
127 --exec=<git-receive-pack>::
128         Path to the 'git-receive-pack' program on the remote
129         end.  Sometimes useful when pushing to a remote
130         repository over ssh, and you do not have the program in
131         a directory on the default $PATH.
133 -f::
134 --force::
135         Usually, the command refuses to update a remote ref that is
136         not an ancestor of the local ref used to overwrite it.
137         This flag disables the check.  This can cause the
138         remote repository to lose commits; use it with care.
140 --repo=<repository>::
141         This option is only relevant if no <repository> argument is
142         passed in the invocation. In this case, 'git push' derives the
143         remote name from the current branch: If it tracks a remote
144         branch, then that remote repository is pushed to. Otherwise,
145         the name "origin" is used. For this latter case, this option
146         can be used to override the name "origin". In other words,
147         the difference between these two commands
149 --------------------------
150 git push public         #1
151 git push --repo=public  #2
152 --------------------------
154 is that #1 always pushes to "public" whereas #2 pushes to "public"
155 only if the current branch does not track a remote branch. This is
156 useful if you write an alias or script around 'git push'.
158 -u::
159 --set-upstream::
160         For every branch that is up to date or successfully pushed, add
161         upstream (tracking) reference, used by argument-less
162         linkgit:git-pull[1] and other commands. For more information,
163         see 'branch.<name>.merge' in linkgit:git-config[1].
165 --[no-]thin::
166         These options are passed to linkgit:git-send-pack[1]. A thin transfer
167         significantly reduces the amount of sent data when the sender and
168         receiver share many of the same objects in common. The default is
169         \--thin.
171 -q::
172 --quiet::
173         Suppress all output, including the listing of updated refs,
174         unless an error occurs. Progress is not reported to the standard
175         error stream.
177 -v::
178 --verbose::
179         Run verbosely.
181 --progress::
182         Progress status is reported on the standard error stream
183         by default when it is attached to a terminal, unless -q
184         is specified. This flag forces progress status even if the
185         standard error stream is not directed to a terminal.
187 --recurse-submodules=check|on-demand::
188         Make sure all submodule commits used by the revisions to be
189         pushed are available on a remote-tracking branch. If 'check' is
190         used Git will verify that all submodule commits that changed in
191         the revisions to be pushed are available on at least one remote
192         of the submodule. If any commits are missing the push will be
193         aborted and exit with non-zero status. If 'on-demand' is used
194         all submodules that changed in the revisions to be pushed will
195         be pushed. If on-demand was not able to push all necessary
196         revisions it will also be aborted and exit with non-zero status.
198 --[no-]verify::
199         Toggle the pre-push hook (see linkgit:githooks[5]).  The
200         default is \--verify, giving the hook a chance to prevent the
201         push.  With \--no-verify, the hook is bypassed completely.
204 include::urls-remotes.txt[]
206 OUTPUT
207 ------
209 The output of "git push" depends on the transport method used; this
210 section describes the output when pushing over the Git protocol (either
211 locally or via ssh).
213 The status of the push is output in tabular form, with each line
214 representing the status of a single ref. Each line is of the form:
216 -------------------------------
217  <flag> <summary> <from> -> <to> (<reason>)
218 -------------------------------
220 If --porcelain is used, then each line of the output is of the form:
222 -------------------------------
223  <flag> \t <from>:<to> \t <summary> (<reason>)
224 -------------------------------
226 The status of up-to-date refs is shown only if --porcelain or --verbose
227 option is used.
229 flag::
230         A single character indicating the status of the ref:
231 (space);; for a successfully pushed fast-forward;
232 `+`;; for a successful forced update;
233 `-`;; for a successfully deleted ref;
234 `*`;; for a successfully pushed new ref;
235 `!`;; for a ref that was rejected or failed to push; and
236 `=`;; for a ref that was up to date and did not need pushing.
238 summary::
239         For a successfully pushed ref, the summary shows the old and new
240         values of the ref in a form suitable for using as an argument to
241         `git log` (this is `<old>..<new>` in most cases, and
242         `<old>...<new>` for forced non-fast-forward updates).
244 For a failed update, more details are given:
247 rejected::
248         Git did not try to send the ref at all, typically because it
249         is not a fast-forward and you did not force the update.
251 remote rejected::
252         The remote end refused the update.  Usually caused by a hook
253         on the remote side, or because the remote repository has one
254         of the following safety options in effect:
255         `receive.denyCurrentBranch` (for pushes to the checked out
256         branch), `receive.denyNonFastForwards` (for forced
257         non-fast-forward updates), `receive.denyDeletes` or
258         `receive.denyDeleteCurrent`.  See linkgit:git-config[1].
260 remote failure::
261         The remote end did not report the successful update of the ref,
262         perhaps because of a temporary error on the remote side, a
263         break in the network connection, or other transient error.
266 from::
267         The name of the local ref being pushed, minus its
268         `refs/<type>/` prefix. In the case of deletion, the
269         name of the local ref is omitted.
271 to::
272         The name of the remote ref being updated, minus its
273         `refs/<type>/` prefix.
275 reason::
276         A human-readable explanation. In the case of successfully pushed
277         refs, no explanation is needed. For a failed ref, the reason for
278         failure is described.
280 Note about fast-forwards
281 ------------------------
283 When an update changes a branch (or more in general, a ref) that used to
284 point at commit A to point at another commit B, it is called a
285 fast-forward update if and only if B is a descendant of A.
287 In a fast-forward update from A to B, the set of commits that the original
288 commit A built on top of is a subset of the commits the new commit B
289 builds on top of.  Hence, it does not lose any history.
291 In contrast, a non-fast-forward update will lose history.  For example,
292 suppose you and somebody else started at the same commit X, and you built
293 a history leading to commit B while the other person built a history
294 leading to commit A.  The history looks like this:
296 ----------------
298       B
299      /
300  ---X---A
302 ----------------
304 Further suppose that the other person already pushed changes leading to A
305 back to the original repository from which you two obtained the original
306 commit X.
308 The push done by the other person updated the branch that used to point at
309 commit X to point at commit A.  It is a fast-forward.
311 But if you try to push, you will attempt to update the branch (that
312 now points at A) with commit B.  This does _not_ fast-forward.  If you did
313 so, the changes introduced by commit A will be lost, because everybody
314 will now start building on top of B.
316 The command by default does not allow an update that is not a fast-forward
317 to prevent such loss of history.
319 If you do not want to lose your work (history from X to B) nor the work by
320 the other person (history from X to A), you would need to first fetch the
321 history from the repository, create a history that contains changes done
322 by both parties, and push the result back.
324 You can perform "git pull", resolve potential conflicts, and "git push"
325 the result.  A "git pull" will create a merge commit C between commits A
326 and B.
328 ----------------
330       B---C
331      /   /
332  ---X---A
334 ----------------
336 Updating A with the resulting merge commit will fast-forward and your
337 push will be accepted.
339 Alternatively, you can rebase your change between X and B on top of A,
340 with "git pull --rebase", and push the result back.  The rebase will
341 create a new commit D that builds the change between X and B on top of
344 ----------------
346       B   D
347      /   /
348  ---X---A
350 ----------------
352 Again, updating A with this commit will fast-forward and your push will be
353 accepted.
355 There is another common situation where you may encounter non-fast-forward
356 rejection when you try to push, and it is possible even when you are
357 pushing into a repository nobody else pushes into. After you push commit
358 A yourself (in the first picture in this section), replace it with "git
359 commit --amend" to produce commit B, and you try to push it out, because
360 forgot that you have pushed A out already. In such a case, and only if
361 you are certain that nobody in the meantime fetched your earlier commit A
362 (and started building on top of it), you can run "git push --force" to
363 overwrite it. In other words, "git push --force" is a method reserved for
364 a case where you do mean to lose history.
367 Examples
368 --------
370 `git push`::
371         Works like `git push <remote>`, where <remote> is the
372         current branch's remote (or `origin`, if no remote is
373         configured for the current branch).
375 `git push origin`::
376         Without additional configuration, works like
377         `git push origin :`.
379 The default behavior of this command when no <refspec> is given can be
380 configured by setting the `push` option of the remote, or the `push.default`
381 configuration variable.
383 For example, to default to pushing only the current branch to `origin`
384 use `git config remote.origin.push HEAD`.  Any valid <refspec> (like
385 the ones in the examples below) can be configured as the default for
386 `git push origin`.
388 `git push origin :`::
389         Push "matching" branches to `origin`. See
390         <refspec> in the <<OPTIONS,OPTIONS>> section above for a
391         description of "matching" branches.
393 `git push origin master`::
394         Find a ref that matches `master` in the source repository
395         (most likely, it would find `refs/heads/master`), and update
396         the same ref (e.g. `refs/heads/master`) in `origin` repository
397         with it.  If `master` did not exist remotely, it would be
398         created.
400 `git push origin HEAD`::
401         A handy way to push the current branch to the same name on the
402         remote.
404 `git push mothership master:satellite/master dev:satellite/dev`::
405         Use the source ref that matches `master` (e.g. `refs/heads/master`)
406         to update the ref that matches `satellite/master` (most probably
407         `refs/remotes/satellite/master`) in the `mothership` repository;
408         do the same for `dev` and `satellite/dev`.
410 This is to emulate `git fetch` run on the `mothership` using `git
411 push` that is run in the opposite direction in order to integrate
412 the work done on `satellite`, and is often necessary when you can
413 only make connection in one way (i.e. satellite can ssh into
414 mothership but mothership cannot initiate connection to satellite
415 because the latter is behind a firewall or does not run sshd).
417 After running this `git push` on the `satellite` machine, you would
418 ssh into the `mothership` and run `git merge` there to complete the
419 emulation of `git pull` that were run on `mothership` to pull changes
420 made on `satellite`.
422 `git push origin HEAD:master`::
423         Push the current branch to the remote ref matching `master` in the
424         `origin` repository. This form is convenient to push the current
425         branch without thinking about its local name.
427 `git push origin master:refs/heads/experimental`::
428         Create the branch `experimental` in the `origin` repository
429         by copying the current `master` branch.  This form is only
430         needed to create a new branch or tag in the remote repository when
431         the local name and the remote name are different; otherwise,
432         the ref name on its own will work.
434 `git push origin :experimental`::
435         Find a ref that matches `experimental` in the `origin` repository
436         (e.g. `refs/heads/experimental`), and delete it.
438 `git push origin +dev:master`::
439         Update the origin repository's master branch with the dev branch,
440         allowing non-fast-forward updates.  *This can leave unreferenced
441         commits dangling in the origin repository.*  Consider the
442         following situation, where a fast-forward is not possible:
444 ----
445             o---o---o---A---B  origin/master
446                      \
447                       X---Y---Z  dev
448 ----
450 The above command would change the origin repository to
452 ----
453                       A---B  (unnamed branch)
454                      /
455             o---o---o---X---Y---Z  master
456 ----
458 Commits A and B would no longer belong to a branch with a symbolic name,
459 and so would be unreachable.  As such, these commits would be removed by
460 a `git gc` command on the origin repository.
464 Part of the linkgit:git[1] suite