From: Quentin Schulz <foss+kernel@0leil.net>
To: "Kernel.org Tools" <tools@kernel.org>
Cc: Konstantin Ryabitsev <konstantin@linuxfoundation.org>,
Quentin Schulz <quentin.schulz@cherry.de>
Subject: [PATCH b4 17/21] docs: config: use rST version admonitions
Date: Tue, 03 Feb 2026 14:31:16 +0100 [thread overview]
Message-ID: <20260203-misc-docs-v1-17-fddb72511357@cherry.de> (raw)
In-Reply-To: <20260203-misc-docs-v1-0-fddb72511357@cherry.de>
From: Quentin Schulz <quentin.schulz@cherry.de>
rST provides directives[1] to specify for which version something was
added or modified, so let's use that.
This notably frees the definition list's term of the version string
which will be important in the next commit where the definition lists
are replaced by glossary terms such that they automatically provide an
anchor which makes it easier to share a link to the config setting and
also allows to link at the term definition with :term: across the docs.
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#describing-changes-between-versions
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
docs/config.rst | 52 +++++++++++++++++++++++++++++++++++++---------------
1 file changed, 37 insertions(+), 15 deletions(-)
diff --git a/docs/config.rst b/docs/config.rst
index edd4678..735684e 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -58,7 +58,7 @@ These options control many of the core features of b4.
Default: ``https://lore.kernel.org/all/?x=m&t=1&q=%s``
-``b4.linktrailermask`` (v0.13+)
+``b4.linktrailermask``
Overrides the format of the ``Link:`` trailer, in case you want to
call it something other than "Link". For example, some projects
use "Message-ID" trailers instead::
@@ -67,12 +67,14 @@ These options control many of the core features of b4.
The ``%s`` is the placeholder for the message-id.
- Note: starting with version 0.14, you can pass the ``-i`` command-line
- switch instead of ``-l`` to automatically insert the ``Message-ID``
- trailer.
-
Default: ``Link: https://lore.kernel.org/%s``
+ .. versionadded:: v0.13
+
+ .. versionchanged:: v0.14
+ You can now pass the ``-i`` command-line switch instead of ``-l`` to
+ automatically insert the ``Message-ID`` trailer.
+
``b4.listid-preference``
Sometimes messages with the same message-id can have different
contents, because some servers modify message bodies to inject list
@@ -163,7 +165,7 @@ These settings control ``b4 am`` and ``b4 shazam`` behavior.
Default: ``None``
-``b4.am-perpatch-check-cmd`` (v0.14+)
+``b4.am-perpatch-check-cmd``
The command to use when running ``--check``. The command is run once for each
patch to check. The patch file to check is piped through stdin. If this
config is defined multiple times, all commands will be run. If this config is
@@ -172,6 +174,8 @@ These settings control ``b4 am`` and ``b4 shazam`` behavior.
Default: ``./scripts/checkpatch.pl -q --terse --no-summary --mailback``
+ .. versionadded:: v0.14
+
.. _attestation_settings:
Attestation settings
@@ -193,7 +197,7 @@ Attestation settings
Default: ``yes``
-``b4.attestation-dns-resolvers`` (v0.14+)
+``b4.attestation-dns-resolvers``
You can specify your own DNS servers if you are on a company network
and your OS-provided resolvers aren't able to perform domain key
lookups. For example, to use Google DNS servers::
@@ -202,6 +206,8 @@ Attestation settings
Default: ``None``
+ .. versionadded:: v0.14
+
``b4.attestation-staleness-days``
Ignore attestation signatures that are more than this many days
old. This helps avoid a class of attacks when someone re-sends old
@@ -269,7 +275,7 @@ Attestation settings
Default: ``None``
-``b4.thanks-from-name`` (v0.13+)
+``b4.thanks-from-name``
The name to use in the ``From:`` header when sending thank-you notes.
By default, b4 uses ``user.name``. For example::
@@ -277,7 +283,9 @@ Attestation settings
Default: ``None``
-``b4.thanks-from-email`` (v0.13+)
+ .. versionadded:: v0.13
+
+``b4.thanks-from-email``
The email to use in the ``From:`` header when sending thank-you notes.
By default, b4 uses ``user.email``. For example::
@@ -285,6 +293,8 @@ Attestation settings
Default: ``None``
+ .. versionadded:: v0.13
+
``b4.thanks-treename``
Name of the tree to use in the thank-you templates.
@@ -306,12 +316,14 @@ Attestation settings
Default: ``None``
-``b4.ty-send-email`` (v0.11+)
+``b4.ty-send-email``
When set, tells ``b4 ty`` to send email directly instead of writing
out ``.thanks`` files.
Default: ``no``
+ .. versionadded:: v0.11
+
.. _patchwork_settings:
Patchwork integration settings
@@ -410,19 +422,24 @@ Contributor-oriented settings
Default: ``scripts/get_maintainer.pl --nogit --nogit-fallback --nogit-chief-penguins --norolestats --nom``
-``b4.send-same-thread`` (v0.13+)
+``b4.send-same-thread``
When sending a new version of a series, send it in the same thread as
the previous version. The config supports the following values:
* ``yes``, ``true``, ``y``: B4 sends the first message of the new series as a
reply to the previous version's cover letter.
* ``shallow``: B4 sends the first message of the new series as a reply to the
- first version's cover letter. (v0.15+)
+ first version's cover letter.
* ``no``: B4 does not send the new version of the series in the same thread
as any previous version.
Default: ``no``
+ .. versionadded:: v0.13
+
+ .. versionchanged:: v0.15
+ Added ``shallow`` config value.
+
``b4.prep-cover-strategy``
Alternative cover letter storage strategy to use, in case you don't
want to use the default ``commit`` strategy. See
@@ -444,14 +461,16 @@ Contributor-oriented settings
Default: ``None``
-``b4.send-prefixes`` (v0.11+)
+``b4.send-prefixes``
Extra prefixes to add to ``[PATCH]`` (e.g. ``RFC mydrv``).
This setting can be replaced for a series with ``b4 prep --set-prefixes``.
Default: ``None``
-``b4.prep-perpatch-check-cmd`` (v0.14+)
+ .. versionadded:: v0.11
+
+``b4.prep-perpatch-check-cmd``
The command to use when running ``--check``. The command is run once for each
patch to check. The patch file to check is piped through stdin. If this
config is defined multiple times, all commands will be run. If this config is
@@ -460,7 +479,9 @@ Contributor-oriented settings
Default: ``./scripts/checkpatch.pl -q --terse --no-summary --mailback --showfile``
-``b4.prep-pre-flight-checks`` (v0.14+)
+ .. versionadded:: v0.14
+
+``b4.prep-pre-flight-checks``
You can use this to turn off some or all pre-flight checks that b4 runs
prior to sending out patches. To cancel all checks::
@@ -473,6 +494,7 @@ Contributor-oriented settings
[b4]
prep-pre-flight-checks = disable-needs-auto-to-cc, needs-checking
+ .. versionadded:: v0.14
To document
-----------
--
2.52.0
next prev parent reply other threads:[~2026-02-03 13:31 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-03 13:30 [PATCH b4 00/21] docs: various fixes + migration from definition lists to glossaries for config settings Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 01/21] docs: maintainer: ty: fix incorrect config name for templates Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 02/21] docs: prep: add info on when range-diff-opts was added Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 03/21] docs: diff: " Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 04/21] docs: contributor: send: fix sendmail typo Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 05/21] docs: config: separate b4.thanks-pr-template and b4.thanks-am-template Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 06/21] docs: use rST version admonitions for command options Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 07/21] docs: use versionadded admonition for sections Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 08/21] docs: maintainer: use deprecated admonition Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 09/21] docs: config: provide link to git-config conf file documentation Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 10/21] docs: config: fix discrepancy between example strings Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 11/21] docs: move sentence-ending dots from within the last quoted string to outside Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 12/21] docs: config: add missing dot at end of sentence Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 13/21] docs: config: provide link to patatt Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 14/21] docs: config: provide link to git-send-email manpage Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 15/21] docs: config: fix double colon typo Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 16/21] docs: config: provide example content for template files Quentin Schulz
2026-02-03 13:31 ` Quentin Schulz [this message]
2026-02-03 13:31 ` [PATCH b4 18/21] docs: config: migrate definition lists to glossaries Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 19/21] docs: config: sort glossaries Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 20/21] docs: cross-reference config options with :term: Quentin Schulz
2026-02-03 13:31 ` [PATCH b4 21/21] docs: maintainer: am-shazam: cross-reference b4.linkmask for --add-link Quentin Schulz
2026-02-03 22:00 ` [PATCH b4 00/21] docs: various fixes + migration from definition lists to glossaries for config settings Konstantin Ryabitsev
2026-02-09 11:09 ` Quentin Schulz
2026-02-24 17:02 ` Konstantin Ryabitsev
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=20260203-misc-docs-v1-17-fddb72511357@cherry.de \
--to=foss+kernel@0leil.net \
--cc=konstantin@linuxfoundation.org \
--cc=quentin.schulz@cherry.de \
--cc=tools@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