public inbox for tools@linux.kernel.org
 help / color / mirror / Atom feed
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 20/21] docs: cross-reference config options with :term:
Date: Tue, 03 Feb 2026 14:31:19 +0100	[thread overview]
Message-ID: <20260203-misc-docs-v1-20-fddb72511357@cherry.de> (raw)
In-Reply-To: <20260203-misc-docs-v1-0-fddb72511357@cherry.de>

From: Quentin Schulz <quentin.schulz@cherry.de>

This inserts a link to the definition of the config option such that
it's either to find it.

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
 docs/config.rst               | 2 +-
 docs/contributor/prep.rst     | 4 ++--
 docs/contributor/send.rst     | 6 +++---
 docs/maintainer/am-shazam.rst | 2 +-
 docs/maintainer/ty.rst        | 4 ++--
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/docs/config.rst b/docs/config.rst
index f2ed519..d2a80c2 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -28,7 +28,7 @@ file in the repository you're currently using.
 Configuration options
 ---------------------
 All settings are under the ``b4`` section. For example, to set the
-``b4.midmask`` option, add the following section to the relevant git
+:term:`b4.midmask` option, add the following section to the relevant git
 config file::
 
     [b4]
diff --git a/docs/contributor/prep.rst b/docs/contributor/prep.rst
index 9c27b64..e6b45c7 100644
--- a/docs/contributor/prep.rst
+++ b/docs/contributor/prep.rst
@@ -65,7 +65,7 @@ disadvantages in some less-common situations:
 
 For this reason, b4 supports alternative strategies for storing the
 cover letter. You can tell ``b4`` which strategy to use using the
-``b4.prep-cover-strategy`` configuration variable.
+:term:`b4.prep-cover-strategy` configuration variable.
 
 ``commit`` strategy (default)
   This is the default strategy that keeps the cover letter and all
@@ -400,7 +400,7 @@ modifying defaults for some of these flags.
   ``./scripts/checkpatch.pl --terse --no-summary --mailback --showfile``
 
   You can specify your own command by setting the
-  ``b4.prep-perpatch-check-cmd`` configuration parameter. For example
+  :term:`b4.prep-perpatch-check-cmd` configuration parameter. For example
   you can make it more strict::
 
       [b4]
diff --git a/docs/contributor/send.rst b/docs/contributor/send.rst
index f5a1ff1..ba18ef5 100644
--- a/docs/contributor/send.rst
+++ b/docs/contributor/send.rst
@@ -311,13 +311,13 @@ Command line flags
 ``--to``
   Additional email addresses to include into the To: header. Separate
   multiple entries with a comma. You can also set this in the
-  configuration file using the ``b4.send-series-to`` option (see
+  configuration file using the :term:`b4.send-series-to` option (see
   :ref:`contributor_settings`).
 
 ``--cc``
   Additional email addresses to include into the Cc: header. Separate
   multiple entries with a comma. You can also set this in the
-  configuration file using the ``b4.send-series-cc`` option (see
+  configuration file using the :term:`b4.send-series-cc` option (see
   :ref:`contributor_settings`).
 
 ``--not-me-too``
@@ -328,7 +328,7 @@ Command line flags
   Note, that sending via the web submission endpoint requires
   cryptographic signatures at all times, so this is only a valid option
   to use with ``-o`` or when using your own SMTP server. This can be set
-  in the configuration using the ``b4.send-no-patatt-sign`` (see
+  in the configuration using the :term:`b4.send-no-patatt-sign` (see
   :ref:`contributor_settings`).
 
 ``--resend V``
diff --git a/docs/maintainer/am-shazam.rst b/docs/maintainer/am-shazam.rst
index 1ca9b50..5c3fb75 100644
--- a/docs/maintainer/am-shazam.rst
+++ b/docs/maintainer/am-shazam.rst
@@ -175,7 +175,7 @@ The following flags are common to both commands:
       ./scripts/checkpatch.pl -q --terse --no-summary --mailback
 
   You can specify a different command to run by setting the
-  ``b4.am-perpatch-check-cmd`` configuration setting, e.g.::
+  :term:`b4.am-perpatch-check-cmd` configuration setting, e.g.::
 
       [b4]
       am-perpatch-check-cmd = ./scripts/checkpatch.pl -q --terse --no-summary --mailback --strict
diff --git a/docs/maintainer/ty.rst b/docs/maintainer/ty.rst
index 21c56de..c1b79b5 100644
--- a/docs/maintainer/ty.rst
+++ b/docs/maintainer/ty.rst
@@ -66,7 +66,7 @@ happy with the results, you can omit the ``--dry-run`` switch to
 actually send the mail.
 
 If you want ``b4 ty`` to always send mail, you can make the ``-S``
-switch permanent by setting the ``b4.ty-send-email`` config variable to
+switch permanent by setting the :term:`b4.ty-send-email` config variable to
 ``yes``.
 
 Editing the templates
@@ -74,7 +74,7 @@ Editing the templates
 You can edit the default templates that are provided with b4 to
 customize the thank-you message. Once you have your own versions, you
 can specify the path to the template to use via the
-``b4.thanks-am-template`` and ``b4.thanks-pr-template`` configuration
+:term:`b4.thanks-am-template` and :term:`b4.thanks-pr-template` configuration
 parameters. See :ref:`ty_settings` for details.
 
 Optional flags

-- 
2.52.0


  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 ` [PATCH b4 17/21] docs: config: use rST version admonitions Quentin Schulz
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 ` Quentin Schulz [this message]
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-20-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