Documentation/push: clarify matching refspec behavior
[git/git.git] / Documentation / git-push.txt
CommitLineData
215a7ad1
JH
1git-push(1)
2===========
7fc9d69f
JH
3
4NAME
5----
7bd7f280 6git-push - Update remote refs along with associated objects
7fc9d69f
JH
7
8
9SYNOPSIS
10--------
97925fde 11[verse]
11f2441f 12'git-push' [--all] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>]
05ee917a 13 [--repo=all] [-f | --force] [-v | --verbose] [<repository> <refspec>...]
7fc9d69f
JH
14
15DESCRIPTION
16-----------
ab9b3138
JH
17
18Updates remote refs using local refs, while sending objects
19necessary to complete the given refs.
7fc9d69f 20
cc55aaec 21You can make interesting things happen to a repository
eb0362a4 22every time you push into it, by setting up 'hooks' there. See
5162e697 23documentation for linkgit:git-receive-pack[1].
eb0362a4 24
7fc9d69f
JH
25
26OPTIONS
27-------
3598a308 28<repository>::
85a97d4e
BF
29 The "remote" repository that is destination of a push
30 operation. See the section <<URLS,GIT URLS>> below.
3598a308
BF
31
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.
37+
38The <src> side can be an
39arbitrary "SHA1 expression" that can be used as an
40argument to `git-cat-file -t`. E.g. `master~4` (push
41four parents before the current master head).
42+
43The local ref that matches <src> is used
44to fast forward the remote ref that matches <dst>. If
45the optional plus `+` is used, the remote ref is updated
46even if it does not result in a fast forward update.
47+
aa064743
CW
48Note: If no explicit refspec is found, (that is neither
49on the command line nor in any Push line of the
68d06c52
JK
50corresponding remotes file---see below), then "matching" heads are
51pushed: for every head that exists on the local side, the remote side is
52updated if a head of the same name already exists on the remote side.
aa064743 53+
25fb6290 54`tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
3598a308 55+
bb9fca80
JH
56A parameter <ref> without a colon pushes the <ref> from the source
57repository to the destination repository under the same name.
25fb6290
JH
58+
59Pushing an empty <src> allows you to delete the <dst> ref from
60the remote repository.
7fc9d69f 61
d6a73596 62\--all::
cc55aaec 63 Instead of naming each ref to push, specifies that all
5c633a4c 64 refs under `$GIT_DIR/refs/heads/` be pushed.
d6a73596 65
ff206748
AW
66\--mirror::
67 Instead of naming each ref to push, specifies that all
68 refs under `$GIT_DIR/refs/heads/` and `$GIT_DIR/refs/tags/`
69 be mirrored to the remote repository. Newly created local
70 refs will be pushed to the remote end, locally updated refs
71 will be force updated on the remote end, and deleted refs
72 will be removed from the remote end.
73
11f2441f
BE
74\--dry-run::
75 Do everything except actually send the updates.
76
42301e34
JH
77\--tags::
78 All refs under `$GIT_DIR/refs/tags` are pushed, in
79 addition to refspecs explicitly listed on the command
80 line.
81
d23842fd 82\--receive-pack=<git-receive-pack>::
5214f770
UKK
83 Path to the 'git-receive-pack' program on the remote
84 end. Sometimes useful when pushing to a remote
85 repository over ssh, and you do not have the program in
86 a directory on the default $PATH.
87
d23842fd
UKK
88\--exec=<git-receive-pack>::
89 Same as \--receive-pack=<git-receive-pack>.
90
d6a73596 91-f, \--force::
f0fff36e 92 Usually, the command refuses to update a remote ref that is
64a476e6 93 not an ancestor of the local ref used to overwrite it.
f0fff36e
BF
94 This flag disables the check. This can cause the
95 remote repository to lose commits; use it with care.
7fc9d69f 96
dc36f265
JH
97\--repo=<repo>::
98 When no repository is specified the command defaults to
99 "origin"; this overrides it.
100
101\--thin, \--no-thin::
102 These options are passed to `git-send-pack`. Thin
103 transfer spends extra cycles to minimize the number of
104 objects to be sent and meant to be used on slower connection.
105
05ee917a 106-v, \--verbose::
dc36f265
JH
107 Run verbosely.
108
37ba0561 109include::urls-remotes.txt[]
eb0362a4 110
bb9fca80
JH
111
112Examples
113--------
114
115git push origin master::
116 Find a ref that matches `master` in the source repository
117 (most likely, it would find `refs/heads/master`), and update
118 the same ref (e.g. `refs/heads/master`) in `origin` repository
119 with it.
120
121git push origin :experimental::
122 Find a ref that matches `experimental` in the `origin` repository
123 (e.g. `refs/heads/experimental`), and delete it.
124
125git push origin master:satellite/master::
126 Find a ref that matches `master` in the source repository
127 (most likely, it would find `refs/heads/master`), and update
128 the ref that matches `satellite/master` (most likely, it would
129 be `refs/remotes/satellite/master`) in `origin` repository with it.
130
4e560158
SP
131git push origin master:refs/heads/experimental::
132 Create the branch `experimental` in the `origin` repository
133 by copying the current `master` branch. This form is usually
134 needed to create a new branch in the remote repository as
135 there is no `experimental` branch to match.
136
7fc9d69f
JH
137Author
138------
25fb6290
JH
139Written by Junio C Hamano <junkio@cox.net>, later rewritten in C
140by Linus Torvalds <torvalds@osdl.org>
7fc9d69f
JH
141
142Documentation
143--------------
144Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
145
146GIT
147---
5162e697 148Part of the linkgit:git[7] suite