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 | --mirror | --tags] [--dry-run] [--receive-pack=<git-receive-pack>]
  13            [--repo=<repository>] [-f | --force] [-v | --verbose]
  14            [<repository> <refspec>...]
  15
  16 DESCRIPTION
  17 -----------
  18
  19 Updates remote refs using local refs, while sending objects
  20 necessary to complete the given refs.
  21
  22 You can make interesting things happen to a repository
  23 every time you push into it, by setting up 'hooks' there.  See
  24 documentation for linkgit:git-receive-pack[1].
  25
  26
  27 OPTIONS[[OPTIONS]]
  28 ------------------
  29 <repository>::
  30         The "remote" repository that is destination of a push
  31         operation.  This parameter can be either a URL
  32         (see the section <<URLS,GIT URLS>> below) or the name
  33         of a remote (see the section <<REMOTES,REMOTES>> below).
  34
  35 <refspec>...::
  36         The format of a <refspec> parameter is an optional plus
  37         `{plus}`, followed by the source ref <src>, followed
  38         by a colon `:`, followed by the destination ref <dst>.
  39         It is used to specify with what <src> object the <dst> ref
  40         in the remote repository is to be updated.
  41 +
  42 The <src> is often the name of the branch you would want to push, but
  43 it can be any arbitrary "SHA-1 expression", such as `master~4` or
  44 `HEAD` (see linkgit:git-rev-parse[1]).
  45 +
  46 The <dst> tells which ref on the remote side is updated with this
  47 push. Arbitrary expressions cannot be used here, an actual ref must
  48 be named. If `:`<dst> is omitted, the same ref as <src> will be
  49 updated.
  50 +
  51 The object referenced by <src> is used to update the <dst> reference
  52 on the remote side, but by default this is only allowed if the
  53 update can fast forward <dst>.  By having the optional leading `{plus}`,
  54 you can tell git to update the <dst> ref even when the update is not a
  55 fast forward.  This does *not* attempt to merge <src> into <dst>.  See
  56 EXAMPLES below for details.
  57 +
  58 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
  59 +
  60 Pushing an empty <src> allows you to delete the <dst> ref from
  61 the remote repository.
  62 +
  63 The special refspec `:` (or `{plus}:` to allow non-fast forward updates)
  64 directs git to push "matching" branches: for every branch that exists on
  65 the local side, the remote side is updated if a branch of the same name
  66 already exists on the remote side.  This is the default operation mode
  67 if no explicit refspec is found (that is neither on the command line
  68 nor in any Push line of the corresponding remotes file---see below).
  69
  70 --all::
  71         Instead of naming each ref to push, specifies that all
  72         refs under `$GIT_DIR/refs/heads/` be pushed.
  73
  74 --mirror::
  75         Instead of naming each ref to push, specifies that all
  76         refs under `$GIT_DIR/refs/` (which includes but is not
  77         limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
  78         be mirrored to the remote repository.  Newly created local
  79         refs will be pushed to the remote end, locally updated refs
  80         will be force updated on the remote end, and deleted refs
  81         will be removed from the remote end.  This is the default
  82         if the configuration option `remote.<remote>.mirror` is
  83         set.
  84
  85 --dry-run::
  86         Do everything except actually send the updates.
  87
  88 --tags::
  89         All refs under `$GIT_DIR/refs/tags` are pushed, in
  90         addition to refspecs explicitly listed on the command
  91         line.
  92
  93 --receive-pack=<git-receive-pack>::
  94 --exec=<git-receive-pack>::
  95         Path to the 'git-receive-pack' program on the remote
  96         end.  Sometimes useful when pushing to a remote
  97         repository over ssh, and you do not have the program in
  98         a directory on the default $PATH.
  99
 100 -f::
 101 --force::
 102         Usually, the command refuses to update a remote ref that is
 103         not an ancestor of the local ref used to overwrite it.
 104         This flag disables the check.  This can cause the
 105         remote repository to lose commits; use it with care.
 106
 107 --repo=<repository>::
 108         This option is only relevant if no <repository> argument is
 109         passed in the invocation. In this case, 'git-push' derives the
 110         remote name from the current branch: If it tracks a remote
 111         branch, then that remote repository is pushed to. Otherwise,
 112         the name "origin" is used. For this latter case, this option
 113         can be used to override the name "origin". In other words,
 114         the difference between these two commands
 115 +
 116 --------------------------
 117 git push public         #1
 118 git push --repo=public  #2
 119 --------------------------
 120 +
 121 is that #1 always pushes to "public" whereas #2 pushes to "public"
 122 only if the current branch does not track a remote branch. This is
 123 useful if you write an alias or script around 'git-push'.
 124
 125 --thin::
 126 --no-thin::
 127         These options are passed to 'git-send-pack'.  Thin
 128         transfer spends extra cycles to minimize the number of
 129         objects to be sent and meant to be used on slower connection.
 130
 131 -v::
 132 --verbose::
 133         Run verbosely.
 134
 135 include::urls-remotes.txt[]
 136
 137 OUTPUT
 138 ------
 139
 140 The output of "git push" depends on the transport method used; this
 141 section describes the output when pushing over the git protocol (either
 142 locally or via ssh).
 143
 144 The status of the push is output in tabular form, with each line
 145 representing the status of a single ref. Each line is of the form:
 146
 147 -------------------------------
 148  <flag> <summary> <from> -> <to> (<reason>)
 149 -------------------------------
 150
 151 flag::
 152         A single character indicating the status of the ref. This is
 153         blank for a successfully pushed ref, `!` for a ref that was
 154         rejected or failed to push, and '=' for a ref that was up to
 155         date and did not need pushing (note that the status of up to
 156         date refs is shown only when `git push` is running verbosely).
 157
 158 summary::
 159         For a successfully pushed ref, the summary shows the old and new
 160         values of the ref in a form suitable for using as an argument to
 161         `git log` (this is `<old>..<new>` in most cases, and
 162         `<old>...<new>` for forced non-fast forward updates). For a
 163         failed update, more details are given for the failure.
 164         The string `rejected` indicates that git did not try to send the
 165         ref at all (typically because it is not a fast forward). The
 166         string `remote rejected` indicates that the remote end refused
 167         the update; this rejection is typically caused by a hook on the
 168         remote side. The string `remote failure` indicates that the
 169         remote end did not report the successful update of the ref
 170         (perhaps because of a temporary error on the remote side, a
 171         break in the network connection, or other transient error).
 172
 173 from::
 174         The name of the local ref being pushed, minus its
 175         `refs/<type>/` prefix. In the case of deletion, the
 176         name of the local ref is omitted.
 177
 178 to::
 179         The name of the remote ref being updated, minus its
 180         `refs/<type>/` prefix.
 181
 182 reason::
 183         A human-readable explanation. In the case of successfully pushed
 184         refs, no explanation is needed. For a failed ref, the reason for
 185         failure is described.
 186
 187 Examples
 188 --------
 189
 190 git push::
 191         Works like `git push <remote>`, where <remote> is the
 192         current branch's remote (or `origin`, if no remote is
 193         configured for the current branch).
 194
 195 git push origin::
 196         Without additional configuration, works like
 197         `git push origin :`.
 198 +
 199 The default behavior of this command when no <refspec> is given can be
 200 configured by setting the `push` option of the remote.
 201 +
 202 For example, to default to pushing only the current branch to `origin`
 203 use `git config remote.origin.push HEAD`.  Any valid <refspec> (like
 204 the ones in the examples below) can be configured as the default for
 205 `git push origin`.
 206
 207 git push origin :::
 208         Push "matching" branches to `origin`. See
 209         <refspec> in the <<OPTIONS,OPTIONS>> section above for a
 210         description of "matching" branches.
 211
 212 git push origin master::
 213         Find a ref that matches `master` in the source repository
 214         (most likely, it would find `refs/heads/master`), and update
 215         the same ref (e.g. `refs/heads/master`) in `origin` repository
 216         with it.  If `master` did not exist remotely, it would be
 217         created.
 218
 219 git push origin HEAD::
 220         A handy way to push the current branch to the same name on the
 221         remote.
 222
 223 git push origin master:satellite/master dev:satellite/dev::
 224         Use the source ref that matches `master` (e.g. `refs/heads/master`)
 225         to update the ref that matches `satellite/master` (most probably
 226         `refs/remotes/satellite/master`) in the `origin` repository, then
 227         do the same for `dev` and `satellite/dev`.
 228
 229 git push origin HEAD:master::
 230         Push the current branch to the remote ref matching `master` in the
 231         `origin` repository. This form is convenient to push the current
 232         branch without thinking about its local name.
 233
 234 git push origin master:refs/heads/experimental::
 235         Create the branch `experimental` in the `origin` repository
 236         by copying the current `master` branch.  This form is only
 237         needed to create a new branch or tag in the remote repository when
 238         the local name and the remote name are different; otherwise,
 239         the ref name on its own will work.
 240
 241 git push origin :experimental::
 242         Find a ref that matches `experimental` in the `origin` repository
 243         (e.g. `refs/heads/experimental`), and delete it.
 244
 245 git push origin {plus}dev:master::
 246         Update the origin repository's master branch with the dev branch,
 247         allowing non-fast forward updates.  *This can leave unreferenced
 248         commits dangling in the origin repository.*  Consider the
 249         following situation, where a fast forward is not possible:
 250 +
 251 ----
 252             o---o---o---A---B  origin/master
 253                      \
 254                       X---Y---Z  dev
 255 ----
 256 +
 257 The above command would change the origin repository to
 258 +
 259 ----
 260                       A---B  (unnamed branch)
 261                      /
 262             o---o---o---X---Y---Z  master
 263 ----
 264 +
 265 Commits A and B would no longer belong to a branch with a symbolic name,
 266 and so would be unreachable.  As such, these commits would be removed by
 267 a `git gc` command on the origin repository.
 268
 269
 270 Author
 271 ------
 272 Written by Junio C Hamano <gitster@pobox.com>, later rewritten in C
 273 by Linus Torvalds <torvalds@osdl.org>
 274
 275 Documentation
 276 --------------
 277 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 278
 279 GIT
 280 ---
 281 Part of the linkgit:git[1] suite