git/list[1] front-page[2] threads[3] people[4] search[5] about
wed 2026-10-07 16:58 UTC

[PATCH 10/10] hook: show disabled hooks in "git hook list"

From
Adrian Ratiu <adrian.ratiu@collabora.com>
Date
Mar 9, 2026, 00:54 UTC
Message-ID
<20260309005416.2760030-11-adrian.ratiu@collabora.com>
In-Reply-To
<20260309005416.2760030-1-adrian.ratiu@collabora.com>

Disabled hooks were filtered out of the cache entirely, making them invisible to "git hook list". Keep them in the cache with a new "disabled" flag which is propagated to the respective struct hook.

"git hook list" now shows disabled hooks annotated with "(disabled)" in the config order. With --show-scope, it looks like:

$ git hook list --show-scope pre-commit linter (global) no-leaks (local, disabled) hook from hookdir

A disabled hook without a command issues a warning instead of the fatal "hook.X.command must be configured" error. We could also throw an error, however it seemd a bit excessive to me in this case.

Suggested-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Adrian Ratiu <adrian.ratiu@collabora.com>
---
 builtin/hook.c  | 18 ++++++++++-------
 hook.c          | 54 +++++++++++++++++++++++++++++++++----------------
 hook.h          |  1 +
 t/t1800-hook.sh | 33 +++++++++++++++++++++++++++---
 4 files changed, 79 insertions(+), 27 deletions(-)
