Documentation: more git push examples
[gitweb.git] / Documentation / git-push.txt
index 6150b1b959e17655a2875d39ec3b70449684a0eb..60de47d43957f1d57a3a02b52d89db84683ae66e 100644 (file)
@@ -28,13 +28,16 @@ OPTIONS
 -------
 <repository>::
        The "remote" repository that is destination of a push
-       operation.  See the section <<URLS,GIT URLS>> below.
+       operation.  This parameter can be either a URL
+       (see the section <<URLS,GIT URLS>> below) or the name
+       of a remote (see the section <<REMOTES,REMOTES>> below).
 
 <refspec>...::
-       The canonical format of a <refspec> parameter is
-       `+?<src>:<dst>`; that is, an optional plus `{plus}`, followed
-       by the source ref, followed by a colon `:`, followed by
-       the destination ref.
+       The format of a <refspec> parameter is an optional plus
+       `{plus}`, followed by the source ref <src>, followed
+       by a colon `:`, followed by the destination ref <dst>.
+       It is used to specify with what <src> object the <dst> ref
+       in the remote repository is to be updated.
 +
 The <src> side represents the source branch (or arbitrary
 "SHA1 expression", such as `master~4` (four parents before the
@@ -42,22 +45,21 @@ tip of `master` branch); see linkgit:git-rev-parse[1]) that you
 want to push.  The <dst> side represents the destination location.
 +
 The local ref that matches <src> is used
-to fast forward the remote ref that matches <dst> (or, if no <dst> was
-specified, the same ref that <src> referred to locally).  If
+to fast forward the remote ref that matches <dst>.  If
 the optional leading plus `+` is used, the remote ref is updated
 even if it does not result in a fast forward update.
 +
 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
 +
-A parameter <ref> without a colon pushes the <ref> from the source
-repository to the destination repository under the same name.
+A lonely <src> parameter (without a colon and a destination) pushes
+the <src> to the same name in the destination repository.
 +
 Pushing an empty <src> allows you to delete the <dst> ref from
 the remote repository.
 +
 The special refspec `:` (or `+:` to allow non-fast forward updates)
-directs git to push "matching" heads: for every head that exists on
-the local side, the remote side is updated if a head of the same name
+directs git to push "matching" branches: for every branch that exists on
+the local side, the remote side is updated if a branch of the same name
 already exists on the remote side.  This is the default operation mode
 if no explicit refspec is found (that is neither on the command line
 nor in any Push line of the corresponding remotes file---see below).
@@ -86,14 +88,12 @@ nor in any Push line of the corresponding remotes file---see below).
        line.
 
 --receive-pack=<git-receive-pack>::
+--exec=<git-receive-pack>::
        Path to the 'git-receive-pack' program on the remote
        end.  Sometimes useful when pushing to a remote
        repository over ssh, and you do not have the program in
        a directory on the default $PATH.
 
---exec=<git-receive-pack>::
-       Same as \--receive-pack=<git-receive-pack>.
-
 -f::
 --force::
        Usually, the command refuses to update a remote ref that is
@@ -191,9 +191,9 @@ git push origin master::
        with it.  If `master` did not exist remotely, it would be
        created.
 
-git push origin :experimental::
-       Find a ref that matches `experimental` in the `origin` repository
-       (e.g. `refs/heads/experimental`), and delete it.
+git push origin HEAD::
+       A handy way to push the current branch to the same name on the
+       remote.
 
 git push origin master:satellite/master dev:satellite/dev::
        Use the source ref that matches `master` (e.g. `refs/heads/master`)
@@ -201,6 +201,11 @@ git push origin master:satellite/master dev:satellite/dev::
        `refs/remotes/satellite/master`) in the `origin` repository, then
        do the same for `dev` and `satellite/dev`.
 
+git push origin HEAD:master::
+       Push the current branch to the remote ref matching `master` in the
+       `origin` repository. This form is convenient to push the current
+       branch without thinking about its local name.
+
 git push origin master:refs/heads/experimental::
        Create the branch `experimental` in the `origin` repository
        by copying the current `master` branch.  This form is only
@@ -208,6 +213,11 @@ git push origin master:refs/heads/experimental::
        the local name and the remote name are different; otherwise,
        the ref name on its own will work.
 
+git push origin :experimental::
+       Find a ref that matches `experimental` in the `origin` repository
+       (e.g. `refs/heads/experimental`), and delete it.
+
+
 Author
 ------
 Written by Junio C Hamano <gitster@pobox.com>, later rewritten in C