[PATCH] Pass amend to pre-commit hook
- From
- Alan Clucas <alan.clucas@teamwpc.co.uk>
- Date
- Sep 14, 2015, 12:14 UTC
- Message-ID
- <55F6BA1C.7080507@teamwpc.co.uk>
Pass a single parameter 'amend' to the pre-commit hook when performing a commit amend.
This allows 'incremental improvement' pre-commit hooks to prevent new code from violating a rule, but also allow the pre-commit hook to pass an amended commit where the amend has reverted back to the original code (which may not pass that same rule).
Example: I have a new whitespace rule. Old code violates this rule and will not be fixed up for blame reasons. My pre-commit hook detects _new_ lines which violate the rule and rejects them, however, my original commit passes. I amend the code to revert back to the original code (which violates the rule). Without this change I cannot detect this is an amend and reject the change (unless --no-verify). With this I can detect this is an amend and verify the patch as a whole is not in violation of the rule.
Signed-off-by: Alan Clucas <alan.clucas@teamwpc.co.uk> --- Hello, This is my first submission to git, so hopefully I've managed to get the formatting right. This patch should be explained above, and would also help out the folks at overcommit who have this (pretty horrid) solution to the same issue: https://github.com/brigade/overcommit/issues/146 https://github.com/brigade/overcommit/pull/167 Thanks, Alan Clucas
Documentation/githooks.txt | 10 ++++++---- builtin/commit.c | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 7ba0ac9..49d7adb 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -73,10 +73,12 @@ pre-commit ~~~~~~~~~~ This hook is invoked by 'git commit', and can be bypassed -with `--no-verify` option. It takes no parameter, and is -invoked before obtaining the proposed commit log message and -making a commit. Exiting with non-zero status from this script -causes the 'git commit' to abort. +with `--no-verify` option. It takes zero or one parameters. +If a parameter is given it will be 'amend' indicating this is +a commit amend (if an `--amend` option was given). It is invoked +before obtaining the proposed commit log message and making a +commit. Exiting with non-zero status from this script causes the +'git commit' to abort. The default 'pre-commit' hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when diff --git a/builtin/commit.c b/builtin/commit.c index 63772d0..936a614 100644 --- a/builtin/commit.c +++ b/builtin/commit.c @@ -671,7 +671,7 @@ static int prepare_to_commit(const char *index_file, const char *prefix, /* This checks and barfs if author is badly specified */ determine_author_info(author_ident); - if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", NULL)) + if (!no_verify && run_commit_hook(use_editor, index_file, "pre-commit", amend?"amend":NULL, NULL)) return 0; if (squash_message) {
-- 2.4.1.168.g1ea28e1