[PATCH 4/4] doc: hook: don’t self-link via config include
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- May 21, 2026, 16:25 UTC
- Message-ID
- <doc_hook_no_self-link.6f4@msgid.xyz>
- In-Reply-To
- <CV_doc_hook.6f0@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Do not link to git-hook(1) from the config options when we already are in that doc.
This implementation is similar to the updates to git-init(1) and git-commit(1), implemented in [1] and [2], respectively.
† 1: e7b3a768 (doc: git-init: rework config item init.templateDir,
2024-03-10)
† 2: 819fdd6e (doc: convert git commit config to new format, 2025-01-15)Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> --- Documentation/config/hook.adoc | 19 +++++++++++++------ Documentation/git-hook.adoc | 1 + 2 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/Documentation/config/hook.adoc b/Documentation/config/hook.adoc index a9dc0063c12..083dc60a132 100644 --- a/Documentation/config/hook.adoc +++ b/Documentation/config/hook.adoc @@ -1,10 +1,17 @@ +ifdef::git-hook[] +:see-git-hook: +endif::git-hook[] +ifndef::git-hook[] +:see-git-hook: See linkgit:git-hook[1]. +endif::git-hook[] + hook.<friendly-name>.command:: The command to execute for `hook.<friendly-name>`. `<friendly-name>` is a unique name that identifies this hook. The hook events that trigger the command are configured with `hook.<friendly-name>.event`. The value can be an executable path or a shell oneliner. If more than one value is specified for the same `<friendly-name>`, only the last - value parsed is used. See linkgit:git-hook[1]. + value parsed is used. {see-git-hook} hook.<friendly-name>.event:: The hook events that trigger `hook.<friendly-name>`. The value is the @@ -14,7 +21,7 @@ hook.<friendly-name>.event:: This is a multi-valued key. To run `hook.<friendly-name>` on multiple events, specify the key more than once. An empty value resets the list of events, clearing any previously defined events for - `hook.<friendly-name>`. See linkgit:git-hook[1]. + `hook.<friendly-name>`. {see-git-hook} + The `<friendly-name>` must not be the same as a known hook event name (e.g. do not use `hook.pre-commit.event`). Using a known event name as @@ -27,7 +34,7 @@ hook.<friendly-name>.enabled:: Set to `false` to disable the hook without removing its configuration. This is particularly useful when a hook is defined in a system or global config file and needs to be disabled for a - specific repository. See linkgit:git-hook[1]. + specific repository. {see-git-hook} hook.<friendly-name>.parallel:: Whether the hook `hook.<friendly-name>` may run in parallel with other hooks @@ -37,13 +44,13 @@ hook.<friendly-name>.parallel:: all hooks for that event run sequentially regardless of `hook.jobs`. Only configured (named) hooks need to declare this. Traditional hooks found in the hooks directory do not need to, and run in parallel when - the effective job count is greater than 1. See linkgit:git-hook[1]. + the effective job count is greater than 1. {see-git-hook} hook.<event>.enabled:: Switch to enable or disable all hooks for the `<event>` hook event. When set to `false`, no hooks fire for that event, regardless of any per-hook `hook.<friendly-name>.enabled` settings. Defaults to `true`. - See linkgit:git-hook[1]. + {see-git-hook} + Note on naming: `<event>` must be the event name (e.g. `pre-commit`), not a hook friendly-name. Since using a known event name as a @@ -60,7 +67,7 @@ hook.<event>.jobs:: setting has no effect unless all configured hooks for the event have `hook.<friendly-name>.parallel` set to `true`. Set to `-1` to use the number of available CPU cores. Must be a positive integer or `-1`; - zero is rejected with a warning. See linkgit:git-hook[1]. + zero is rejected with a warning. {see-git-hook} + Note on naming: although this key resembles `hook.<friendly-name>.*` (a per-hook setting), `<event>` must be the event name, not a hook diff --git a/Documentation/git-hook.adoc b/Documentation/git-hook.adoc index 750df58e58e..4868852aa0b 100644 --- a/Documentation/git-hook.adoc +++ b/Documentation/git-hook.adoc @@ -204,6 +204,7 @@ unintended and unsupported ways. CONFIGURATION ------------- +:git-hook: 1 include::config/hook.adoc[] SEE ALSO
-- 2.54.0.13.g9c7419e39f8