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 --porcelain::
  89         Produce machine-readable output.  The output status line for each ref
  90         will be tab-separated and sent to stdout instead of stderr.  The full
  91         symbolic names of the refs will be given.
  92
  93 --tags::
  94         All refs under `$GIT_DIR/refs/tags` are pushed, in
  95         addition to refspecs explicitly listed on the command
  96         line.
  97
  98 --receive-pack=<git-receive-pack>::
  99 --exec=<git-receive-pack>::
 100         Path to the 'git-receive-pack' program on the remote
 101         end.  Sometimes useful when pushing to a remote
 102         repository over ssh, and you do not have the program in
 103         a directory on the default $PATH.
 104
 105 -f::
 106 --force::
 107         Usually, the command refuses to update a remote ref that is
 108         not an ancestor of the local ref used to overwrite it.
 109         This flag disables the check.  This can cause the
 110         remote repository to lose commits; use it with care.
 111
 112 --repo=<repository>::
 113         This option is only relevant if no <repository> argument is
 114         passed in the invocation. In this case, 'git-push' derives the
 115         remote name from the current branch: If it tracks a remote
 116         branch, then that remote repository is pushed to. Otherwise,
 117         the name "origin" is used. For this latter case, this option
 118         can be used to override the name "origin". In other words,
 119         the difference between these two commands
 120 +
 121 --------------------------
 122 git push public         #1
 123 git push --repo=public  #2
 124 --------------------------
 125 +
 126 is that #1 always pushes to "public" whereas #2 pushes to "public"
 127 only if the current branch does not track a remote branch. This is
 128 useful if you write an alias or script around 'git-push'.
 129
 130 --thin::
 131 --no-thin::
 132         These options are passed to 'git-send-pack'.  Thin
 133         transfer spends extra cycles to minimize the number of
 134         objects to be sent and meant to be used on slower connection.
 135
 136 -v::
 137 --verbose::
 138         Run verbosely.
 139
 140 include::urls-remotes.txt[]
 141
 142 OUTPUT
 143 ------
 144
 145 The output of "git push" depends on the transport method used; this
 146 section describes the output when pushing over the git protocol (either
 147 locally or via ssh).
 148
 149 The status of the push is output in tabular form, with each line
 150 representing the status of a single ref. Each line is of the form:
 151
 152 -------------------------------
 153  <flag> <summary> <from> -> <to> (<reason>)
 154 -------------------------------
 155
 156 If --porcelain is used, then each line of the output is of the form:
 157
 158 -------------------------------
 159  <flag> \t <from>:<to> \t <summary> (<reason>)
 160 -------------------------------
 161
 162 flag::
 163         A single character indicating the status of the ref. This is
 164         blank for a successfully pushed ref, `!` for a ref that was
 165         rejected or failed to push, and '=' for a ref that was up to
 166         date and did not need pushing (note that the status of up to
 167         date refs is shown only when `git push` is running verbosely).
 168
 169 summary::
 170         For a successfully pushed ref, the summary shows the old and new
 171         values of the ref in a form suitable for using as an argument to
 172         `git log` (this is `<old>..<new>` in most cases, and
 173         `<old>...<new>` for forced non-fast forward updates). For a
 174         failed update, more details are given for the failure.
 175         The string `rejected` indicates that git did not try to send the
 176         ref at all (typically because it is not a fast forward). The
 177         string `remote rejected` indicates that the remote end refused
 178         the update; this rejection is typically caused by a hook on the
 179         remote side. The string `remote failure` indicates that the
 180         remote end did not report the successful update of the ref
 181         (perhaps because of a temporary error on the remote side, a
 182         break in the network connection, or other transient error).
 183
 184 from::
 185         The name of the local ref being pushed, minus its
 186         `refs/<type>/` prefix. In the case of deletion, the
 187         name of the local ref is omitted.
 188
 189 to::
 190         The name of the remote ref being updated, minus its
 191         `refs/<type>/` prefix.
 192
 193 reason::
 194         A human-readable explanation. In the case of successfully pushed
 195         refs, no explanation is needed. For a failed ref, the reason for
 196         failure is described.
 197
 198 Examples
 199 --------
 200
 201 git push::
 202         Works like `git push <remote>`, where <remote> is the
 203         current branch's remote (or `origin`, if no remote is
 204         configured for the current branch).
 205
 206 git push origin::
 207         Without additional configuration, works like
 208         `git push origin :`.
 209 +
 210 The default behavior of this command when no <refspec> is given can be
 211 configured by setting the `push` option of the remote.
 212 +
 213 For example, to default to pushing only the current branch to `origin`
 214 use `git config remote.origin.push HEAD`.  Any valid <refspec> (like
 215 the ones in the examples below) can be configured as the default for
 216 `git push origin`.
 217
 218 git push origin :::
 219         Push "matching" branches to `origin`. See
 220         <refspec> in the <<OPTIONS,OPTIONS>> section above for a
 221         description of "matching" branches.
 222
 223 git push origin master::
 224         Find a ref that matches `master` in the source repository
 225         (most likely, it would find `refs/heads/master`), and update
 226         the same ref (e.g. `refs/heads/master`) in `origin` repository
 227         with it.  If `master` did not exist remotely, it would be
 228         created.
 229
 230 git push origin HEAD::
 231         A handy way to push the current branch to the same name on the
 232         remote.
 233
 234 git push origin master:satellite/master dev:satellite/dev::
 235         Use the source ref that matches `master` (e.g. `refs/heads/master`)
 236         to update the ref that matches `satellite/master` (most probably
 237         `refs/remotes/satellite/master`) in the `origin` repository, then
 238         do the same for `dev` and `satellite/dev`.
 239
 240 git push origin HEAD:master::
 241         Push the current branch to the remote ref matching `master` in the
 242         `origin` repository. This form is convenient to push the current
 243         branch without thinking about its local name.
 244
 245 git push origin master:refs/heads/experimental::
 246         Create the branch `experimental` in the `origin` repository
 247         by copying the current `master` branch.  This form is only
 248         needed to create a new branch or tag in the remote repository when
 249         the local name and the remote name are different; otherwise,
 250         the ref name on its own will work.
 251
 252 git push origin :experimental::
 253         Find a ref that matches `experimental` in the `origin` repository
 254         (e.g. `refs/heads/experimental`), and delete it.
 255
 256 git push origin {plus}dev:master::
 257         Update the origin repository's master branch with the dev branch,
 258         allowing non-fast forward updates.  *This can leave unreferenced
 259         commits dangling in the origin repository.*  Consider the
 260         following situation, where a fast forward is not possible:
 261 +
 262 ----
 263             o---o---o---A---B  origin/master
 264                      \
 265                       X---Y---Z  dev
 266 ----
 267 +
 268 The above command would change the origin repository to
 269 +
 270 ----
 271                       A---B  (unnamed branch)
 272                      /
 273             o---o---o---X---Y---Z  master
 274 ----
 275 +
 276 Commits A and B would no longer belong to a branch with a symbolic name,
 277 and so would be unreachable.  As such, these commits would be removed by
 278 a `git gc` command on the origin repository.
 279
 280
 281 Author
 282 ------
 283 Written by Junio C Hamano <gitster@pobox.com>, later rewritten in C
 284 by Linus Torvalds <torvalds@osdl.org>
 285
 286 Documentation
 287 --------------
 288 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 289
 290 GIT
 291 ---
 292 Part of the linkgit:git[1] suite