dir.h: move struct exclude declaration to top level
[git.git] / Documentation / git-send-pack.txt
blobdc3a568baa9c85e10bb6b53707cee9447363d0f2
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>] [--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 --verbose::
49         Run verbosely.
51 --thin::
52         Send a "thin" pack, which records objects in deltified form based
53         on objects not included in the pack to reduce network traffic.
55 <host>::
56         A remote host to house the repository.  When this
57         part is specified, 'git-receive-pack' is invoked via
58         ssh.
60 <directory>::
61         The repository to update.
63 <ref>...::
64         The remote refs to update.
67 Specifying the Refs
68 -------------------
70 There are three ways to specify which refs to update on the
71 remote end.
73 With '--all' flag, all refs that exist locally are transferred to
74 the remote side.  You cannot specify any '<ref>' if you use
75 this flag.
77 Without '--all' and without any '<ref>', the heads that exist
78 both on the local side and on the remote side are updated.
80 When one or more '<ref>' are specified explicitly, it can be either a
81 single pattern, or a pair of such pattern separated by a colon
82 ":" (this means that a ref name cannot have a colon in it).  A
83 single pattern '<name>' is just a shorthand for '<name>:<name>'.
85 Each pattern pair consists of the source side (before the colon)
86 and the destination side (after the colon).  The ref to be
87 pushed is determined by finding a match that matches the source
88 side, and where it is pushed is determined by using the
89 destination side. The rules used to match a ref are the same
90 rules used by 'git rev-parse' to resolve a symbolic ref
91 name. See linkgit:git-rev-parse[1].
93  - It is an error if <src> does not match exactly one of the
94    local refs.
96  - It is an error if <dst> matches more than one remote refs.
98  - If <dst> does not match any remote ref, either
100    * it has to start with "refs/"; <dst> is used as the
101      destination literally in this case.
103    * <src> == <dst> and the ref that matched the <src> must not
104      exist in the set of remote refs; the ref matched <src>
105      locally is used as the name of the destination.
107 Without '--force', the <src> ref is stored at the remote only if
108 <dst> does not exist, or <dst> is a proper subset (i.e. an
109 ancestor) of <src>.  This check, known as "fast-forward check",
110 is performed in order to avoid accidentally overwriting the
111 remote ref and lose other peoples' commits from there.
113 With '--force', the fast-forward check is disabled for all refs.
115 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
116 to disable the fast-forward check only on that ref.
120 Part of the linkgit:git[1] suite