kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

git-push.txt: clean up force-with-lease wording 

The help text for the --force-with-lease option to git-push
does not parse cleanly.  Clean up the wording and syntax to
be more sensible.  Also remove redundant information in the
"--force-with-lease alone" description.

Signed-off-by: Phil Hord <hordp@cisco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Phil Hord 2015-03-26 11:15:09 -04:00 committed by Junio C Hamano
parent 282616c72d
commit fddfaf8a22
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/git-push.txt
View File

@ -142,9 +142,8 @@ already exists on the remote side.
Usually, "git push" refuses to update a remote ref that is Usually, "git push" refuses to update a remote ref that is
not an ancestor of the local ref used to overwrite it. not an ancestor of the local ref used to overwrite it.
+ +
This option bypasses the check, but instead requires that the This option overrides this restriction if the current value of the
current value of the ref to be the expected value. "git push" remote ref is the expected value. "git push" fails otherwise.
fails otherwise.
+ +
Imagine that you have to rebase what you have already published. Imagine that you have to rebase what you have already published.
You will have to bypass the "must fast-forward" rule in order to You will have to bypass the "must fast-forward" rule in order to
@ -156,15 +155,14 @@ commit, and blindly pushing with `--force` will lose her work.
This option allows you to say that you expect the history you are This option allows you to say that you expect the history you are
updating is what you rebased and want to replace. If the remote ref updating is what you rebased and want to replace. If the remote ref
still points at the commit you specified, you can be sure that no still points at the commit you specified, you can be sure that no
other people did anything to the ref (it is like taking a "lease" on other people did anything to the ref. It is like taking a "lease" on
the ref without explicitly locking it, and you update the ref while the ref without explicitly locking it, and the remote ref is updated
making sure that your earlier "lease" is still valid). only if the "lease" is still valid.
+ +
`--force-with-lease` alone, without specifying the details, will protect `--force-with-lease` alone, without specifying the details, will protect
all remote refs that are going to be updated by requiring their all remote refs that are going to be updated by requiring their
current value to be the same as the remote-tracking branch we have current value to be the same as the remote-tracking branch we have
for them, unless specified with a `--force-with-lease=<refname>:<expect>` for them.
option that explicitly states what the expected value is.
+ +
`--force-with-lease=<refname>`, without specifying the expected value, will `--force-with-lease=<refname>`, without specifying the expected value, will
protect the named ref (alone), if it is going to be updated, by protect the named ref (alone), if it is going to be updated, by