[PATCH 3/3] push: suggested updates to push configuration documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This is only to show how the wording suggested in my review comment will
read on top of the endpoint of your series, primarily for reviewing the
counterproposal (I didn't split this apart to apply in steps).

Signed-off-by: Junio C Hamano <gitster@xxxxxxxxx>
---
 Documentation/config.txt |   30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 696544e..f724fc6 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1681,29 +1681,29 @@ push.default::
 +
 * `nothing` - do not push anything.
 * `matching` - push all branches having the same name in both ends.
-  This allows those who prepare all the branches into a publishable
-  shape to push them out to a non-shared repository with a single
-  command. This is well suited when pushing to a non-shared
-  repository, but may give surprising results when used on a
-  repository shared by multiple users, since locally stalled
-  branches will attempt a non-fast forward push if other users
-  updated the branch remotely. This is currently the default, but Git
-  2.0 will change the default to `simple`.
+  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 currently the default, but Git 2.0 will change the default
+  to `simple`.
 * `simple` - like `upstream`, but refuses to push if the upstream
   branch's name is different from the local one. This is the safest
   option and is well-suited for beginners. It will become the default
   in Git 2.0.
-* `upstream` - push the current branch to its upstream branch. See
-  "branch.<name>.merge" for how to configure the upstream branch. This
-  makes `git push` and `git pull` symmetrical in the sense that `push`
-  will update the same remote ref as the one which is merged by
-  `git pull`.
+* `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.
 * `current` - push the current branch to a branch of the same name.
   +
   The `simple`, `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. They are safe when
-  pushing to a shared repository.
+  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
-- 
1.7.10.376.g4eb25

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]