Maintainer workflows discussions
 help / color / mirror / Atom feed
From: Manuel Ebner <manuelebnerli@mailbox.org>
To: "Jonathan Corbet" <corbet@lwn.net>,
	"Shuah Khan" <skhan@linuxfoundation.org>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Boqun Feng" <boqun@kernel.org>, "Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Andreas Hindborg" <a.hindborg@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Daniel Almeida" <daniel.almeida@collabora.com>,
	"Tamir Duberstein" <tamird@kernel.org>,
	"Alexandre Courbot" <acourbot@nvidia.com>,
	"Onur Özkan" <work@onurozkan.dev>,
	"Nathan Chancellor" <nathan@kernel.org>,
	"Nick Desaulniers" <nick.desaulniers+lkml@gmail.com>,
	"Bill Wendling" <morbo@google.com>,
	"Justin Stitt" <justinstitt@google.com>
Cc: Manuel Ebner <manuelebnerli@mailbox.org>,
	workflows@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org,
	llvm@lists.linux.dev
Subject: [PATCH 5/5] Docs: software-requirements.rst replace optional tag with footnotes
Date: Wed, 12 Aug 2026 14:24:22 +0200	[thread overview]
Message-ID: <20260812122426.1636227-2-manuelebnerli@mailbox.org> (raw)
In-Reply-To: <20260812120805.1631430-3-manuelebnerli@mailbox.org>

The optional tag isn't obvious nor defined. Therefore replace with footnotes
like the one of Sphinx.

Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
---
 .../process/software-requirements.rst         | 22 ++++++++++++-------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/Documentation/process/software-requirements.rst b/Documentation/process/software-requirements.rst
index 5fdfcf6a0c01..a31e0ae20498 100644
--- a/Documentation/process/software-requirements.rst
+++ b/Documentation/process/software-requirements.rst
@@ -33,20 +33,20 @@ you probably do not need to concern yourself with pcmciautils.
 ====================== ===============  ========================================
 bash                   4.2              bash --version
 bc                     1.06.95          bc --version
-bindgen (optional)     0.71.1           bindgen --version
+bindgen [#f1]_         0.71.1           bindgen --version
 binutils               2.30             ld -v
 bison                  2.0              bison --version
 btrfs-progs            0.18             btrfs --version
-Clang/LLVM (optional)  17.0.1           clang --version
+Clang/LLVM [#f2]_      17.0.1           clang --version
 e2fsprogs              1.41.4           e2fsck -V
 flex                   2.5.35           flex --version
 gdb                    7.2              gdb --version
-GNU awk (optional)     5.1.0            gawk --version
+GNU awk [#f3]_         5.1.0            gawk --version
 GNU C                  8.1              gcc --version
 GNU make               4.0              make --version
 GNU tar                1.28             tar --version
 GRUB                   0.93             grub --version || grub-install --version
-gtags (optional)       6.6.5            gtags --version
+gtags [#f4]_           6.6.5            gtags --version
 ip-route2              6.14.0           ip -V
 iptables               1.4.2            iptables -V
 jfsutils               1.1.3            fsck.jfs -V
@@ -54,7 +54,7 @@ kmod                   13               kmod -V
 liblzma                5.8.1            lzma -V
 lzop                   1.04             lzop -V
 mcelog                 0.6              mcelog --version
-mkimage (optional)     2017.01          mkimage --version
+mkimage [#f5]_         2017.01          mkimage --version
 nfs-utils              1.0.5            showmount --version
 openssl & libcrypto    1.0.0            openssl version
 pahole                 1.26             pahole --version
@@ -63,8 +63,8 @@ PPP                    2.4.0            pppd --version
 procps                 3.2.0            ps --version
 Python                 3.9.x            python3 --version
 quota-tools            3.09             quota -V
-Rust (optional)        1.85.0           rustc --version
-Sphinx\ [#f1]_         3.4.3            sphinx-build --version
+Rust [#f6]_            1.85.0           rustc --version
+Sphinx\ [#f7]_         3.4.3            sphinx-build --version
 squashfs-tools         4.0              mksquashfs -version
 udev                   081              udevadm --version
 util-linux             2.10o            mount --version
@@ -72,7 +72,13 @@ xfsprogs               2.6.0            xfs_db -V
 xz                     5.8.1            xz -V
 ====================== ===============  ========================================
 
-.. [#f1] Sphinx is needed only to build the Kernel documentation
+.. [#f1] bindgen is needed to generate Rust bindings
+.. [#f2] Clang/LLVM is an alternative to GNU C (gcc)
+.. [#f3] awk is needed with CONFIG_BUILTIN_MODULE_RANGES set
+.. [#f4] gtags is there to generate tag files through ``make gtags``
+.. [#f5] mkimage is used when building a Flat Image Tree (FIT)
+.. [#f6] Rust is only required when enabled
+.. [#f7] Sphinx is needed only to build the Kernel documentation
 
 Kernel compilation
 ******************
-- 
2.54.0


  parent reply	other threads:[~2026-08-12 12:29 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-12 12:08 [PATCH 0/5] Docs: changes.rst: Rework Manuel Ebner
2026-08-12 12:14 ` [PATCH 1/5] Docs: changes.rst: rename file and references and add links Manuel Ebner
2026-08-12 13:07   ` bot+bpf-ci
2026-08-12 13:15   ` Jonathan Corbet
2026-08-13  0:05     ` Randy Dunlap
2026-08-12 12:19 ` [PATCH 2/5] Docs: software-requirements.rst: Refine language Manuel Ebner
2026-08-13  0:03   ` Randy Dunlap
2026-08-12 12:21 ` [PATCH 3/5] Docs: software-requirements.rst: add lzop, lzma and ip-route2 Manuel Ebner
2026-08-13  0:04   ` Randy Dunlap
2026-08-13  7:47   ` Manuel Ebner
2026-08-12 12:24 ` Manuel Ebner [this message]
2026-08-13  0:02   ` [PATCH 5/5] Docs: software-requirements.rst replace optional tag with footnotes Randy Dunlap
2026-08-13  0:11   ` John Hubbard
2026-08-13 13:15   ` Jonathan Corbet
2026-08-13 14:30     ` Manuel Ebner

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=20260812122426.1636227-2-manuelebnerli@mailbox.org \
    --to=manuelebnerli@mailbox.org \
    --cc=a.hindborg@kernel.org \
    --cc=acourbot@nvidia.com \
    --cc=aliceryhl@google.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dakr@kernel.org \
    --cc=daniel.almeida@collabora.com \
    --cc=gary@garyguo.net \
    --cc=justinstitt@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=llvm@lists.linux.dev \
    --cc=lossin@kernel.org \
    --cc=morbo@google.com \
    --cc=nathan@kernel.org \
    --cc=nick.desaulniers+lkml@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tamird@kernel.org \
    --cc=tmgross@umich.edu \
    --cc=work@onurozkan.dev \
    --cc=workflows@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