diff --git a/builtin/hook.c b/builtin/hook.c
index c806640361..ff446948fa 100644
--- a/builtin/hook.c
+++ b/builtin/hook.c
@@ -72,16 +72,20 @@ static int list(int argc, const char **argv, const char *prefix,
 		case HOOK_TRADITIONAL:
 			printf("%s%c", _("hook from hookdir"), line_terminator);
 			break;
-		case HOOK_CONFIGURED:
-			if (show_scope)
-				printf("%s (%s)%c",
-				       h->u.configured.friendly_name,
-				       config_scope_name(h->u.configured.scope),
+		case HOOK_CONFIGURED: {
+			const char *name = h->u.configured.friendly_name;
+			const char *scope = show_scope ?
+				config_scope_name(h->u.configured.scope) : NULL;
+			if (scope)
+				printf("%s (%s%s)%c", name, scope,
+				       h->u.configured.disabled ? ", disabled" : "",
 				       line_terminator);
+			else if (h->u.configured.disabled)
+				printf("%s (disabled)%c", name, line_terminator);
 			else
-				printf("%s%c", h->u.configured.friendly_name,
-				       line_terminator);
+				printf("%s%c", name, line_terminator);
 			break;
+		}
 		default:
 			BUG("unknown hook kind");
 		}
diff --git a/hook.c b/hook.c
index 2c03baeaac..4f4f060156 100644
--- a/hook.c
+++ b/hook.c
@@ -119,6 +119,7 @@ static void list_hooks_add_default(struct repository *r, const char *hookname,
 struct hook_config_cache_entry {
 	char *command;
 	enum config_scope scope;
+	int disabled;
 };
 
 /*
@@ -217,8 +218,10 @@ static int hook_config_lookup_all(const char *key, const char *value,
  * every item's string is the hook's friendly-name and its util pointer is
  * a hook_config_cache_entry. All strings are owned by the map.
  *
- * Disabled hooks and hooks missing a command are already filtered out at
- * parse time, so callers can iterate the list directly.
+ * Disabled hooks are kept in the cache with entry->disabled set, so that
+ * "git hook list" can display them. Hooks missing a command are filtered
+ * out at build time; if a disabled hook has no command it is silently
+ * skipped rather than triggering a fatal error.
  */
 void hook_cache_clear(struct hook_config_cache *cache)
 {
@@ -268,21 +271,26 @@ static void build_hook_config_map(struct repository *r,
 			struct hook_config_cache_entry *entry;
 			char *command;
 
-			/* filter out disabled hooks */
-			if (unsorted_string_list_lookup(&cb_data.disabled_hooks,
-							hname))
-				continue;
+			int is_disabled =
+				!!unsorted_string_list_lookup(
+					&cb_data.disabled_hooks, hname);
 
 			command = strmap_get(&cb_data.commands, hname);
-			if (!command)
-				die(_("'hook.%s.command' must be configured or "
-				      "'hook.%s.event' must be removed;"
-				      " aborting."), hname, hname);
+			if (!command) {
+				if (is_disabled)
+					warning(_("disabled hook '%s' has no "
+						  "command configured"), hname);
+				else
+					die(_("'hook.%s.command' must be configured or "
+					      "'hook.%s.event' must be removed;"
+					      " aborting."), hname, hname);
+			}
 
 			/* util stores a cache entry; owned by the cache. */
 			CALLOC_ARRAY(entry, 1);
-			entry->command = xstrdup(command);
+			entry->command = command ? xstrdup(command) : NULL;
 			entry->scope = scope;
+			entry->disabled = is_disabled;
 			string_list_append(hooks, hname)->util = entry;
 		}
 
@@ -362,8 +370,10 @@ static void list_hooks_add_configured(struct repository *r,
 
 		hook->kind = HOOK_CONFIGURED;
 		hook->u.configured.friendly_name = xstrdup(friendly_name);
-		hook->u.configured.command = xstrdup(entry->command);
+		hook->u.configured.command =
+			entry->command ? xstrdup(entry->command) : NULL;
 		hook->u.configured.scope = entry->scope;
+		hook->u.configured.disabled = entry->disabled;
 
 		string_list_append(list, friendly_name)->util = hook;
 	}
@@ -401,7 +411,16 @@ struct string_list *list_hooks(struct repository *r, const char *hookname,
 int hook_exists(struct repository *r, const char *name)
 {
 	struct string_list *hooks = list_hooks(r, name, NULL);
-	int exists = hooks->nr > 0;
+	int exists = 0;
+
+	for (size_t i = 0; i < hooks->nr; i++) {
+		struct hook *h = hooks->items[i].util;
+		if (h->kind == HOOK_TRADITIONAL ||
+		    !h->u.configured.disabled) {
+			exists = 1;
+			break;
+		}
+	}
 	string_list_clear_func(hooks, hook_free);
 	free(hooks);
 	return exists;
@@ -416,10 +435,11 @@ static int pick_next_hook(struct child_process *cp,
 	struct string_list *hook_list = hook_cb->hook_command_list;
 	struct hook *h;
 
-	if (hook_cb->hook_to_run_index >= hook_list->nr)
-		return 0;
-
-	h = hook_list->items[hook_cb->hook_to_run_index++].util;
+	do {
+		if (hook_cb->hook_to_run_index >= hook_list->nr)
+			return 0;
+		h = hook_list->items[hook_cb->hook_to_run_index++].util;
+	} while (h->kind == HOOK_CONFIGURED && h->u.configured.disabled);
 
 	cp->no_stdin = 1;
 	strvec_pushv(&cp->env, hook_cb->options->env.v);
diff --git a/hook.h b/hook.h
index 0d711ed21a..0432df963f 100644
--- a/hook.h
+++ b/hook.h
@@ -31,6 +31,7 @@ struct hook {
 			const char *friendly_name;
 			const char *command;
 			enum config_scope scope;
+			int disabled;
 		} configured;
 	} u;
 
diff --git a/t/t1800-hook.sh b/t/t1800-hook.sh
index aed07575e3..cbf7d2bf80 100755
--- a/t/t1800-hook.sh
+++ b/t/t1800-hook.sh
@@ -357,7 +357,15 @@ test_expect_success 'disabled hook is not run' '
 	test_must_be_empty actual
 '
 
-test_expect_success 'disabled hook does not appear in git hook list' '
+test_expect_success 'disabled hook with no command warns' '
+	test_config hook.nocommand.event "pre-commit" &&
+	test_config hook.nocommand.enabled false &&
+
+	git hook list pre-commit 2>actual &&
+	test_grep "disabled hook.*nocommand.*no command configured" actual
+'
+
+test_expect_success 'disabled hook appears as disabled in git hook list' '
 	test_config hook.active.event "pre-commit" &&
 	test_config hook.active.command "echo active" &&
 	test_config hook.inactive.event "pre-commit" &&
@@ -365,8 +373,27 @@ test_expect_success 'disabled hook does not appear in git hook list' '
 	test_config hook.inactive.enabled false &&
 
 	git hook list pre-commit >actual &&
-	test_grep "active" actual &&
-	test_grep ! "inactive" actual
+	test_grep "^active$" actual &&
+	test_grep "^inactive (disabled)$" actual
+'
+
+test_expect_success 'disabled hook shows scope with --show-scope' '
+	test_config hook.myhook.event "pre-commit" &&
+	test_config hook.myhook.command "echo hi" &&
+	test_config hook.myhook.enabled false &&
+
+	git hook list --show-scope pre-commit >actual &&
+	test_grep "myhook (local, disabled)" actual
+'
+
+test_expect_success 'disabled configured hook is not reported as existing by hook_exists' '
+	test_when_finished "rm -f git-bugreport-hook-exists-test.txt" &&
+	test_config hook.linter.event "pre-commit" &&
+	test_config hook.linter.command "echo lint" &&
+	test_config hook.linter.enabled false &&
+
+	git bugreport -s hook-exists-test &&
+	test_grep ! "pre-commit" git-bugreport-hook-exists-test.txt
 '
 
 test_expect_success 'globally disabled hook can be re-enabled locally' '
-- 
2.52.0.732.gb351b5166d.dirty
Previous: Adrian RatiuNext: Eric Sunshine
Message 11 of 71 in “config-hook cleanups and two small 'git hook list' features”
  1. 00/10 config-hook cleanups and two small 'git hook list' featuresAdrian Ratiu, Mar 9, 2026
  2. 01/10 hook: move unsorted_string_list_remove() to string-list.[ch]Adrian Ratiu, Mar 9, 2026
  3. 02/10 hook: fix minor style issuesAdrian Ratiu, Mar 9, 2026
  4. 03/10 hook: rename cb_data_free/alloc -> hook_data_free/allocAdrian Ratiu, Mar 9, 2026
  5. 04/10 hook: detect & emit two more bugsAdrian Ratiu, Mar 9, 2026
  6. 05/10 hook: replace hook_list_clear() -> string_list_clear_func()Adrian Ratiu, Mar 9, 2026
  7. 06/10 hook: make consistent use of friendly-name in docsAdrian Ratiu, Mar 9, 2026
  8. 08/10 hook: refactor hook_config_cache from strmap to named structAdrian Ratiu, Mar 9, 2026
  9. 07/10 t1800: add test to verify hook execution orderingAdrian Ratiu, Mar 9, 2026
  10. 09/10 hook: show config scope in git hook listAdrian Ratiu, Mar 9, 2026
  11. 10/10 hook: show disabled hooks in "git hook list"Adrian Ratiu, Mar 9, 2026
  12. Eric SunshineMar 9, 2026
  13. Eric SunshineMar 9, 2026
  14. Junio C HamanoMar 9, 2026
  15. Junio C HamanoMar 9, 2026
  16. Junio C HamanoMar 9, 2026
  17. Junio C HamanoMar 9, 2026
  18. Adrian RatiuMar 10, 2026
  19. Adrian RatiuMar 10, 2026
  20. Adrian RatiuMar 10, 2026
  21. Adrian RatiuMar 10, 2026
  22. SZEDER GáborMar 10, 2026
  23. Patrick SteinhardtMar 11, 2026
  24. Patrick SteinhardtMar 11, 2026
  25. Patrick SteinhardtMar 11, 2026
  26. Adrian RatiuMar 11, 2026
  27. Adrian RatiuMar 11, 2026
  28. Adrian RatiuMar 11, 2026
  29. Adrian RatiuMar 11, 2026
  30. Patrick SteinhardtMar 11, 2026
  31. 00/10 config-hook cleanups and two small 'git hook list' featuresAdrian Ratiu, Mar 20, 2026
  32. 01/10 hook: move unsorted_string_list_remove() to string-list.[ch]Adrian Ratiu, Mar 20, 2026
  33. 03/10 hook: rename cb_data_free/alloc -> hook_data_free/allocAdrian Ratiu, Mar 20, 2026
  34. 04/10 hook: detect & emit two more bugsAdrian Ratiu, Mar 20, 2026
  35. 05/10 hook: replace hook_list_clear() -> string_list_clear_func()Adrian Ratiu, Mar 20, 2026
  36. 06/10 hook: make consistent use of friendly-name in docsAdrian Ratiu, Mar 20, 2026
  37. 07/10 t1800: add test to verify hook execution orderingAdrian Ratiu, Mar 20, 2026
  38. 08/10 hook: introduce hook_config_cache_entry for per-hook dataAdrian Ratiu, Mar 20, 2026
  39. 02/10 hook: fix minor style issuesAdrian Ratiu, Mar 20, 2026
  40. 09/10 hook: show config scope in git hook listAdrian Ratiu, Mar 20, 2026
  41. 10/10 hook: show disabled hooks in "git hook list"Adrian Ratiu, Mar 20, 2026
  42. Junio C HamanoMar 23, 2026
  43. Patrick SteinhardtMar 24, 2026
  44. Patrick SteinhardtMar 24, 2026
  45. Patrick SteinhardtMar 24, 2026
  46. Patrick SteinhardtMar 24, 2026
  47. Patrick SteinhardtMar 24, 2026
  48. Junio C HamanoMar 24, 2026
  49. Adrian RatiuMar 24, 2026
  50. Adrian RatiuMar 24, 2026
  51. Adrian RatiuMar 24, 2026
  52. Adrian RatiuMar 24, 2026
  53. Patrick SteinhardtMar 25, 2026
  54. Adrian RatiuMar 25, 2026
  55. 00/12 config-hook cleanups and three small git-hook featuresAdrian Ratiu, Mar 25, 2026
  56. 01/12 hook: move unsorted_string_list_remove() to string-list.[ch]Adrian Ratiu, Mar 25, 2026
  57. 02/12 builtin/receive-pack: properly init receive_hook strbufAdrian Ratiu, Mar 25, 2026
  58. 04/12 hook: rename cb_data_free/alloc -> hook_data_free/allocAdrian Ratiu, Mar 25, 2026
  59. 03/12 hook: fix minor style issuesAdrian Ratiu, Mar 25, 2026
  60. 05/12 hook: detect & emit two more bugsAdrian Ratiu, Mar 25, 2026
  61. 06/12 hook: replace hook_list_clear() -> string_list_clear_func()Adrian Ratiu, Mar 25, 2026
  62. 07/12 hook: make consistent use of friendly-name in docsAdrian Ratiu, Mar 25, 2026
  63. 08/12 t1800: add test to verify hook execution orderingAdrian Ratiu, Mar 25, 2026
  64. 09/12 hook: introduce hook_config_cache_entry for per-hook dataAdrian Ratiu, Mar 25, 2026
  65. 10/12 hook: show config scope in git hook listAdrian Ratiu, Mar 25, 2026
  66. 11/12 hook: show disabled hooks in "git hook list"Adrian Ratiu, Mar 25, 2026
  67. 12/12 hook: reject unknown hook names in git-hook(1)Adrian Ratiu, Mar 25, 2026
  68. Junio C HamanoMar 25, 2026
  69. Adrian RatiuMar 26, 2026
  70. Patrick SteinhardtMar 27, 2026
  71. Junio C HamanoMar 27, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.