path: root/Documentation/git-push.txt
diff options
authorSrinidhi Kaushik <>2020-10-03 12:10:46 (GMT)
committerJunio C Hamano <>2020-10-03 16:59:19 (GMT)
commit3b5bf96573b5773e64f7884607794c268b352992 (patch)
tree88ae77c7437a97769fa198d1e23f28942c412e48 /Documentation/git-push.txt
parent3b990aa645d1169b7373d12cbf1511ca4633e349 (diff)
t, doc: update tests, reference for "--force-if-includes"
Update test cases for the new option, and document its usage and update related references. Update test cases for the new option, and document its usage and update related references. - t/ Update test cases for "compare-and-swap" when used along with "--force-if-includes" helps mitigate overwrites when remote refs are updated in the background; allows forced updates when changes from remote are integrated locally. - Documentation: Add reference for the new option, configuration setting ("push.useForceIfIncludes") and advise messages. Signed-off-by: Srinidhi Kaushik <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-push.txt')
1 files changed, 25 insertions, 1 deletions
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 3b80534..ab103c8 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -13,7 +13,7 @@ SYNOPSIS
[--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-v | --verbose]
[-u | --set-upstream] [-o <string> | --push-option=<string>]
- [--force-with-lease[=<refname>[:<expect>]]]
+ [--force-with-lease[=<refname>[:<expect>]] [--force-if-includes]]
[--no-verify] [<repository> [<refspec>...]]
@@ -320,6 +320,14 @@ seen and are willing to overwrite, then rewrite history, and finally
force push changes to `master` if the remote version is still at
`base`, regardless of what your local `remotes/origin/master` has been
updated to in the background.
+Alternatively, specifying `--force-if-includes` as an ancillary option
+along with `--force-with-lease[=<refname>]` (i.e., without saying what
+exact commit the ref on the remote side must be pointing at, or which
+refs on the remote side are being protected) at the time of "push" will
+verify if updates from the remote-tracking refs that may have been
+implicitly updated in the background are integrated locally before
+allowing a forced update.
@@ -341,6 +349,22 @@ one branch, use a `+` in front of the refspec to push (e.g `git push
origin +master` to force a push to the `master` branch). See the
`<refspec>...` section above for details.
+ Force an update only if the tip of the remote-tracking ref
+ has been integrated locally.
+This option enables a check that verifies if the tip of the
+remote-tracking ref is reachable from one of the "reflog" entries of
+the local branch based in it for a rewrite. The check ensures that any
+updates from the remote have been incorporated locally by rejecting the
+forced update if that is not the case.
+If the option is passed without specifying `--force-with-lease`, or
+specified along with `--force-with-lease=<refname>:<expect>`, it is
+a "no-op".
+Specifying `--no-force-if-includes` disables this behavior.
This option is equivalent to the <repository> argument. If both
are specified, the command-line argument takes precedence.