Documentation/git-push.txt

   1 git-push(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-push - Update remote refs along with associated objects
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git-push' [--all] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>]
  13            [--repo=all] [-f | --force] [-v | --verbose] [<repository> <refspec>...]
  14
  15 DESCRIPTION
  16 -----------
  17
  18 Updates remote refs using local refs, while sending objects
  19 necessary to complete the given refs.
  20
  21 You can make interesting things happen to a repository
  22 every time you push into it, by setting up 'hooks' there.  See
  23 documentation for linkgit:git-receive-pack[1].
  24
  25
  26 OPTIONS
  27 -------
  28 <repository>::
  29         The "remote" repository that is destination of a push
  30         operation.  See the section <<URLS,GIT URLS>> below.
  31
  32 <refspec>::
  33         The canonical format of a <refspec> parameter is
  34         `+?<src>:<dst>`; that is, an optional plus `+`, followed
  35         by the source ref, followed by a colon `:`, followed by
  36         the destination ref.
  37 +
  38 The <src> side represents the source branch (or arbitrary
  39 "SHA1 expression", such as `master~4` (four parents before the
  40 tip of `master` branch); see linkgit:git-rev-parse[1]) that you
  41 want to push.  The <dst> side represents the destination location.
  42 +
  43 The local ref that matches <src> is used
  44 to fast forward the remote ref that matches <dst> (or, if no <dst> was
  45 specified, the same ref that <src> referred to locally).  If
  46 the optional leading plus `+` is used, the remote ref is updated
  47 even if it does not result in a fast forward update.
  48 +
  49 Note: If no explicit refspec is found, (that is neither
  50 on the command line nor in any Push line of the
  51 corresponding remotes file---see below), then "matching" heads are
  52 pushed: for every head that exists on the local side, the remote side is
  53 updated if a head of the same name already exists on the remote side.
  54 +
  55 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
  56 +
  57 A parameter <ref> without a colon pushes the <ref> from the source
  58 repository to the destination repository under the same name.
  59 +
  60 Pushing an empty <src> allows you to delete the <dst> ref from
  61 the remote repository.
  62
  63 \--all::
  64         Instead of naming each ref to push, specifies that all
  65         refs under `$GIT_DIR/refs/heads/` be pushed.
  66
  67 \--mirror::
  68         Instead of naming each ref to push, specifies that all
  69         refs under `$GIT_DIR/refs/heads/` and `$GIT_DIR/refs/tags/`
  70         be mirrored to the remote repository.  Newly created local
  71         refs will be pushed to the remote end, locally updated refs
  72         will be force updated on the remote end, and deleted refs
  73         will be removed from the remote end.
  74
  75 \--dry-run::
  76         Do everything except actually send the updates.
  77
  78 \--tags::
  79         All refs under `$GIT_DIR/refs/tags` are pushed, in
  80         addition to refspecs explicitly listed on the command
  81         line.
  82
  83 \--receive-pack=<git-receive-pack>::
  84         Path to the 'git-receive-pack' program on the remote
  85         end.  Sometimes useful when pushing to a remote
  86         repository over ssh, and you do not have the program in
  87         a directory on the default $PATH.
  88
  89 \--exec=<git-receive-pack>::
  90         Same as \--receive-pack=<git-receive-pack>.
  91
  92 -f, \--force::
  93         Usually, the command refuses to update a remote ref that is
  94         not an ancestor of the local ref used to overwrite it.
  95         This flag disables the check.  This can cause the
  96         remote repository to lose commits; use it with care.
  97
  98 \--repo=<repo>::
  99         When no repository is specified the command defaults to
 100         "origin"; this overrides it.
 101
 102 \--thin, \--no-thin::
 103         These options are passed to `git-send-pack`.  Thin
 104         transfer spends extra cycles to minimize the number of
 105         objects to be sent and meant to be used on slower connection.
 106
 107 -v, \--verbose::
 108         Run verbosely.
 109
 110 include::urls-remotes.txt[]
 111
 112 OUTPUT
 113 ------
 114
 115 The output of "git push" depends on the transport method used; this
 116 section describes the output when pushing over the git protocol (either
 117 locally or via ssh).
 118
 119 The status of the push is output in tabular form, with each line
 120 representing the status of a single ref. Each line is of the form:
 121
 122 -------------------------------
 123  <flag> <summary> <from> -> <to> (<reason>)
 124 -------------------------------
 125
 126 flag::
 127         A single character indicating the status of the ref. This is
 128         blank for a successfully pushed ref, `!` for a ref that was
 129         rejected or failed to push, and '=' for a ref that was up to
 130         date and did not need pushing (note that the status of up to
 131         date refs is shown only when `git push` is running verbosely).
 132
 133 summary::
 134         For a successfully pushed ref, the summary shows the old and new
 135         values of the ref in a form suitable for using as an argument to
 136         `git log` (this is `<old>..<new>` in most cases, and
 137         `<old>...<new>` for forced non-fast forward updates). For a
 138         failed update, more details are given for the failure.
 139         The string `rejected` indicates that git did not try to send the
 140         ref at all (typically because it is not a fast forward). The
 141         string `remote rejected` indicates that the remote end refused
 142         the update; this rejection is typically caused by a hook on the
 143         remote side. The string `remote failure` indicates that the
 144         remote end did not report the successful update of the ref
 145         (perhaps because of a temporary error on the remote side, a
 146         break in the network connection, or other transient error).
 147
 148 from::
 149         The name of the local ref being pushed, minus its
 150         `refs/<type>/` prefix. In the case of deletion, the
 151         name of the local ref is omitted.
 152
 153 to::
 154         The name of the remote ref being updated, minus its
 155         `refs/<type>/` prefix.
 156
 157 reason::
 158         A human-readable explanation. In the case of successfully pushed
 159         refs, no explanation is needed. For a failed ref, the reason for
 160         failure is described.
 161
 162 Examples
 163 --------
 164
 165 git push origin master::
 166         Find a ref that matches `master` in the source repository
 167         (most likely, it would find `refs/heads/master`), and update
 168         the same ref (e.g. `refs/heads/master`) in `origin` repository
 169         with it.  If `master` did not exist remotely, it would be
 170         created.
 171
 172 git push origin :experimental::
 173         Find a ref that matches `experimental` in the `origin` repository
 174         (e.g. `refs/heads/experimental`), and delete it.
 175
 176 git push origin master:satellite/master::
 177         Find a ref that matches `master` in the source repository
 178         (most likely, it would find `refs/heads/master`), and update
 179         the ref that matches `satellite/master` (most likely, it would
 180         be `refs/remotes/satellite/master`) in `origin` repository with it.
 181
 182 git push origin master:refs/heads/experimental::
 183         Create the branch `experimental` in the `origin` repository
 184         by copying the current `master` branch.  This form is only
 185         needed to create a new branch or tag in the remote repository when
 186         the local name and the remote name are different; otherwise,
 187         the ref name on its own will work.
 188
 189 Author
 190 ------
 191 Written by Junio C Hamano <junkio@cox.net>, later rewritten in C
 192 by Linus Torvalds <torvalds@osdl.org>
 193
 194 Documentation
 195 --------------
 196 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 197
 198 GIT
 199 ---
 200 Part of the linkgit:git[7] suite