Update documentation of fetch-pack, push and send-pack
[git/gitweb.git] / Documentation / git-send-pack.txt
blobdee43a997c3fbb36890e67d80681248652476899
1 git-send-pack(1)
2 ================
4 NAME
5 ----
6 git-send-pack - Push objects over git protocol to another reposiotory
9 SYNOPSIS
10 --------
11 'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
13 DESCRIPTION
14 -----------
15 Usually you would want to use gitlink:git-push[1] which is a
16 higher level wrapper of this command instead.
18 Invokes 'git-receive-pack' on a possibly remote repository, and
19 updates it from the current repository, sending named refs.
22 OPTIONS
23 -------
24 \--exec=<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.
30 \--all::
31         Instead of explicitly specifying which refs to update,
32         update all refs that locally exist.
34 \--force::
35         Usually, the command refuses to update a remote ref that
36         is not an ancestor of the local ref used to overwrite it.
37         This flag disables the check.  What this means is that
38         the remote repository can lose commits; use it with
39         care.
41 \--verbose::
42         Run verbosely.
44 \--thin::
45         Spend extra cycles to minimize the number of objects to be sent.
46         Use it on slower connection.
48 <host>::
49         A remote host to house the repository.  When this
50         part is specified, 'git-receive-pack' is invoked via
51         ssh.
53 <directory>::
54         The repository to update.
56 <ref>...::
57         The remote refs to update.
60 Specifying the Refs
61 -------------------
63 There are three ways to specify which refs to update on the
64 remote end.
66 With '--all' flag, all refs that exist locally are transferred to
67 the remote side.  You cannot specify any '<ref>' if you use
68 this flag.
70 Without '--all' and without any '<ref>', the refs that exist
71 both on the local side and on the remote side are updated.
73 When one or more '<ref>' are specified explicitly, it can be either a
74 single pattern, or a pair of such pattern separated by a colon
75 ":" (this means that a ref name cannot have a colon in it).  A
76 single pattern '<name>' is just a shorthand for '<name>:<name>'.
78 Each pattern pair consists of the source side (before the colon)
79 and the destination side (after the colon).  The ref to be
80 pushed is determined by finding a match that matches the source
81 side, and where it is pushed is determined by using the
82 destination side.
84  - It is an error if <src> does not match exactly one of the
85    local refs.
87  - It is an error if <dst> matches more than one remote refs.
89  - If <dst> does not match any remote ref, either
91    * it has to start with "refs/"; <dst> is used as the
92      destination literally in this case.
94    * <src> == <dst> and the ref that matched the <src> must not
95      exist in the set of remote refs; the ref matched <src>
96      locally is used as the name of the destination.
98 Without '--force', the <src> ref is stored at the remote only if
99 <dst> does not exist, or <dst> is a proper subset (i.e. an
100 ancestor) of <src>.  This check, known as "fast forward check",
101 is performed in order to avoid accidentally overwriting the
102 remote ref and lose other peoples' commits from there.
104 With '--force', the fast forward check is disabled for all refs.
106 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
107 to disable the fast-forward check only on that ref.
110 Author
111 ------
112 Written by Linus Torvalds <torvalds@osdl.org>
114 Documentation
115 --------------
116 Documentation by Junio C Hamano.
120 Part of the gitlink:git[7] suite