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 [verse]
  12 'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
  13
  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].
  18
  19 Invokes 'git-receive-pack' on a possibly remote repository, and
  20 updates it from the current repository, sending named refs.
  21
  22
  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.
  30
  31 --exec=<git-receive-pack>::
  32         Same as \--receive-pack=<git-receive-pack>.
  33
  34 --all::
  35         Instead of explicitly specifying which refs to update,
  36         update all heads that locally exist.
  37
  38 --stdin::
  39         Take the list of refs from stdin, one per line. If there
  40         are refs specified on the command line in addition to this
  41         option, then the refs from stdin are processed after those
  42         on the command line.
  43 +
  44 If '--stateless-rpc' is specified together with this option then
  45 the list of refs must be in packet format (pkt-line). Each ref must
  46 be in a separate packet, and the list must end with a flush packet.
  47
  48 --dry-run::
  49         Do everything except actually send the updates.
  50
  51 --force::
  52         Usually, the command refuses to update a remote ref that
  53         is not an ancestor of the local ref used to overwrite it.
  54         This flag disables the check.  What this means is that
  55         the remote repository can lose commits; use it with
  56         care.
  57
  58 --verbose::
  59         Run verbosely.
  60
  61 --thin::
  62         Send a "thin" pack, which records objects in deltified form based
  63         on objects not included in the pack to reduce network traffic.
  64
  65 <host>::
  66         A remote host to house the repository.  When this
  67         part is specified, 'git-receive-pack' is invoked via
  68         ssh.
  69
  70 <directory>::
  71         The repository to update.
  72
  73 <ref>...::
  74         The remote refs to update.
  75
  76
  77 Specifying the Refs
  78 -------------------
  79
  80 There are three ways to specify which refs to update on the
  81 remote end.
  82
  83 With '--all' flag, all refs that exist locally are transferred to
  84 the remote side.  You cannot specify any '<ref>' if you use
  85 this flag.
  86
  87 Without '--all' and without any '<ref>', the heads that exist
  88 both on the local side and on the remote side are updated.
  89
  90 When one or more '<ref>' are specified explicitly (whether on the
  91 command line or via `--stdin`), it can be either a
  92 single pattern, or a pair of such pattern separated by a colon
  93 ":" (this means that a ref name cannot have a colon in it).  A
  94 single pattern '<name>' is just a shorthand for '<name>:<name>'.
  95
  96 Each pattern pair consists of the source side (before the colon)
  97 and the destination side (after the colon).  The ref to be
  98 pushed is determined by finding a match that matches the source
  99 side, and where it is pushed is determined by using the
 100 destination side. The rules used to match a ref are the same
 101 rules used by 'git rev-parse' to resolve a symbolic ref
 102 name. See linkgit:git-rev-parse[1].
 103
 104  - It is an error if <src> does not match exactly one of the
 105    local refs.
 106
 107  - It is an error if <dst> matches more than one remote refs.
 108
 109  - If <dst> does not match any remote ref, either
 110
 111    * it has to start with "refs/"; <dst> is used as the
 112      destination literally in this case.
 113
 114    * <src> == <dst> and the ref that matched the <src> must not
 115      exist in the set of remote refs; the ref matched <src>
 116      locally is used as the name of the destination.
 117
 118 Without '--force', the <src> ref is stored at the remote only if
 119 <dst> does not exist, or <dst> is a proper subset (i.e. an
 120 ancestor) of <src>.  This check, known as "fast-forward check",
 121 is performed in order to avoid accidentally overwriting the
 122 remote ref and lose other peoples' commits from there.
 123
 124 With '--force', the fast-forward check is disabled for all refs.
 125
 126 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
 127 to disable the fast-forward check only on that ref.
 128
 129 GIT
 130 ---
 131 Part of the linkgit:git[1] suite