blob: f51c64939b48b7b082752a294b17aee6d92c4fa0 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-send-pack(1)
2================
3
4NAME
5----
Junio C Hamano076ffcc2013-02-06 05:13:216git-send-pack - Push objects over Git protocol to another repository
Junio C Hamano1a4e8412005-12-27 08:17:237
8
9SYNOPSIS
10--------
Junio C Hamano15567bc2011-07-23 00:51:5911[verse]
Junio C Hamano3891e252015-08-31 23:06:1312'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>]
13[--verbose] [--thin] [--atomic]
Junio C Hamano4b2a6c12017-08-22 18:32:3714[--[no-]signed|--signed=(true|false|if-asked)]
Junio C Hamano3891e252015-08-31 23:06:1315[<host>:]<directory> [<ref>...]
Junio C Hamano1a4e8412005-12-27 08:17:2316
17DESCRIPTION
18-----------
Junio C Hamano1aa40d22010-01-21 17:46:4319Usually you would want to use 'git push', which is a
Junio C Hamanofce7c7e2008-07-02 03:06:3820higher-level wrapper of this command, instead. See linkgit:git-push[1].
Junio C Hamanoe58607f2007-01-17 23:27:4521
Junio C Hamanoba4b9282008-07-06 05:20:3122Invokes 'git-receive-pack' on a possibly remote repository, and
Junio C Hamano1a4e8412005-12-27 08:17:2323updates it from the current repository, sending named refs.
24
25
26OPTIONS
27-------
Junio C Hamanoeb415992008-06-08 22:49:4728--receive-pack=<git-receive-pack>::
Junio C Hamanoba4b9282008-07-06 05:20:3129Path to the 'git-receive-pack' program on the remote
Junio C Hamano1a4e8412005-12-27 08:17:2330end. Sometimes useful when pushing to a remote
31repository over ssh, and you do not have the program in
32a directory on the default $PATH.
33
Junio C Hamanoeb415992008-06-08 22:49:4734--exec=<git-receive-pack>::
Junio C Hamano1dbca522015-05-22 20:48:5535Same as --receive-pack=<git-receive-pack>.
Junio C Hamano4ad294b2007-01-20 02:22:5036
Junio C Hamanoeb415992008-06-08 22:49:4737--all::
Junio C Hamano1a4e8412005-12-27 08:17:2338Instead of explicitly specifying which refs to update,
Junio C Hamanod2d9ae12007-09-19 02:27:5739update all heads that locally exist.
Junio C Hamano1a4e8412005-12-27 08:17:2340
Junio C Hamanoac12f0e2014-09-19 22:32:5141--stdin::
42Take the list of refs from stdin, one per line. If there
43are refs specified on the command line in addition to this
44option, then the refs from stdin are processed after those
45on the command line.
46+
Junio C Hamano92d80372016-07-13 22:00:0547If `--stateless-rpc` is specified together with this option then
Junio C Hamanoac12f0e2014-09-19 22:32:5148the list of refs must be in packet format (pkt-line). Each ref must
49be in a separate packet, and the list must end with a flush packet.
50
Junio C Hamanoeb415992008-06-08 22:49:4751--dry-run::
Junio C Hamano764a6672007-10-23 01:23:3152Do everything except actually send the updates.
53
Junio C Hamanoeb415992008-06-08 22:49:4754--force::
Junio C Hamano1a4e8412005-12-27 08:17:2355Usually, the command refuses to update a remote ref that
56is not an ancestor of the local ref used to overwrite it.
57This flag disables the check. What this means is that
58the remote repository can lose commits; use it with
59care.
60
Junio C Hamanoeb415992008-06-08 22:49:4761--verbose::
Junio C Hamano4ad294b2007-01-20 02:22:5062Run verbosely.
63
Junio C Hamanoeb415992008-06-08 22:49:4764--thin::
Junio C Hamano4fdccb22010-02-19 09:58:1465Send a "thin" pack, which records objects in deltified form based
66on objects not included in the pack to reduce network traffic.
Junio C Hamano4ad294b2007-01-20 02:22:5067
Junio C Hamano6bb32e62015-02-17 22:11:2668--atomic::
69Use an atomic transaction for updating the refs. If any of the refs
70fails to update then the entire push will fail without changing any
71refs.
72
Junio C Hamano3891e252015-08-31 23:06:1373--[no-]signed::
Junio C Hamano4b2a6c12017-08-22 18:32:3774--signed=(true|false|if-asked)::
Junio C Hamano3891e252015-08-31 23:06:1375GPG-sign the push request to update refs on the receiving
76side, to allow it to be checked by the hooks and/or be
77logged. If `false` or `--no-signed`, no signing will be
78attempted. If `true` or `--signed`, the push will fail if the
79server does not support signed pushes. If set to `if-asked`,
80sign if and only if the server supports signed pushes. The push
81will also fail if the actual call to `gpg --sign` fails. See
82linkgit:git-receive-pack[1] for the details on the receiving end.
83
Junio C Hamano7ab74c42017-03-27 18:23:5984--push-option=<string>::
85Pass the specified string as a push option for consumption by
86hooks on the server side. If the server doesn't support push
87options, error out. See linkgit:git-push[1] and
88linkgit:githooks[5] for details.
89
Junio C Hamano1a4e8412005-12-27 08:17:2390<host>::
91A remote host to house the repository. When this
Junio C Hamanoba4b9282008-07-06 05:20:3192part is specified, 'git-receive-pack' is invoked via
Junio C Hamano1a4e8412005-12-27 08:17:2393ssh.
94
95<directory>::
96The repository to update.
97
Junio C Hamano21c0b422006-10-12 19:10:3698<ref>...::
Junio C Hamano1a4e8412005-12-27 08:17:2399The remote refs to update.
100
101
102Specifying the Refs
103-------------------
104
105There are three ways to specify which refs to update on the
106remote end.
107
Junio C Hamano92d80372016-07-13 22:00:05108With `--all` flag, all refs that exist locally are transferred to
Junio C Hamano1a4e8412005-12-27 08:17:23109the remote side. You cannot specify any '<ref>' if you use
110this flag.
111
Junio C Hamano92d80372016-07-13 22:00:05112Without `--all` and without any '<ref>', the heads that exist
Junio C Hamano1a4e8412005-12-27 08:17:23113both on the local side and on the remote side are updated.
114
Junio C Hamanoac12f0e2014-09-19 22:32:51115When one or more '<ref>' are specified explicitly (whether on the
116command line or via `--stdin`), it can be either a
Junio C Hamano1a4e8412005-12-27 08:17:23117single pattern, or a pair of such pattern separated by a colon
118":" (this means that a ref name cannot have a colon in it). A
119single pattern '<name>' is just a shorthand for '<name>:<name>'.
120
121Each pattern pair consists of the source side (before the colon)
122and the destination side (after the colon). The ref to be
123pushed is determined by finding a match that matches the source
124side, and where it is pushed is determined by using the
Junio C Hamanoe0facb92007-12-05 10:59:48125destination side. The rules used to match a ref are the same
Junio C Hamano1aa40d22010-01-21 17:46:43126rules used by 'git rev-parse' to resolve a symbolic ref
Junio C Hamanofce7c7e2008-07-02 03:06:38127name. See linkgit:git-rev-parse[1].
Junio C Hamano1a4e8412005-12-27 08:17:23128
129 - It is an error if <src> does not match exactly one of the
130 local refs.
131
132 - It is an error if <dst> matches more than one remote refs.
133
134 - If <dst> does not match any remote ref, either
135
136 * it has to start with "refs/"; <dst> is used as the
137 destination literally in this case.
138
139 * <src> == <dst> and the ref that matched the <src> must not
140 exist in the set of remote refs; the ref matched <src>
141 locally is used as the name of the destination.
142
Junio C Hamano92d80372016-07-13 22:00:05143Without `--force`, the <src> ref is stored at the remote only if
Junio C Hamano1a4e8412005-12-27 08:17:23144<dst> does not exist, or <dst> is a proper subset (i.e. an
Junio C Hamano3f680f32009-11-16 02:10:54145ancestor) of <src>. This check, known as "fast-forward check",
Junio C Hamano1a4e8412005-12-27 08:17:23146is performed in order to avoid accidentally overwriting the
147remote ref and lose other peoples' commits from there.
148
Junio C Hamano92d80372016-07-13 22:00:05149With `--force`, the fast-forward check is disabled for all refs.
Junio C Hamano1a4e8412005-12-27 08:17:23150
151Optionally, a <ref> parameter can be prefixed with a plus '+' sign
152to disable the fast-forward check only on that ref.
153
Junio C Hamano1a4e8412005-12-27 08:17:23154GIT
155---
Junio C Hamanof7c042d2008-06-06 22:50:53156Part of the linkgit:git[1] suite