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 08/21] docs: maintainer: use deprecated admonition
Date: Tue, 03 Feb 2026 14:31:07 +0100 [thread overview]
Message-ID: <20260203-misc-docs-v1-8-fddb72511357@cherry.de> (raw)
In-Reply-To: <20260203-misc-docs-v1-0-fddb72511357@cherry.de>
From: Quentin Schulz <quentin.schulz@cherry.de>
Use the rST deprecated admonition[1] to specify since which release this
has been deprecated.
One can add information as to what to replace the option with, so that's
what's done wherever we have that information.
The version is the first one to have the commits which inserts the
deprecated string for the options, which is commit 2ce1e619ddb4 ("docs:
complete most of the maintainer docs") available in v0.10.
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated
Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
---
docs/maintainer/diff.rst | 14 +++++++++-----
docs/maintainer/pr.rst | 13 +++++++++----
2 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/docs/maintainer/diff.rst b/docs/maintainer/diff.rst
index 4e3fac0..f546fd6 100644
--- a/docs/maintainer/diff.rst
+++ b/docs/maintainer/diff.rst
@@ -50,10 +50,14 @@ Optional flags
.. versionadded:: v0.15
``-o OUTDIFF, --output-diff OUTDIFF``
- **(DEPRECATED)** Sends ``range-diff`` output into a file. You should use
- ``-n`` instead and redirect output from the actual ``git range-diff``
- command.
+ Sends ``range-diff`` output into a file.
+
+ .. deprecated:: v0.10
+ You should use ``-n`` instead and redirect output from the actual
+ ``git range-diff`` command.
``-c, --color``
- **(DEPRECATED)** Show colour output even when outputting into a file.
- You should use ``-n`` instead and modify flags to ``range-diff``.
+ Show colour output even when outputting into a file.
+
+ .. deprecated:: v0.10
+ You should use ``-n`` instead and modify flags to ``range-diff``.
diff --git a/docs/maintainer/pr.rst b/docs/maintainer/pr.rst
index 46db7ee..ca0310d 100644
--- a/docs/maintainer/pr.rst
+++ b/docs/maintainer/pr.rst
@@ -64,14 +64,19 @@ archival public-inbox so they can be analyzed by archivists at a later
date if necessary.
``-f MAILFROM, --from-addr MAILFROM``
- **(DEPRECATED)** When exploding pull requests, use this email address
+ When exploding pull requests, use this email address
in the From header, instead of reusing the same From as in the pull
request.
+ .. deprecated:: v0.10
+
``-s SENDIDENTITY, --send-as-identity SENDIDENTITY``
- **(DEPRECATED)** When resending pull requests as patch series, use
+ When resending pull requests as patch series, use
this sendemail identity.
-``--dry-run``
- **(DEPRECATED)** Force a --dry-run on ``git-send-email`` invocation.
+ .. deprecated:: v0.10
+``--dry-run``
+ Force a --dry-run on ``git-send-email`` invocation.
+
+ .. deprecated:: v0.10
--
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 ` Quentin Schulz [this message]
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-8-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