Revert bd2f73a6(Support the tools scripted in perl.)
[git/platforms.git] / Documentation / git-push.txt
blob0dd9caf86799e1648fde8895af918f6f4806d202
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] [--tags] [--receive-pack=<git-receive-pack>]
13            [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]
15 DESCRIPTION
16 -----------
18 Updates remote refs using local refs, while sending objects
19 necessary to complete the given refs.
21 You can make interesting things happen to a repository
22 every time you push into it, by setting up 'hooks' there.  See
23 documentation for gitlink:git-receive-pack[1].
26 OPTIONS
27 -------
28 <repository>::
29         The "remote" repository that is destination of a push
30         operation.  See the section <<URLS,GIT URLS>> below.
32 <refspec>::
33         The canonical format of a <refspec> parameter is
34         `+?<src>:<dst>`; that is, an optional plus `+`, followed
35         by the source ref, followed by a colon `:`, followed by
36         the destination ref.
38 The <src> side can be an
39 arbitrary "SHA1 expression" that can be used as an
40 argument to `git-cat-file -t`.  E.g. `master~4` (push
41 four parents before the current master head).
43 The local ref that matches <src> is used
44 to fast forward the remote ref that matches <dst>.  If
45 the optional plus `+` is used, the remote ref is updated
46 even if it does not result in a fast forward update.
48 Note: If no explicit refspec is found, (that is neither
49 on the command line nor in any Push line of the
50 corresponding remotes file---see below), then all the
51 refs that exist both on the local side and on the remote
52 side are updated.
54 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
56 A parameter <ref> without a colon pushes the <ref> from the source
57 repository to the destination repository under the same name.
59 Pushing an empty <src> allows you to delete the <dst> ref from
60 the remote repository.
62 \--all::
63         Instead of naming each ref to push, specifies that all
64         refs be pushed.
66 \--tags::
67         All refs under `$GIT_DIR/refs/tags` are pushed, in
68         addition to refspecs explicitly listed on the command
69         line.
71 \--receive-pack=<git-receive-pack>::
72         Path to the 'git-receive-pack' program on the remote
73         end.  Sometimes useful when pushing to a remote
74         repository over ssh, and you do not have the program in
75         a directory on the default $PATH.
77 \--exec=<git-receive-pack>::
78         Same as \--receive-pack=<git-receive-pack>.
80 -f, \--force::
81         Usually, the command refuses to update a remote ref that is
82         not an ancestor of the local ref used to overwrite it.
83         This flag disables the check.  This can cause the
84         remote repository to lose commits; use it with care.
86 \--repo=<repo>::
87         When no repository is specified the command defaults to
88         "origin"; this overrides it.
90 \--thin, \--no-thin::
91         These options are passed to `git-send-pack`.  Thin
92         transfer spends extra cycles to minimize the number of
93         objects to be sent and meant to be used on slower connection.
95 -v::
96         Run verbosely.
98 include::urls-remotes.txt[]
101 Examples
102 --------
104 git push origin master::
105         Find a ref that matches `master` in the source repository
106         (most likely, it would find `refs/heads/master`), and update
107         the same ref (e.g. `refs/heads/master`) in `origin` repository
108         with it.
110 git push origin :experimental::
111         Find a ref that matches `experimental` in the `origin` repository
112         (e.g. `refs/heads/experimental`), and delete it.
114 git push origin master:satellite/master::
115         Find a ref that matches `master` in the source repository
116         (most likely, it would find `refs/heads/master`), and update
117         the ref that matches `satellite/master` (most likely, it would
118         be `refs/remotes/satellite/master`) in `origin` repository with it.
120 Author
121 ------
122 Written by Junio C Hamano <junkio@cox.net>, later rewritten in C
123 by Linus Torvalds <torvalds@osdl.org>
125 Documentation
126 --------------
127 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
131 Part of the gitlink:git[7] suite