From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>
Subject: [PATCH 1/4] doc: am: normalize git(1) command links
Date: Mon, 9 Feb 2026 18:34:34 +0100 [thread overview]
Message-ID: <git-am_gitlinks.322@msgid.xyz> (raw)
In-Reply-To: <doc_am_gitlinks_and_am.messageId.321@msgid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
There are many mentions of commands using inline-verbatim or
emphasis ('). We just mention the command themselves, not specific
invocations like `git am <opts>`. Let’s link to them instead.
There are also many such mentions which then link to the command right
afterwards. Simplify to just using a link.
Also remove “see <gitlink>” phrases where they have now already
been mentioned.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Documentation/config/am.adoc | 18 +++++++++---------
Documentation/git-am.adoc | 31 +++++++++++++++----------------
2 files changed, 24 insertions(+), 25 deletions(-)
diff --git a/Documentation/config/am.adoc b/Documentation/config/am.adoc
index 5bcad2efb11..19ef5aa00c4 100644
--- a/Documentation/config/am.adoc
+++ b/Documentation/config/am.adoc
@@ -1,14 +1,14 @@
am.keepcr::
- If true, git-am will call git-mailsplit for patches in mbox format
- with parameter `--keep-cr`. In this case git-mailsplit will
+ If true, linkgit:git-am[1] will call linkgit:git-mailsplit[1]
+ for patches in mbox format with parameter `--keep-cr`. In this
+ case linkgit:git-mailsplit[1] will
not remove `\r` from lines ending with `\r\n`. Can be overridden
by giving `--no-keep-cr` from the command line.
- See linkgit:git-am[1], linkgit:git-mailsplit[1].
am.threeWay::
- By default, `git am` will fail if the patch does not apply cleanly. When
- set to true, this setting tells `git am` to fall back on 3-way merge if
- the patch records the identity of blobs it is supposed to apply to and
- we have those blobs available locally (equivalent to giving the `--3way`
- option from the command line). Defaults to `false`.
- See linkgit:git-am[1].
+ By default, linkgit:git-am[1] will fail if the patch does not
+ apply cleanly. When set to true, this setting tells
+ linkgit:git-am[1] to fall back on 3-way merge if the patch
+ records the identity of blobs it is supposed to apply to and we
+ have those blobs available locally (equivalent to giving the
+ `--3way` option from the command line). Defaults to `false`.
diff --git a/Documentation/git-am.adoc b/Documentation/git-am.adoc
index 0c94776e296..70c605b4156 100644
--- a/Documentation/git-am.adoc
+++ b/Documentation/git-am.adoc
@@ -43,14 +43,14 @@ OPTIONS
-k::
--keep::
- Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-k` flag to linkgit:git-mailinfo[1].
--keep-non-patch::
- Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-b` flag to linkgit:git-mailinfo[1].
--keep-cr::
--no-keep-cr::
- With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
+ With `--keep-cr`, call linkgit:git-mailsplit[1]
with the same option, to prevent it from stripping CR at the end of
lines. `am.keepcr` configuration variable can be used to specify the
default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
@@ -65,7 +65,7 @@ OPTIONS
Ignore scissors lines (see linkgit:git-mailinfo[1]).
--quoted-cr=<action>::
- This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ This flag will be passed down to linkgit:git-mailinfo[1].
--empty=(drop|keep|stop)::
How to handle an e-mail message lacking a patch:
@@ -83,7 +83,7 @@ OPTIONS
-m::
--message-id::
- Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
+ Pass the `-m` flag to linkgit:git-mailinfo[1],
so that the Message-ID header is added to the commit message.
The `am.messageid` configuration variable can be used to specify
the default behaviour.
@@ -98,7 +98,7 @@ OPTIONS
-u::
--utf8::
- Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-u` flag to linkgit:git-mailinfo[1].
The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable
`i18n.commitEncoding` can be used to specify the project's
@@ -108,8 +108,7 @@ This was optional in prior versions of git, but now it is the
default. You can use `--no-utf8` to override this.
--no-utf8::
- Pass `-n` flag to 'git mailinfo' (see
- linkgit:git-mailinfo[1]).
+ Pass `-n` flag to linkgit:git-mailinfo[1].
-3::
--3way::
@@ -132,9 +131,8 @@ include::rerere-options.adoc[]
--exclude=<path>::
--include=<path>::
--reject::
- These flags are passed to the 'git apply' (see linkgit:git-apply[1])
- program that applies
- the patch.
+ These flags are passed to the linkgit:git-apply[1] program that
+ applies the patch.
+
Valid <action> for the `--whitespace` option are:
`nowarn`, `warn`, `fix`, `error`, and `error-all`.
@@ -205,7 +203,8 @@ applying.
to the screen before exiting. This overrides the
standard message informing you to use `--continue`
or `--skip` to handle the failure. This is solely
- for internal use between 'git rebase' and 'git am'.
+ for internal use between linkgit:git-rebase[1] and
+ linkgit:git-am[1].
--abort::
Restore the original branch and abort the patching operation.
@@ -223,7 +222,7 @@ applying.
failure again.
--show-current-patch[=(diff|raw)]::
- Show the message at which `git am` has stopped due to
+ Show the message at which linkgit:git-am[1] has stopped due to
conflicts. If `raw` is specified, show the raw contents of
the e-mail message; if `diff`, show the diff portion only.
Defaults to `raw`.
@@ -261,7 +260,7 @@ message. Any line that is of the form:
is taken as the beginning of a patch, and the commit log message
is terminated before the first occurrence of such a line.
-When initially invoking `git am`, you give it the names of the mailboxes
+When initially invoking linkgit:git-am[1], you give it the names of the mailboxes
to process. Upon seeing the first patch that does not apply, it
aborts in the middle. You can recover from this in one of two ways:
@@ -279,8 +278,8 @@ names.
Before any patches are applied, ORIG_HEAD is set to the tip of the
current branch. This is useful if you have problems with multiple
-commits, like running 'git am' on the wrong branch or an error in the
-commits that is more easily fixed by changing the mailbox (e.g.
+commits, like running linkgit:git-am[1] on the wrong branch or an error
+in the commits that is more easily fixed by changing the mailbox (e.g.
errors in the "From:" lines).
HOOKS
--
2.53.0.26.g2afa8602a26
next prev parent reply other threads:[~2026-02-09 17:35 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 ` kristofferhaugsbakk [this message]
2026-02-11 17:32 ` [PATCH 1/4] doc: am: normalize git(1) command links 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 ` [PATCH 4/4] doc: am: fill out hook discussion kristofferhaugsbakk
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=git-am_gitlinks.322@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox