From: Phillip Wood Date: Wed, 23 Sep 2020 10:24:26 GMT Subject: Re: [PATCH v5 3/3] t, doc: update tests, reference for "--force-if-includes" Message-ID: <65574677-faad-f13c-810f-68e0d07479b1@gmail.com> In-Reply-To: <20200923073022.61293-4-shrinidhi.kaushik@gmail.com> Hi Srinidhi On 23/09/2020 08:30, Srinidhi Kaushik wrote: > Update test cases for the new option, and document its usage > and update related references. > > - t/t5533-push-cas.sh: > Update test cases for "compare-and-swap" when used along with > "--force-if-includes" helps mitigate overwrites when remote > ref are updated in the background. > > - Documentation: > Add reference for the new option, configuration setting > ("push.useForceIfIncludes") and advise messages. > > Signed-off-by: Srinidhi Kaushik > --- > Documentation/config/advice.txt | 9 ++++-- > Documentation/config/push.txt | 6 ++++ > Documentation/git-push.txt | 26 +++++++++++++++- > t/t5533-push-cas.sh | 53 +++++++++++++++++++++++++++++++++ > 4 files changed, 90 insertions(+), 4 deletions(-) > > diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt > index bdd37c3eaa..acbd0c09aa 100644 > --- a/Documentation/config/advice.txt > +++ b/Documentation/config/advice.txt > @@ -10,9 +10,8 @@ advice.*:: > that the check is disabled. > pushUpdateRejected:: > Set this variable to 'false' if you want to disable > - 'pushNonFFCurrent', > - 'pushNonFFMatching', 'pushAlreadyExists', > - 'pushFetchFirst', and 'pushNeedsForce' > + 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists', > + 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate' > simultaneously. > pushNonFFCurrent:: > Advice shown when linkgit:git-push[1] fails due to a > @@ -41,6 +40,10 @@ advice.*:: > we can still suggest that the user push to either > refs/heads/* or refs/tags/* based on the type of the > source object. > + pushRefNeedsUpdate:: > + Shown when linkgit:git-push[1] rejects a forced update of > + a branch when its remote-tracking ref has updates that we > + do not have locally. > statusAheadBehind:: > Shown when linkgit:git-status[1] computes the ahead/behind > counts for a local ref compared to its remote tracking ref, > diff --git a/Documentation/config/push.txt b/Documentation/config/push.txt > index f5e5b38c68..fd981f7808 100644 > --- a/Documentation/config/push.txt > +++ b/Documentation/config/push.txt > @@ -114,3 +114,9 @@ push.recurseSubmodules:: > specifying '--recurse-submodules=check|on-demand|no'. > If not set, 'no' is used by default, unless 'submodule.recurse' is > set (in which case a 'true' value means 'on-demand'). > + > +push.useForceIfIncludes:: > + If set to "true", it is equivalent to specifying > + "--force-if-includes" as an option to linkgit:git-push[1] I think we normally use backquotes for option names in the documentation so this would be `--force-if-includes` > + in the command line. Adding "--no-force-if-includes" at the > + time of push overrides this configuration setting. > diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt > index 3b8053447e..706380d263 100644 > --- a/Documentation/git-push.txt > +++ b/Documentation/git-push.txt > @@ -13,7 +13,7 @@ SYNOPSIS > [--repo=] [-f | --force] [-d | --delete] [--prune] [-v | --verbose] > [-u | --set-upstream] [-o | --push-option=] > [--[no-]signed|--signed=(true|false|if-asked)] > - [--force-with-lease[=[:]]] > + [--force-with-lease[=[:]] [--force-if-includes]] > [--no-verify] [ [...]] > > DESCRIPTION > @@ -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" an an ancillary option > +along with "--force-with-lease[=]" (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. > > -f:: > --force:: > @@ -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 > `...` section above for details. > > +--[no-]force-if-includes:: > + 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=:", it is > +a "no-op". > ++ > +Specifying "--no-force-if-includes" disables this behavior. > + > --repo=:: > This option is equivalent to the argument. If both > are specified, the command-line argument takes precedence. > diff --git a/t/t5533-push-cas.sh b/t/t5533-push-cas.sh > index 0b0eb1d025..620d101f50 100755 > --- a/t/t5533-push-cas.sh > +++ b/t/t5533-push-cas.sh > @@ -256,4 +256,57 @@ test_expect_success 'background updates of REMOTE can be mitigated with a non-up > ) > ' It's great to see a couple of tests, however I think it would be useful to have some more - one to check that we do not force when the remote is rewound and a couple to show that we do force when we should. In particular we should still force if we `pull --rebase` and then rewrite the local history using `rebase -i` so that the remote ref is no longer an ancestor of the local HEAD. Best Wishes Phillip > +test_expect_success 'background updates of REMOTE can be mitigated with "--force-if-includes"' ' > + rm -rf src dst && > + git init --bare src.bare && > + test_when_finished "rm -rf src.bare" && > + git clone --no-local src.bare dst && > + test_when_finished "rm -rf dst" && > + ( > + cd dst && > + test_commit G && > + git push origin master:master > + ) && > + git clone --no-local src.bare dst2 && > + test_when_finished "rm -rf dst2" && > + ( > + cd dst2 && > + test_commit H && > + git push > + ) && > + ( > + cd dst && > + test_commit I && > + git fetch origin && > + test_must_fail git push --force-with-lease --force-if-includes origin > + ) > +' > + > +test_expect_success 'background updates of REMOTE can be mitigated with "push.useForceIfIncludes"' ' > + rm -rf src dst && > + git init --bare src.bare && > + test_when_finished "rm -rf src.bare" && > + git clone --no-local src.bare dst && > + test_when_finished "rm -rf dst" && > + ( > + cd dst && > + test_commit G && > + git push origin master:master > + ) && > + git clone --no-local src.bare dst2 && > + test_when_finished "rm -rf dst2" && > + ( > + cd dst2 && > + test_commit H && > + git push > + ) && > + ( > + cd dst && > + test_commit I && > + git fetch origin && > + git config --local push.useForceIfIncludes "true" && > + test_must_fail git push --force-with-lease origin > + ) > +' > + > test_done >