As the hook architecture and 'git hook run' become more featureful, we
may find wrappers wanting to use the hook architecture to run their own
hooks, thereby getting nice things like parallelism and idiomatic Git
configuration for free. Enable this by letting 'git hook run' bypass the
known_hooks() check.
We do still want to keep known_hooks() around, though - by die()ing when
an internal Git call asks for run_hooks("my-new-hook"), we can remind
Git developers to update Documentation/githooks.txt with their new hook,
which in turn helps Git users discover this new hook.
Signed-off-by: Emily Shaffer <emilyshaffer@xxxxxxxxxx>
---
Documentation/git-hook.txt | 8 ++++++++
builtin/hook.c | 4 ++--
hook.c | 35 +++++++++++++++++++++++++++++++----
hook.h | 14 ++++++++++++++
4 files changed, 55 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-hook.txt b/Documentation/git-hook.txt
index 701ada9fc0..d1db084e4f 100644
--- a/Documentation/git-hook.txt
+++ b/Documentation/git-hook.txt
@@ -19,6 +19,14 @@ This command is an interface to git hooks (see linkgit:githooks[5]).
Currently it only provides a convenience wrapper for running hooks for
use by git itself. In the future it might gain other functionality.
+It's possible to use this command to refer to hooks which are not native to Git,
+for example if a wrapper around Git wishes to expose hooks into its own
+operation in a way which is already familiar to Git users. However, wrappers
+invoking such hooks should be careful to name their hook events something which
+Git is unlikely to use for a native hook later on. For example, Git is much less
+likely to create a `mytool-validate-commit` hook than it is to create a
+`validate-commit` hook.
+
SUBCOMMANDS
-----------
diff --git a/builtin/hook.c b/builtin/hook.c
index d21f303eca..80397d39f5 100644
--- a/builtin/hook.c
+++ b/builtin/hook.c
@@ -46,7 +46,7 @@ static int list(int argc, const char **argv, const char *prefix)
hookname = argv[0];
- head = hook_list(hookname);
+ head = list_hooks_gently(hookname);
if (list_empty(head))
return 1;
@@ -105,7 +105,7 @@ static int run(int argc, const char **argv, const char *prefix)
git_config(git_default_config, NULL);
hook_name = argv[0];
- hooks = list_hooks(hook_name);
+ hooks = list_hooks_gently(hook_name);
if (list_empty(hooks)) {
/* ... act like run_hooks_oneshot() under --ignore-missing */
if (ignore_missing)
diff --git a/hook.c b/hook.c
index b1ea372e15..ab1e86ddcf 100644
--- a/hook.c
+++ b/hook.c
@@ -51,12 +51,21 @@ static int known_hook(const char *name)
const char *find_hook(const char *name)
{
- static struct strbuf path = STRBUF_INIT;
+ const char *hook_path;
if (!known_hook(name))
- die(_("the hook '%s' is not known to git, should be in hook-list.h via githooks(5)"),
+ BUG(_("the hook '%s' is not known to git, should be in hook-list.h via githooks(5)"),
name);
+ hook_path = find_hook_gently(name);
+
+ return hook_path;
+}
+
+const char *find_hook_gently(const char *name)
+{
+ static struct strbuf path = STRBUF_INIT;
+
strbuf_reset(&path);
strbuf_git_path(&path, "hooks/%s", name);
if (access(path.buf, X_OK) < 0) {
@@ -92,10 +101,24 @@ int hook_exists(const char *name)
return !list_empty(list_hooks(name));
}
+struct hook_config_cb
+{
+ struct strbuf *hook_key;
+ struct list_head *list;
+};
+
struct list_head *list_hooks(const char *hookname)
{
- struct list_head *hook_head = xmalloc(sizeof(struct list_head));
+ if (!known_hook(hookname))
+ BUG("Don't recognize hook event '%s'! "
+ "Is it documented in Documentation/githooks.txt?",
+ hookname);
+ return list_hooks_gently(hookname);
+}
+struct list_head *list_hooks_gently(const char *hookname)
+{
+ struct list_head *hook_head = xmalloc(sizeof(struct list_head));
INIT_LIST_HEAD(hook_head);
@@ -103,7 +126,7 @@ struct list_head *list_hooks(const char *hookname)
BUG("null hookname was provided to hook_list()!");
if (have_git_dir()) {
- const char *hook_path = find_hook(hookname);
+ const char *hook_path = find_hook_gently(hookname);
if (hook_path) {
struct hook *to_add = xmalloc(sizeof(*to_add));
to_add->hook_path = hook_path;
@@ -299,6 +322,10 @@ int run_hooks_oneshot(const char *hook_name, struct run_hooks_opt *options)
if (options->path_to_stdin && options->feed_pipe)
BUG("choose only one method to populate stdin");
+ /*
+ * 'git hooks run <hookname>' uses run_hooks, so we don't need to
+ * allow unknown hooknames here.
+ */
hooks = list_hooks(hook_name);
/*
diff --git a/hook.h b/hook.h
index cd3123d290..6b7b2d14d2 100644
--- a/hook.h
+++ b/hook.h
@@ -9,8 +9,16 @@
* 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
* overwritten by further calls to find_hook and run_hook_*.
+ *
+ * If the hook is not a native hook (e.g. present in Documentation/githooks.txt)
+ * find_hook() will BUG(). find_hook_gently() does not consult the native hook
+ * list and will check for any hook name in the hooks directory regardless of
+ * whether it is known. find_hook() should be used by internal calls to hooks,
+ * and find_hook_gently() should only be used when the hookname was provided by
+ * the user, such as by 'git hook run my-wrapper-hook'.
*/
const char *find_hook(const char *name);
+const char *find_hook_gently(const char *name);
/*
* A boolean version of find_hook()
@@ -32,8 +40,14 @@ struct hook {
/*
* Provides a linked list of 'struct hook' detailing commands which should run
* in response to the 'hookname' event, in execution order.
+ *
+ * list_hooks() checks the provided hookname against Documentation/githooks.txt
+ * and BUG()s if it is not found. list_hooks_gently() allows any hookname. The
+ * latter should only be used when the hook name is provided by the user, and
+ * the former should be used by internal callers.
*/
struct list_head *list_hooks(const char *hookname);
+struct list_head *list_hooks_gently(const char *hookname);
struct run_hooks_opt
{
--
2.33.0.rc2.250.ged5fa647cd-goog
