If more than one hook will be run, it may be useful to see a list of
which hooks should be run. At very least, it will be useful for us to
test the semantics of multihooks ourselves.
For now, only list the hooks which will run in the order they will run
in; later, it might be useful to include more information like where the
hooks were configured and whether or not they will run.
Signed-off-by: Emily Shaffer <emilyshaffer@xxxxxxxxxx>
---
Documentation/git-hook.txt | 5 +++++
builtin/hook.c | 46 ++++++++++++++++++++++++++++++++++++++
hook.c | 3 +--
3 files changed, 52 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt
index 8bf82b5dd4..701ada9fc0 100644
--- a/Documentation/git-hook.txt
+++ b/Documentation/git-hook.txt
@@ -10,6 +10,7 @@ SYNOPSIS
[verse]
'git hook' run [--to-stdin=<path>] [--ignore-missing] [(-j|--jobs) <n>]
<hook-name> [-- <hook-args>]
+'git hook' list <hook-name>
DESCRIPTION
-----------
@@ -30,6 +31,10 @@ optional `--` (or `--end-of-options`, see linkgit:gitcli[7]). The
arguments (if any) differ by hook name, see linkgit:githooks[5] for
what those are.
+list::
+ Print a list of hooks which will be run on `<hook-name>` event. If no
+ hooks are configured for that event, print nothing and return 1.
+
OPTIONS
-------
diff --git a/builtin/hook.c b/builtin/hook.c
index 4dd3617876..d21f303eca 100644
--- a/builtin/hook.c
+++ b/builtin/hook.c
@@ -8,8 +8,11 @@
#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_LIST_USAGE,
BUILTIN_HOOK_RUN_USAGE,
NULL
};
@@ -19,6 +22,47 @@ static const char * const builtin_hook_run_usage[] = {
NULL
};
+static const char *const builtin_hook_list_usage[] = {
+ BUILTIN_HOOK_LIST_USAGE,
+ NULL
+};
+
+static int list(int argc, const char **argv, const char *prefix)
+{
+ struct list_head *head, *pos;
+ const char *hookname = NULL;
+ struct strbuf hookdir_annotation = STRBUF_INIT;
+
+ struct option list_options[] = {
+ OPT_END(),
+ };
+
+ argc = parse_options(argc, argv, prefix, list_options,
+ builtin_hook_list_usage, 0);
+
+ 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 = hook_list(hookname);
+
+ if (list_empty(head))
+ return 1;
+
+ list_for_each(pos, head) {
+ struct hook *item = list_entry(pos, struct hook, list);
+ item = list_entry(pos, struct hook, list);
+ if (item)
+ printf("%s\n", item->hook_path);
+ }
+
+ clear_hook_list(head);
+ strbuf_release(&hookdir_annotation);
+
+ return 0;
+}
static int run(int argc, const char **argv, const char *prefix)
{
int i;
@@ -88,6 +132,8 @@ int cmd_hook(int argc, const char **argv, const char *prefix)
if (!argc)
goto usage;
+ if (!strcmp(argv[0], "list"))
+ return list(argc, argv, prefix);
if (!strcmp(argv[0], "run"))
return run(argc, argv, prefix);
diff --git a/hook.c b/hook.c
index b8420353fa..b1ea372e15 100644
--- a/hook.c
+++ b/hook.c
@@ -96,6 +96,7 @@ struct list_head *list_hooks(const char *hookname)
{
struct list_head *hook_head = xmalloc(sizeof(struct list_head));
+
INIT_LIST_HEAD(hook_head);
if (!hookname)
@@ -103,8 +104,6 @@ struct list_head *list_hooks(const char *hookname)
if (have_git_dir()) {
const char *hook_path = find_hook(hookname);
-
- /* Add the hook from the hookdir */
if (hook_path) {
struct hook *to_add = xmalloc(sizeof(*to_add));
to_add->hook_path = hook_path;
--
2.33.0.rc2.250.ged5fa647cd-goog
