Documentation: explain push.default option a bit more

The previous documentation was explaining _what_ the options were doing,
but were of little help explaining _why_ a user should set his default to
either of the options.

Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index fb386abc514efef6cb94521c4f5546b5c51ab296..5f14871d2a662a19553b3b92b1b1cabef6c388df 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1680,12 +1680,24 @@ push.default::
        line. Possible values are:
 +
 * `nothing` - do not push anything.
        line. Possible values are:
 +
 * `nothing` - do not push anything.

-* `matching` - push all matching branches.
-  All branches having the same name in both ends are considered to be
-  matching. This is the default.
+* `matching` - push all branches having the same name in both ends.
+  This is for those who prepare all the branches into a publishable
+  shape and then push them out with a single command.  It is not
+  appropriate for pushing into a repository shared by multiple users,
+  since locally stalled branches will attempt a non-fast forward push
+  if other users updated the branch.  This is the default.

 * `upstream` - push the current branch to its upstream branch.
 * `upstream` - push the current branch to its upstream branch.

+  With this, `git push` will update the same remote ref as the one which
+  is merged by `git pull`, making `push` and `pull` symmetrical.
+  See "branch.<name>.merge" for how to configure the upstream branch.

 * `tracking` - deprecated synonym for `upstream`.
 * `current` - push the current branch to a branch of the same name.
 * `tracking` - deprecated synonym for `upstream`.
 * `current` - push the current branch to a branch of the same name.

+  +
+  The `current` and `upstream` modes are for those who want to
+  push out a single branch after finishing work, even when the other
+  branches are not yet ready to be pushed out. If you are working with
+  other people to push into the same shared repository, you would want
+  to use one of these.

 
 rebase.stat::
        Whether to show a diffstat of what changed upstream since the last
 
 rebase.stat::
        Whether to show a diffstat of what changed upstream since the last