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>,
Your Name <your.name@example.com>
Subject: [PATCH b4 00/21] docs: various fixes + migration from definition lists to glossaries for config settings
Date: Tue, 03 Feb 2026 14:30:59 +0100 [thread overview]
Message-ID: <20260203-misc-docs-v1-0-fddb72511357@cherry.de> (raw)
This makes use of rST version admonitions for config settings in
anticipation to make each config setting a term such that we can
cross-reference them easily and have an anchor in the output for easier
link sharing. Then it migrates current "verbatim cross-references" to
actual cross-references using :term:.
This adds version admonitions for sections applicable only to some
versions and for program arguments.
This separates the b4.thanks-pr-template and b4.thanks-am-template as
well as include verbatim the example templates from the repo (for
b4.shazam-merge-template) instead of vaguely mentioning them.
This fixes various typos.
This adds external links to manpages.
This adds missing info on settings/options version deprecation and
addition.
This sorts the config settings per section (glossary), both by enforcing
it at the directive level and also in the text.
This adds missing b4.linkmask reference to b4 am/shazam --add-link.
I haven't changed the program options into a glossary, but this is
something I could do if there's interest.
Note: ``b4 send`` seems to be picking up
``Signed-off-by: Your Name <your.name@example.com>`` from the git
context in patch 11 and adds it to Cc recipients for some reason??
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
Quentin Schulz (21):
docs: maintainer: ty: fix incorrect config name for templates
docs: prep: add info on when range-diff-opts was added
docs: diff: add info on when range-diff-opts was added
docs: contributor: send: fix sendmail typo
docs: config: separate b4.thanks-pr-template and b4.thanks-am-template
docs: use rST version admonitions for command options
docs: use versionadded admonition for sections
docs: maintainer: use deprecated admonition
docs: config: provide link to git-config conf file documentation
docs: config: fix discrepancy between example strings
docs: move sentence-ending dots from within the last quoted string to outside
docs: config: add missing dot at end of sentence
docs: config: provide link to patatt
docs: config: provide link to git-send-email manpage
docs: config: fix double colon typo
docs: config: provide example content for template files
docs: config: use rST version admonitions
docs: config: migrate definition lists to glossaries
docs: config: sort glossaries
docs: cross-reference config options with :term:
docs: maintainer: am-shazam: cross-reference b4.linkmask for --add-link
docs/config.rst | 615 +++++++++++++++++++++++-------------------
docs/contributor/prep.rst | 49 +++-
docs/contributor/send.rst | 34 ++-
docs/maintainer/am-shazam.rst | 12 +-
docs/maintainer/diff.rst | 16 +-
docs/maintainer/mbox.rst | 12 +-
docs/maintainer/pr.rst | 13 +-
docs/maintainer/ty.rst | 8 +-
8 files changed, 437 insertions(+), 322 deletions(-)
---
base-commit: 38c61e3d0a1b2b14ee75f3d763362fd63e162849
change-id: 20260203-misc-docs-1dca48ffccc0
Best regards,
--
Quentin Schulz <quentin.schulz@cherry.de>
next 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 Quentin Schulz [this message]
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 ` [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-0-fddb72511357@cherry.de \
--to=foss+kernel@0leil.net \
--cc=konstantin@linuxfoundation.org \
--cc=quentin.schulz@cherry.de \
--cc=tools@kernel.org \
--cc=your.name@example.com \
/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