From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 2/6] config doc: rewrite push.default section
Date: Wed, 19 Jun 2013 16:41:40 +0530 [thread overview]
Message-ID: <1371640304-26019-3-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1371640304-26019-1-git-send-email-artagnon@gmail.com>
4d3592 (Merge branch 'rr/triangle', 2013-04-07) introduced support for
triangular workflows in Git, but the push.default values still assume
central workflows. Rewrite the descriptions of `nothing`, `current`,
`upstream` and `matching` for greater clarity, and explicitly explaining
how they behave in triangular workflows. Leave `simple` as it is for
the moment, as we plan to change its meaning to accommodate triangular
workflows in a later patch.
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
Documentation/config.txt | 56 ++++++++++++++++++++++++++----------------------
1 file changed, 30 insertions(+), 26 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 7fd4035..9f04f74 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1826,39 +1826,43 @@ pull.twohead::
The default merge strategy to use when pulling a single branch.
push.default::
- Defines the action `git push` should take if no refspec is given
- on the command line, no refspec is configured in the remote, and
- no refspec is implied by any of the options given on the command
- line. Possible values are:
+ Defines the action `git push` should take if no refspec is
+ explicitly given. Different values are well-suited for
+ specific workflows; for instance, in a purely central workflow
+ (i.e. the fetch source is equal to the push destination),
+ `upstream` is probably what you want. Possible values are:
+
--
-* `nothing` - do not push anything.
-* `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 currently the default, but Git 2.0 will change the default
- to `simple`.
-* `upstream` - push the current branch to its upstream branch
- (`tracking` is a deprecated synonym for this).
- 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.
+* `nothing` - do not push anything (error out) unless a refspec is
+ explicitly given. Very safe, but not very convenient.
+
+* `current` - push the current branch to update a branch with the same
+ name on the receiving end. Works in both central and non-central
+ workflows. Equivalent to pushing the refspec "$branch" ($branch is
+ the name of the current branch).
+
+* `upstream` - push the current branch to a branch with the name
+ branch.$branch.merge on the receiving end, and error out if the push
+ destination is not the same as branch.$branch.remote. The name
+ "upstream" refers to "@{u[pstream]}" in linkgit:gitrevisions[7],
+ which makes sense only if both branch.$branch.remote and
+ branch.$branch.merge are set. It makes sure that a `push` is
+ symmetrical to `pull` in central workflows, and cannot be used in
+ non-central workflows.
+
* `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.
-* `current` - push the current branch to a branch of the same name.
+
+* `matching` - push all branches having the same name on both ends
+ (essentially ignoring all newly created local branches).
+ Well-suited for those who want to batch-update a specific set of
+ branches they consistently work on. Use with caution, especially
+ when pushing with '--force'. Equivalent to pushing the refspec ":".
+ This is currently the default, but Git 2.0 will change the default
+ to `simple`.
--
-+
-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. 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.8.3.1.454.g30263f3.dirty
next prev parent reply other threads:[~2013-06-19 11:15 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-19 11:11 [PATCH 0/6] push.default in the triangular world Ramkumar Ramachandra
2013-06-19 11:11 ` [PATCH 1/6] t/t5528-push-default: remove redundant test_config lines Ramkumar Ramachandra
2013-06-19 19:26 ` Junio C Hamano
2013-06-19 11:11 ` Ramkumar Ramachandra [this message]
2013-06-19 19:55 ` [PATCH 2/6] config doc: rewrite push.default section Junio C Hamano
2013-06-20 3:27 ` Junio C Hamano
2013-06-20 7:35 ` Johan Herland
2013-06-19 11:11 ` [PATCH 3/6] push: change `simple` to accommodate triangular workflows Ramkumar Ramachandra
2013-06-19 20:00 ` Junio C Hamano
2013-06-20 2:57 ` Junio C Hamano
2013-06-20 10:09 ` Ramkumar Ramachandra
2013-06-20 19:23 ` Junio C Hamano
2013-06-20 20:49 ` Philip Oakley
2013-06-20 21:03 ` Junio C Hamano
2013-06-20 21:22 ` Ramkumar Ramachandra
2013-06-20 21:56 ` Junio C Hamano
2013-06-20 22:05 ` Junio C Hamano
2013-06-20 21:41 ` Junio C Hamano
2013-06-19 11:11 ` [PATCH 4/6] push: remove dead code in setup_push_upstream() Ramkumar Ramachandra
2013-06-19 20:01 ` Junio C Hamano
2013-06-19 11:11 ` [PATCH 5/6] t/t5528-push-default: generalize test_push_* Ramkumar Ramachandra
2013-06-19 21:56 ` Junio C Hamano
2013-06-19 11:11 ` [PATCH 6/6] t/t5528-push-default: test pushdefault workflows Ramkumar Ramachandra
2013-06-19 22:17 ` Junio C Hamano
-- strict thread matches above, loose matches on Subject: below --
2013-06-24 4:33 [PATCH 0/6] Reroll of rr/triangular-push-fix Junio C Hamano
2013-06-24 4:33 ` [PATCH 2/6] config doc: rewrite push.default section Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1371640304-26019-3-git-send-email-artagnon@gmail.com \
--to=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).