Re: [PATCH] Remove negation from the commit and merge option "--no-verify"
From: Phillip Wood <hidden>
Date: 2021-10-28 13:58:10
Hi Alex On 28/10/2021 09:04, Alex Riesen wrote:
From: Alex Riesen <redacted> This allows re-enabling of the hooks disabled by an earlier "--no-verify" in command-line and makes the interface more consistent.
Thanks for working on this. Since 0f1930c587 ("parse-options: allow
positivation of options starting, with no-", 2012-02-25) merge and
commit have accepted "--verify" but it is undocumented. The
documentation updates and fix to pull in this patch are very welcome,
but I'm not sure we need the other changes. I've left a couple of
comments below.
[As an aside we should probably improve the documentation in
parse-options.h if both Peff and Junio did not know how it handles
"--no-foo" but that is outside the scope of this patch]
Incidentally, this also fixes unexpected calling of the hooks by "git pull" when "--no-verify" was specified, where it was incorrectly translated to "--no-verify-signatures". This caused the unexpected effect of the hooks being called. And an even more unexpected effect of disabling verification of signatures.
Ouch!
quoted hunk ↗ jump to hunk
Signed-off-by: Alexander Riesen <redacted> [...]diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index a3baea32ae..ba66209274 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt@@ -11,7 +11,7 @@ SYNOPSIS 'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend] [--dry-run] [(-c | -C | --fixup | --squash) <commit>] [-F <file> | -m <msg>] [--reset-author] [--allow-empty] - [--allow-empty-message] [--no-verify] [-e] [--author=<author>] + [--allow-empty-message] [--[no-]verify] [-e] [--author=<author>]
I think for the synopsis it is fine just to list the most common options. Having --no-verify without the [no-] makes it clear that --verify is the default so is not a commonly used option.
quoted hunk ↗ jump to hunk
[--date=<date>] [--cleanup=<mode>] [--[no-]status] [-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]] [-S[<keyid>]] [--] [<pathspec>...]@@ -174,7 +174,13 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`. -n:: --no-verify:: - This option bypasses the pre-commit and commit-msg hooks. + By default, pre-merge and commit-msg hooks are run. When one of these
I think saying "the pre-merge and commit-msg hooks" would be clearer as you do below.
+ options is given, these are bypassed. + See also linkgit:githooks[5]. + +--verify:: + This option re-enables running of the pre-commit and commit-msg hooks + after an earlier `-n` or `--no-verify`. See also linkgit:githooks[5].
Some of the existing documentation describes the "--no-foo" option with "--foo" (e.g --[no-]signoff) but in other places we list the two options separately (e.g. --[no-]edit), I'd lean towards combining them as you have done for the merge documentation but I don't feel strongly about it.
quoted hunk ↗ jump to hunk
--allow-empty::diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 3819fadac1..324ae879d2 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt@@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit] - [--no-verify] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]] + [--[no-]verify] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
Again I'm not sure changing the synopsis makes things clearer.
quoted hunk ↗ jump to hunk
[--[no-]allow-unrelated-histories] [--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...] 'git merge' (--continue | --abort | --quit)diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt index 80d4831662..f8016b0f7b 100644 --- a/Documentation/merge-options.txt +++ b/Documentation/merge-options.txt@@ -112,8 +112,9 @@ option can be used to override --squash. + With --squash, --commit is not allowed, and will fail. ---no-verify:: - This option bypasses the pre-merge and commit-msg hooks. +--[no-]verify:: + By default, pre-merge and commit-msg hooks are run. When `--no-verify`
I think "the pre-merge ..." would be better here as well.
quoted hunk ↗ jump to hunk
+ is given, these are bypassed. See also linkgit:githooks[5]. [...]diff --git a/t/t5521-pull-options.sh b/t/t5521-pull-options.sh index db1a381cd9..7d3a8ae0d3 100755 --- a/t/t5521-pull-options.sh +++ b/t/t5521-pull-options.sh@@ -225,4 +225,16 @@ test_expect_success 'git pull --no-signoff flag cancels --signoff flag' ' test_must_be_empty actual ' +test_expect_success 'git pull --no-verify flag passed to merge' ' + test_when_finished "rm -fr src dst actual" && + git init src && + test_commit -C src one && + git clone src dst && + write_script dst/.git/hooks/commit-msg <<-\EOF && + false + EOF + test_commit -C src two && + git -C dst pull --no-ff --no-verify +'
Thanks for adding a test
quoted hunk ↗ jump to hunk
test_donediff --git a/t/t7504-commit-msg-hook.sh b/t/t7504-commit-msg-hook.sh index 31b9c6a2c1..166ff5fb26 100755 --- a/t/t7504-commit-msg-hook.sh +++ b/t/t7504-commit-msg-hook.sh@@ -130,6 +130,14 @@ test_expect_success '--no-verify with failing hook' ' ' +test_expect_success '-n with failing hook' ' + + echo "more" >> file && + git add file && + git commit -n -m "more" + +'
Is this to check that "-n" works like "--no-verify"? I think it would be very useful to add another test that checks "--verify" overrides "--no-verify". Best Wishes Phillip