[PATCH] Random documentation fixes
[git/dkf.git] / Documentation / git-send-pack.txt
blob219dfc2ef6541216f2c46329e3e82664232b4b35
1 git-send-pack(1)
2 ================
3 v0.1, July 2005
5 NAME
6 ----
7 git-send-pack - Push missing objects packed.
10 SYNOPSIS
11 --------
12 'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [<host>:]<directory> [<ref>...]
14 DESCRIPTION
15 -----------
16 Invokes 'git-receive-pack' on a possibly remote repository, and
17 updates it from the current repository, sending named refs.
20 OPTIONS
21 -------
22 --exec=<git-receive-pack>::
23         Path to the 'git-receive-pack' program on the remote
24         end.  Sometimes useful when pushing to a remote
25         repository over ssh, and you do not have the program in
26         a directory on the default $PATH.
28 --all::
29         Instead of explicitly specifying which refs to update,
30         update all refs that locally exist.
32 --force::
33         Usually, the command refuses to update a remote ref that
34         is not an ancestor of the local ref used to overwrite it.
35         This flag disables the check.  What this means is that
36         the remote repository can lose commits; use it with
37         care.
39 <host>::
40         A remote host to house the repository.  When this
41         part is specified, 'git-receive-pack' is invoked via
42         ssh.
44 <directory>::
45         The repository to update.
47 <ref>...:
48         The remote refs to update.
51 Specifying the Refs
52 -------------------
54 There are three ways to specify which refs to update on the
55 remote end.
57 With '--all' flag, all refs that exist locally are transfered to
58 the remote side.  You cannot specify any '<ref>' if you use
59 this flag.
61 Without '--all' and without any '<ref>', the refs that exist
62 both on the local side and on the remote side are updated.
64 When one or more '<ref>' are specified explicitly, it can be either a
65 single pattern, or a pair of such pattern separated by a colon
66 ":" (this means that a ref name cannot have a colon in it).  A
67 single pattern '<name>' is just a shorthand for '<name>:<name>'.
69 Each pattern pair consists of the source side (before the colon)
70 and the destination side (after the colon).  The ref to be
71 pushed is determined by finding a match that matches the source
72 side, and where it is pushed is determined by using the
73 destination side.
75  - It is an error if <src> does not match exactly one of the
76    local refs.
78  - It is an error if <dst> matches more than one remote refs.
80  - If <dst> does not match any remote ref, either
82    * it has to start with "refs/"; <dst> is used as the
83      destination literally in this case.
85    * <src> == <dst> and the ref that matched the <src> must not
86      exist in the set of remote refs; the ref matched <src>
87      locally is used as the name of the destination.
89 Without '--force', the <src> ref is stored at the remote only if
90 <dst> does not exist, or <dst> is a proper subset (i.e. an
91 ancestor) of <src>.  This check, known as "fast forward check",
92 is performed in order to avoid accidentally overwriting the
93 remote ref and lose other peoples' commits from there.
95 With '--force', the fast forward check is disabled for all refs.
97 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
98 to disable the fast-forward check only on that ref.
101 Author
102 ------
103 Written by Linus Torvalds <torvalds@osdl.org>
105 Documentation
106 --------------
107 Documentation by Junio C Hamano.
111 Part of the gitlink:git[7] suite