Make help entries alphabetical

[git.git] / Documentation / git-push.txt

diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 82dd4433f2ac3113fce65f4aa3a953f020bbd1e1..6150b1b959e17655a2875d39ec3b70449684a0eb 100644 (file)
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -9,8 +9,9 @@ git-push - Update remote refs along with associated objects
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git-push' [--all] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>]
-           [--repo=all] [-f | --force] [-v | --verbose] [<repository> <refspec>...]
+'git push' [--all | --mirror] [--dry-run] [--tags] [--receive-pack=<git-receive-pack>]
+          [--repo=<repository>] [-f | --force] [-v | --verbose]
+          [<repository> <refspec>...]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -29,9 +30,9 @@ OPTIONS
        The "remote" repository that is destination of a push
        operation.  See the section <<URLS,GIT URLS>> below.
 
        The "remote" repository that is destination of a push
        operation.  See the section <<URLS,GIT URLS>> below.
 

-<refspec>::
+<refspec>...::

        The canonical format of a <refspec> parameter is
        The canonical format of a <refspec> parameter is

-       `+?<src>:<dst>`; that is, an optional plus `+`, followed
+       `+?<src>:<dst>`; that is, an optional plus `{plus}`, followed

        by the source ref, followed by a colon `:`, followed by
        the destination ref.
 +
        by the source ref, followed by a colon `:`, followed by
        the destination ref.
 +


@@ -67,7 +68,8 @@ nor in any Push line of the corresponding remotes file---see below).
 
 --mirror::
        Instead of naming each ref to push, specifies that all
 
 --mirror::
        Instead of naming each ref to push, specifies that all

-       refs under `$GIT_DIR/refs/heads/` and `$GIT_DIR/refs/tags/`
+       refs under `$GIT_DIR/refs/` (which includes but is not
+       limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)

        be mirrored to the remote repository.  Newly created local
        refs will be pushed to the remote end, locally updated refs
        will be force updated on the remote end, and deleted refs
        be mirrored to the remote repository.  Newly created local
        refs will be pushed to the remote end, locally updated refs
        will be force updated on the remote end, and deleted refs


@@ -99,13 +101,27 @@ nor in any Push line of the corresponding remotes file---see below).
        This flag disables the check.  This can cause the
        remote repository to lose commits; use it with care.
 
        This flag disables the check.  This can cause the
        remote repository to lose commits; use it with care.
 

---repo=<repo>::
-       When no repository is specified the command defaults to
-       "origin"; this overrides it.
+--repo=<repository>::
+       This option is only relevant if no <repository> argument is
+       passed in the invocation. In this case, 'git-push' derives the
+       remote name from the current branch: If it tracks a remote
+       branch, then that remote repository is pushed to. Otherwise,
+       the name "origin" is used. For this latter case, this option
+       can be used to override the name "origin". In other words,
+       the difference between these two commands
++
+--------------------------
+git push public         #1
+git push --repo=public  #2
+--------------------------
++
+is that #1 always pushes to "public" whereas #2 pushes to "public"
+only if the current branch does not track a remote branch. This is
+useful if you write an alias or script around 'git-push'.

 
 --thin::
 --no-thin::
 
 --thin::
 --no-thin::

-       These options are passed to `git-send-pack`.  Thin
+       These options are passed to 'git-send-pack'.  Thin

        transfer spends extra cycles to minimize the number of
        objects to be sent and meant to be used on slower connection.
 
        transfer spends extra cycles to minimize the number of
        objects to be sent and meant to be used on slower connection.
 


@@ -179,11 +195,11 @@ git push origin :experimental::
        Find a ref that matches `experimental` in the `origin` repository
        (e.g. `refs/heads/experimental`), and delete it.
 
        Find a ref that matches `experimental` in the `origin` repository
        (e.g. `refs/heads/experimental`), and delete it.
 

-git push origin master:satellite/master::
-       Find a ref that matches `master` in the source repository
-       (most likely, it would find `refs/heads/master`), and update
-       the ref that matches `satellite/master` (most likely, it would
-       be `refs/remotes/satellite/master`) in `origin` repository with it.
+git push origin master:satellite/master dev:satellite/dev::
+       Use the source ref that matches `master` (e.g. `refs/heads/master`)
+       to update the ref that matches `satellite/master` (most probably
+       `refs/remotes/satellite/master`) in the `origin` repository, then
+       do the same for `dev` and `satellite/dev`.

 
 git push origin master:refs/heads/experimental::
        Create the branch `experimental` in the `origin` repository
 
 git push origin master:refs/heads/experimental::
        Create the branch `experimental` in the `origin` repository