remove logical typo in documentation of sample update hook
[git] / Documentation / git-send-pack.txt
1 git-send-pack(1)
2 ================
3
4 NAME
5 ----
6 git-send-pack - Push objects over git protocol to another repository
7
8
9 SYNOPSIS
10 --------
11 'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
12
13 DESCRIPTION
14 -----------
15 Usually you would want to use 'git-push', which is a
16 higher-level wrapper of this command, instead. See linkgit:git-push[1].
17
18 Invokes 'git-receive-pack' on a possibly remote repository, and
19 updates it from the current repository, sending named refs.
20
21
22 OPTIONS
23 -------
24 --receive-pack=<git-receive-pack>::
25         Path to the 'git-receive-pack' program on the remote
26         end.  Sometimes useful when pushing to a remote
27         repository over ssh, and you do not have the program in
28         a directory on the default $PATH.
29
30 --exec=<git-receive-pack>::
31         Same as \--receive-pack=<git-receive-pack>.
32
33 --all::
34         Instead of explicitly specifying which refs to update,
35         update all heads that locally exist.
36
37 --dry-run::
38         Do everything except actually send the updates.
39
40 --force::
41         Usually, the command refuses to update a remote ref that
42         is not an ancestor of the local ref used to overwrite it.
43         This flag disables the check.  What this means is that
44         the remote repository can lose commits; use it with
45         care.
46
47 --verbose::
48         Run verbosely.
49
50 --thin::
51         Spend extra cycles to minimize the number of objects to be sent.
52         Use it on slower connection.
53
54 <host>::
55         A remote host to house the repository.  When this
56         part is specified, 'git-receive-pack' is invoked via
57         ssh.
58
59 <directory>::
60         The repository to update.
61
62 <ref>...::
63         The remote refs to update.
64
65
66 Specifying the Refs
67 -------------------
68
69 There are three ways to specify which refs to update on the
70 remote end.
71
72 With '--all' flag, all refs that exist locally are transferred to
73 the remote side.  You cannot specify any '<ref>' if you use
74 this flag.
75
76 Without '--all' and without any '<ref>', the heads that exist
77 both on the local side and on the remote side are updated.
78
79 When one or more '<ref>' are specified explicitly, it can be either a
80 single pattern, or a pair of such pattern separated by a colon
81 ":" (this means that a ref name cannot have a colon in it).  A
82 single pattern '<name>' is just a shorthand for '<name>:<name>'.
83
84 Each pattern pair consists of the source side (before the colon)
85 and the destination side (after the colon).  The ref to be
86 pushed is determined by finding a match that matches the source
87 side, and where it is pushed is determined by using the
88 destination side. The rules used to match a ref are the same
89 rules used by 'git-rev-parse' to resolve a symbolic ref
90 name. See linkgit:git-rev-parse[1].
91
92  - It is an error if <src> does not match exactly one of the
93    local refs.
94
95  - It is an error if <dst> matches more than one remote refs.
96
97  - If <dst> does not match any remote ref, either
98
99    * it has to start with "refs/"; <dst> is used as the
100      destination literally in this case.
101
102    * <src> == <dst> and the ref that matched the <src> must not
103      exist in the set of remote refs; the ref matched <src>
104      locally is used as the name of the destination.
105
106 Without '--force', the <src> ref is stored at the remote only if
107 <dst> does not exist, or <dst> is a proper subset (i.e. an
108 ancestor) of <src>.  This check, known as "fast forward check",
109 is performed in order to avoid accidentally overwriting the
110 remote ref and lose other peoples' commits from there.
111
112 With '--force', the fast forward check is disabled for all refs.
113
114 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
115 to disable the fast-forward check only on that ref.
116
117
118 Author
119 ------
120 Written by Linus Torvalds <torvalds@osdl.org>
121
122 Documentation
123 --------------
124 Documentation by Junio C Hamano.
125
126 GIT
127 ---
128 Part of the linkgit:git[1] suite