From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH 4/4] doc: am: fill out hook discussion
Date: Mon, 9 Feb 2026 18:34:37 +0100 [thread overview]
Message-ID: <am_hooks.325@msgid.xyz> (raw)
In-Reply-To: <doc_am_gitlinks_and_am.messageId.321@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Document `--verify` and rephrase the `--[no-]verify` section to lead
with the default, in imperative mood.[1]
Historically it makes sense that only the negated forms are documented;
they are all run by default and thus you only need to use hook options
if you want to turn some of them off. But, beyond just desiring uniform
documentation,[2] it’s very much possible to have, say, a Git alias with
`--no-verify` that you might sometimes want to turn back on with
the *positive* form.
Also mention the options in the “Hooks” section and mention that
`post-applypatch` cannot be skipped.
† 1: See e.g. acffc5e9 (doc: convert git-remote to synopsis style,
2025-12-20)
† 2: https://lore.kernel.org/git/xmqqcyct1mtq.fsf@gitster.g/
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Notes (series):
Does not need an update to the usage in `builtin/am.c` because it is
excluded in `t/t0450/adoc-help-mismatches`.
Documentation/git-am.adoc | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-am.adoc b/Documentation/git-am.adoc
index 5e0d6e6fe02..84ec9fee8df 100644
--- a/Documentation/git-am.adoc
+++ b/Documentation/git-am.adoc
@@ -9,7 +9,7 @@ git-am - Apply a series of patches from a mailbox
SYNOPSIS
--------
[verse]
-'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--no-verify]
+'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--[no-]verify]
[--[no-]3way] [--interactive] [--committer-date-is-author-date]
[--ignore-date] [--ignore-space-change | --ignore-whitespace]
[--whitespace=<action>] [-C<n>] [-p<n>] [--directory=<dir>]
@@ -150,11 +150,14 @@ Valid <action> for the `--whitespace` option are:
--interactive::
Run interactively.
+--verify::
-n::
--no-verify::
- By default, the pre-applypatch and applypatch-msg hooks are run.
- When any of `--no-verify` or `-n` is given, these are bypassed.
- See also linkgit:githooks[5].
+ Run the `pre-applypatch` and `applypatch-msg` hooks. This is the
+ default. Skip these hooks with `-n` or `--no-verify`. See also
+ linkgit:githooks[5].
++
+Note that `post-applypatch` cannot be skipped.
--committer-date-is-author-date::
By default the command records the date from the e-mail
@@ -290,6 +293,8 @@ This command can run `applypatch-msg`, `pre-applypatch`,
and `post-applypatch` hooks. See linkgit:githooks[5] for more
information.
+See the `--verify`/`-n`/`--no-verify` options.
+
CONFIGURATION
-------------
--
2.53.0.26.g2afa8602a26
next prev parent reply other threads:[~2026-02-09 17:36 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-09 17:34 [PATCH 0/4] doc: am: improve command linking and add am.messageId kristofferhaugsbakk
2026-02-09 17:34 ` [PATCH 1/4] doc: am: normalize git(1) command links kristofferhaugsbakk
2026-02-11 17:32 ` Kristoffer Haugsbakk
2026-02-09 17:34 ` [PATCH 2/4] doc: am: say that --message-id adds a trailer kristofferhaugsbakk
2026-02-09 17:34 ` [PATCH 3/4] doc: am: add missing config am.messageId kristofferhaugsbakk
2026-02-09 17:34 ` kristofferhaugsbakk [this message]
2026-02-09 21:57 ` [PATCH 0/4] doc: am: improve command linking and add am.messageId D. Ben Knoble
2026-02-09 22:22 ` 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=am_hooks.325@msgid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.