Code

Merge branch 'cb/maint-quiet-push'
[git.git] / Documentation / git-send-pack.txt
1 git-send-pack(1)
2 ================
4 NAME
5 ----
6 git-send-pack - Push objects over git protocol to another repository
9 SYNOPSIS
10 --------
11 [verse]
12 'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--quiet] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
14 DESCRIPTION
15 -----------
16 Usually you would want to use 'git push', which is a
17 higher-level wrapper of this command, instead. See linkgit:git-push[1].
19 Invokes 'git-receive-pack' on a possibly remote repository, and
20 updates it from the current repository, sending named refs.
23 OPTIONS
24 -------
25 --receive-pack=<git-receive-pack>::
26         Path to the 'git-receive-pack' program on the remote
27         end.  Sometimes useful when pushing to a remote
28         repository over ssh, and you do not have the program in
29         a directory on the default $PATH.
31 --exec=<git-receive-pack>::
32         Same as \--receive-pack=<git-receive-pack>.
34 --all::
35         Instead of explicitly specifying which refs to update,
36         update all heads that locally exist.
38 --dry-run::
39         Do everything except actually send the updates.
41 --force::
42         Usually, the command refuses to update a remote ref that
43         is not an ancestor of the local ref used to overwrite it.
44         This flag disables the check.  What this means is that
45         the remote repository can lose commits; use it with
46         care.
48 --quiet::
49         Print only error messages.
51 --verbose::
52         Run verbosely.
54 --thin::
55         Send a "thin" pack, which records objects in deltified form based
56         on objects not included in the pack to reduce network traffic.
58 <host>::
59         A remote host to house the repository.  When this
60         part is specified, 'git-receive-pack' is invoked via
61         ssh.
63 <directory>::
64         The repository to update.
66 <ref>...::
67         The remote refs to update.
70 Specifying the Refs
71 -------------------
73 There are three ways to specify which refs to update on the
74 remote end.
76 With '--all' flag, all refs that exist locally are transferred to
77 the remote side.  You cannot specify any '<ref>' if you use
78 this flag.
80 Without '--all' and without any '<ref>', the heads that exist
81 both on the local side and on the remote side are updated.
83 When one or more '<ref>' are specified explicitly, it can be either a
84 single pattern, or a pair of such pattern separated by a colon
85 ":" (this means that a ref name cannot have a colon in it).  A
86 single pattern '<name>' is just a shorthand for '<name>:<name>'.
88 Each pattern pair consists of the source side (before the colon)
89 and the destination side (after the colon).  The ref to be
90 pushed is determined by finding a match that matches the source
91 side, and where it is pushed is determined by using the
92 destination side. The rules used to match a ref are the same
93 rules used by 'git rev-parse' to resolve a symbolic ref
94 name. See linkgit:git-rev-parse[1].
96  - It is an error if <src> does not match exactly one of the
97    local refs.
99  - It is an error if <dst> matches more than one remote refs.
101  - If <dst> does not match any remote ref, either
103    * it has to start with "refs/"; <dst> is used as the
104      destination literally in this case.
106    * <src> == <dst> and the ref that matched the <src> must not
107      exist in the set of remote refs; the ref matched <src>
108      locally is used as the name of the destination.
110 Without '--force', the <src> ref is stored at the remote only if
111 <dst> does not exist, or <dst> is a proper subset (i.e. an
112 ancestor) of <src>.  This check, known as "fast-forward check",
113 is performed in order to avoid accidentally overwriting the
114 remote ref and lose other peoples' commits from there.
116 With '--force', the fast-forward check is disabled for all refs.
118 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
119 to disable the fast-forward check only on that ref.
121 GIT
122 ---
123 Part of the linkgit:git[1] suite