From: Adrian Ratiu <adrian.ratiu@collabora•com>
To: git@vger•kernel.org
Cc: Jeff King <peff@peff•net>,
Emily Shaffer <emilyshaffer@google•com>,
Junio C Hamano <gitster@pobox•com>,
Patrick Steinhardt <ps@pks•im>,
Josh Steadmon <steadmon@google•com>,
Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail•com>,
Adrian Ratiu <adrian.ratiu@collabora•com>
Subject: [PATCH v3 03/12] hook: add "git hook list" command
Date: Sun, 1 Mar 2026 20:44:51 +0200 [thread overview]
Message-ID: <20260301184500.1488433-4-adrian.ratiu@collabora.com> (raw)
In-Reply-To: <20260301184500.1488433-1-adrian.ratiu@collabora.com>
From: Emily Shaffer <emilyshaffer@google•com>
The previous commit introduced an ability to run multiple commands for
hook events and next commit will introduce the ability to define hooks
from configs, in addition to the "traditional" hooks from the hookdir.
Introduce a new command "git hook list" to make inspecting hooks easier
both for users and for the tests we will add.
Further commits will expand on this, e.g. by adding a -z output mode.
Signed-off-by: Emily Shaffer <emilyshaffer@google•com>
Signed-off-by: Adrian Ratiu <adrian.ratiu@collabora•com>
---
Documentation/git-hook.adoc | 5 ++++
builtin/hook.c | 59 +++++++++++++++++++++++++++++++++++++
hook.c | 21 ++-----------
hook.h | 22 ++++++++++++++
t/t1800-hook.sh | 22 ++++++++++++++
5 files changed, 110 insertions(+), 19 deletions(-)
diff --git a/Documentation/git-hook.adoc b/Documentation/git-hook.adoc
index f6cc72d2ca..eb0ffcb8a9 100644
--- a/Documentation/git-hook.adoc
+++ b/Documentation/git-hook.adoc
@@ -9,6 +9,7 @@ SYNOPSIS
--------
[verse]
'git hook' run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>]
+'git hook' list <hook-name>
DESCRIPTION
-----------
@@ -28,6 +29,10 @@ Any positional arguments to the hook should be passed after a
mandatory `--` (or `--end-of-options`, see linkgit:gitcli[7]). See
linkgit:githooks[5] for arguments hooks might expect (if any).
+list::
+ Print a list of hooks which will be run on `<hook-name>` event. If no
+ hooks are configured for that event, print a warning and return 1.
+
OPTIONS
-------
diff --git a/builtin/hook.c b/builtin/hook.c
index 7afec380d2..855116ba8c 100644
--- a/builtin/hook.c
+++ b/builtin/hook.c
@@ -9,9 +9,12 @@
#define BUILTIN_HOOK_RUN_USAGE \
N_("git hook run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>]")
+#define BUILTIN_HOOK_LIST_USAGE \
+ N_("git hook list <hook-name>")
static const char * const builtin_hook_usage[] = {
BUILTIN_HOOK_RUN_USAGE,
+ BUILTIN_HOOK_LIST_USAGE,
NULL
};
@@ -20,6 +23,61 @@ static const char * const builtin_hook_run_usage[] = {
NULL
};
+static int list(int argc, const char **argv, const char *prefix,
+ struct repository *repo)
+{
+ static const char *const builtin_hook_list_usage[] = {
+ BUILTIN_HOOK_LIST_USAGE,
+ NULL
+ };
+ struct string_list *head;
+ struct string_list_item *item;
+ const char *hookname = NULL;
+ int ret = 0;
+
+ struct option list_options[] = {
+ OPT_END(),
+ };
+
+ argc = parse_options(argc, argv, prefix, list_options,
+ builtin_hook_list_usage, 0);
+
+ /*
+ * The only unnamed argument provided should be the hook-name; if we add
+ * arguments later they probably should be caught by parse_options.
+ */
+ if (argc != 1)
+ usage_msg_opt(_("you must specify a hook event name to list."),
+ builtin_hook_list_usage, list_options);
+
+ hookname = argv[0];
+
+ head = list_hooks(repo, hookname, NULL);
+
+ if (!head->nr) {
+ warning(_("no hooks found for event '%s'"), hookname);
+ ret = 1; /* no hooks found */
+ goto cleanup;
+ }
+
+ for_each_string_list_item(item, head) {
+ struct hook *h = item->util;
+
+ switch (h->kind) {
+ case HOOK_TRADITIONAL:
+ printf("%s\n", _("hook from hookdir"));
+ break;
+ default:
+ BUG("unknown hook kind");
+ }
+ }
+
+cleanup:
+ string_list_clear_func(head, hook_free);
+ free(head);
+ return ret;
+}
+
static int run(int argc, const char **argv, const char *prefix,
struct repository *repo UNUSED)
{
@@ -77,6 +135,7 @@ int cmd_hook(int argc,
parse_opt_subcommand_fn *fn = NULL;
struct option builtin_hook_options[] = {
OPT_SUBCOMMAND("run", &fn, run),
+ OPT_SUBCOMMAND("list", &fn, list),
OPT_END(),
};
diff --git a/hook.c b/hook.c
index eb52d706b8..20c655918d 100644
--- a/hook.c
+++ b/hook.c
@@ -47,11 +47,7 @@ const char *find_hook(struct repository *r, const char *name)
return path.buf;
}
-/*
- * Frees a struct hook stored as the util pointer of a string_list_item.
- * Suitable for use as a string_list_clear_func_t callback.
- */
-static void hook_free(void *p, const char *str UNUSED)
+void hook_free(void *p, const char *str UNUSED)
{
struct hook *h = p;
@@ -99,20 +95,7 @@ static void list_hooks_add_default(struct repository *r, const char *hookname,
string_list_append(hook_list, hook_path)->util = h;
}
-/*
- * Provides a list of hook commands to run for the 'hookname' event.
- *
- * This function consolidates hooks from two sources:
- * 1. The config-based hooks (not yet implemented).
- * 2. The "traditional" hook found in the repository hooks directory
- * (e.g., .git/hooks/pre-commit).
- *
- * The list is ordered by execution priority.
- *
- * The caller is responsible for freeing the memory of the returned list
- * using string_list_clear() and free().
- */
-static struct string_list *list_hooks(struct repository *r, const char *hookname,
+struct string_list *list_hooks(struct repository *r, const char *hookname,
struct run_hooks_opt *options)
{
struct string_list *hook_head;
diff --git a/hook.h b/hook.h
index 51fe873298..36d40c98df 100644
--- a/hook.h
+++ b/hook.h
@@ -175,6 +175,28 @@ struct hook_cb_data {
struct run_hooks_opt *options;
};
+/**
+ * Frees a struct hook stored as the util pointer of a string_list_item.
+ * Suitable for use as a string_list_clear_func_t callback.
+ */
+void hook_free(void *p, const char *str);
+
+/**
+ * Provides a list of hook commands to run for the 'hookname' event.
+ *
+ * This function consolidates hooks from two sources:
+ * 1. The config-based hooks (not yet implemented).
+ * 2. The "traditional" hook found in the repository hooks directory
+ * (e.g., .git/hooks/pre-commit).
+ *
+ * The list is ordered by execution priority.
+ *
+ * The caller is responsible for freeing the memory of the returned list
+ * using string_list_clear() and free().
+ */
+struct string_list *list_hooks(struct repository *r, const char *hookname,
+ struct run_hooks_opt *options);
+
/**
* Returns the path to the hook file, or NULL if the hook is missing
* or disabled. Note that this points to static storage that will be
diff --git a/t/t1800-hook.sh b/t/t1800-hook.sh
index ed28a2fadb..d1380a4f0e 100755
--- a/t/t1800-hook.sh
+++ b/t/t1800-hook.sh
@@ -10,9 +10,31 @@ test_expect_success 'git hook usage' '
test_expect_code 129 git hook run &&
test_expect_code 129 git hook run -h &&
test_expect_code 129 git hook run --unknown 2>err &&
+ test_expect_code 129 git hook list &&
+ test_expect_code 129 git hook list -h &&
grep "unknown option" err
'
+test_expect_success 'git hook list: nonexistent hook' '
+ cat >stderr.expect <<-\EOF &&
+ warning: no hooks found for event '\''test-hook'\''
+ EOF
+ test_expect_code 1 git hook list test-hook 2>stderr.actual &&
+ test_cmp stderr.expect stderr.actual
+'
+
+test_expect_success 'git hook list: traditional hook from hookdir' '
+ test_hook test-hook <<-EOF &&
+ echo Test hook
+ EOF
+
+ cat >expect <<-\EOF &&
+ hook from hookdir
+ EOF
+ git hook list test-hook >actual &&
+ test_cmp expect actual
+'
+
test_expect_success 'git hook run: nonexistent hook' '
cat >stderr.expect <<-\EOF &&
error: cannot find a hook named test-hook
--
2.52.0.732.gb351b5166d.dirty
next prev parent reply other threads:[~2026-03-01 18:46 UTC|newest]
Thread overview: 71+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-04 16:51 [PATCH 0/4] Specify hooks via configs Adrian Ratiu
2026-02-04 16:51 ` [PATCH 1/4] hook: run a list of hooks Adrian Ratiu
2026-02-05 21:59 ` Junio C Hamano
2026-02-06 11:21 ` Adrian Ratiu
2026-02-09 14:27 ` Patrick Steinhardt
2026-02-09 18:16 ` Adrian Ratiu
2026-02-10 13:43 ` Patrick Steinhardt
2026-02-04 16:51 ` [PATCH 2/4] hook: introduce "git hook list" Adrian Ratiu
2026-02-09 14:28 ` Patrick Steinhardt
2026-02-09 18:26 ` Adrian Ratiu
2026-02-04 16:51 ` [PATCH 3/4] hook: include hooks from the config Adrian Ratiu
2026-02-09 14:28 ` Patrick Steinhardt
2026-02-09 19:10 ` Adrian Ratiu
2026-02-10 13:43 ` Patrick Steinhardt
2026-02-10 13:56 ` Adrian Ratiu
2026-02-04 16:51 ` [PATCH 4/4] hook: allow out-of-repo 'git hook' invocations Adrian Ratiu
2026-02-06 16:26 ` [PATCH 0/4] Specify hooks via configs Junio C Hamano
2026-02-18 22:23 ` [PATCH v2 0/8] " Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 1/8] hook: add internal state alloc/free callbacks Adrian Ratiu
2026-02-19 21:47 ` Junio C Hamano
2026-02-20 12:35 ` Adrian Ratiu
2026-02-20 17:21 ` Junio C Hamano
2026-02-20 12:42 ` Adrian Ratiu
2026-02-20 12:45 ` Patrick Steinhardt
2026-02-20 13:40 ` Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 2/8] hook: run a list of hooks to prepare for multihook support Adrian Ratiu
2026-02-20 12:46 ` Patrick Steinhardt
2026-02-20 13:51 ` Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 3/8] hook: add "git hook list" command Adrian Ratiu
2026-02-20 12:46 ` Patrick Steinhardt
2026-02-20 13:53 ` Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 4/8] hook: include hooks from the config Adrian Ratiu
2026-02-19 22:16 ` Junio C Hamano
2026-02-20 12:27 ` Adrian Ratiu
2026-02-20 12:46 ` Patrick Steinhardt
2026-02-20 14:31 ` Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 5/8] hook: allow disabling config hooks Adrian Ratiu
2026-02-20 12:46 ` Patrick Steinhardt
2026-02-20 14:47 ` Adrian Ratiu
2026-02-20 18:40 ` Patrick Steinhardt
2026-02-20 18:45 ` Junio C Hamano
2026-02-18 22:23 ` [PATCH v2 6/8] hook: allow event = "" to overwrite previous values Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 7/8] hook: allow out-of-repo 'git hook' invocations Adrian Ratiu
2026-02-18 22:23 ` [PATCH v2 8/8] hook: add -z option to "git hook list" Adrian Ratiu
2026-02-19 21:34 ` [PATCH v2 0/8] Specify hooks via configs Junio C Hamano
2026-02-20 12:51 ` Adrian Ratiu
2026-02-20 23:29 ` brian m. carlson
2026-02-21 14:27 ` Adrian Ratiu
2026-02-22 0:39 ` Adrian Ratiu
2026-02-25 18:37 ` Junio C Hamano
2026-02-26 12:21 ` Adrian Ratiu
2026-02-25 22:30 ` brian m. carlson
2026-02-26 12:41 ` Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 00/12][next] " Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 01/12] hook: add internal state alloc/free callbacks Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 02/12] hook: run a list of hooks to prepare for multihook support Adrian Ratiu
2026-03-01 18:44 ` Adrian Ratiu [this message]
2026-03-01 18:44 ` [PATCH v3 04/12] string-list: add unsorted_string_list_remove() Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 05/12] hook: include hooks from the config Adrian Ratiu
2026-04-06 16:39 ` SZEDER Gábor
2026-04-08 11:28 ` Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 06/12] hook: allow disabling config hooks Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 07/12] hook: allow event = "" to overwrite previous values Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 08/12] hook: allow out-of-repo 'git hook' invocations Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 09/12] hook: add -z option to "git hook list" Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 10/12] hook: refactor hook_config_cache from strmap to named struct Adrian Ratiu
2026-03-01 18:44 ` [PATCH v3 11/12] hook: store and display scope for configured hooks in git hook list Adrian Ratiu
2026-03-01 18:45 ` [PATCH v3 12/12] hook: show disabled hooks in "git hook list" Adrian Ratiu
2026-03-02 16:48 ` [PATCH v3 00/12][next] Specify hooks via configs Junio C Hamano
2026-03-02 17:04 ` Adrian Ratiu
2026-03-02 18:48 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260301184500.1488433-4-adrian.ratiu@collabora.com \
--to=adrian.ratiu@collabora$(echo .)com \
--cc=emilyshaffer@google$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=kristofferhaugsbakk@fastmail$(echo .)com \
--cc=peff@peff$(echo .)net \
--cc=ps@pks$(echo .)im \
--cc=steadmon@google$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox