From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Jonathan Corbet" <corbet@lwn.net>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH 21/27] docs: admin-guide/abi: split files from symbols
Date: Mon, 10 Feb 2025 11:18:10 +0100 [thread overview]
Message-ID: <30e3cf2a8aeef23ca889de60a90f7de141e0dc0e.1739182025.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1739182025.git.mchehab+huawei@kernel.org>
Now that get_abi has gained support for filtering its output,
split ABI symbols from files at the html output.
That makes pages smaller and easier to navigate.
As an additional bonus, as it will paralelize files handling,
it gives an additional performance improvement.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/admin-guide/abi-obsolete-files.rst | 7 +++++++
Documentation/admin-guide/abi-obsolete.rst | 1 +
Documentation/admin-guide/abi-readme-file.rst | 6 ++++++
Documentation/admin-guide/abi-removed-files.rst | 7 +++++++
Documentation/admin-guide/abi-removed.rst | 1 +
Documentation/admin-guide/abi-stable-files.rst | 7 +++++++
Documentation/admin-guide/abi-stable.rst | 1 +
Documentation/admin-guide/abi-testing-files.rst | 7 +++++++
Documentation/admin-guide/abi-testing.rst | 1 +
Documentation/admin-guide/abi.rst | 15 +++++++++++++++
10 files changed, 53 insertions(+)
create mode 100644 Documentation/admin-guide/abi-obsolete-files.rst
create mode 100644 Documentation/admin-guide/abi-readme-file.rst
create mode 100644 Documentation/admin-guide/abi-removed-files.rst
create mode 100644 Documentation/admin-guide/abi-stable-files.rst
create mode 100644 Documentation/admin-guide/abi-testing-files.rst
diff --git a/Documentation/admin-guide/abi-obsolete-files.rst b/Documentation/admin-guide/abi-obsolete-files.rst
new file mode 100644
index 000000000000..3061a916b4b5
--- /dev/null
+++ b/Documentation/admin-guide/abi-obsolete-files.rst
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Obsolete ABI Files
+==================
+
+.. kernel-abi:: obsolete
+ :no-symbols:
diff --git a/Documentation/admin-guide/abi-obsolete.rst b/Documentation/admin-guide/abi-obsolete.rst
index bdef91d2cea4..640f3903e847 100644
--- a/Documentation/admin-guide/abi-obsolete.rst
+++ b/Documentation/admin-guide/abi-obsolete.rst
@@ -10,3 +10,4 @@ The description of the interface will document the reason why it is
obsolete and when it can be expected to be removed.
.. kernel-abi:: obsolete
+ :no-files:
diff --git a/Documentation/admin-guide/abi-readme-file.rst b/Documentation/admin-guide/abi-readme-file.rst
new file mode 100644
index 000000000000..6172e4ccbda2
--- /dev/null
+++ b/Documentation/admin-guide/abi-readme-file.rst
@@ -0,0 +1,6 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+ABI README
+==========
+
+.. kernel-abi:: README
diff --git a/Documentation/admin-guide/abi-removed-files.rst b/Documentation/admin-guide/abi-removed-files.rst
new file mode 100644
index 000000000000..f1bdfadd2ec4
--- /dev/null
+++ b/Documentation/admin-guide/abi-removed-files.rst
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Removed ABI Files
+=================
+
+.. kernel-abi:: removed
+ :no-symbols:
diff --git a/Documentation/admin-guide/abi-removed.rst b/Documentation/admin-guide/abi-removed.rst
index bea0608b8442..88832d3eacd6 100644
--- a/Documentation/admin-guide/abi-removed.rst
+++ b/Documentation/admin-guide/abi-removed.rst
@@ -4,3 +4,4 @@ ABI removed symbols
===================
.. kernel-abi:: removed
+ :no-files:
diff --git a/Documentation/admin-guide/abi-stable-files.rst b/Documentation/admin-guide/abi-stable-files.rst
new file mode 100644
index 000000000000..f867738fc178
--- /dev/null
+++ b/Documentation/admin-guide/abi-stable-files.rst
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Stable ABI Files
+================
+
+.. kernel-abi:: stable
+ :no-symbols:
diff --git a/Documentation/admin-guide/abi-stable.rst b/Documentation/admin-guide/abi-stable.rst
index 33637c0d4fd5..528c68401f4b 100644
--- a/Documentation/admin-guide/abi-stable.rst
+++ b/Documentation/admin-guide/abi-stable.rst
@@ -13,3 +13,4 @@ Most interfaces (like syscalls) are expected to never change and always
be available.
.. kernel-abi:: stable
+ :no-files:
diff --git a/Documentation/admin-guide/abi-testing-files.rst b/Documentation/admin-guide/abi-testing-files.rst
new file mode 100644
index 000000000000..1da868e42fdb
--- /dev/null
+++ b/Documentation/admin-guide/abi-testing-files.rst
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Testing ABI Files
+=================
+
+.. kernel-abi:: testing
+ :no-symbols:
diff --git a/Documentation/admin-guide/abi-testing.rst b/Documentation/admin-guide/abi-testing.rst
index 55054985a8ff..6153ebd38e2d 100644
--- a/Documentation/admin-guide/abi-testing.rst
+++ b/Documentation/admin-guide/abi-testing.rst
@@ -19,3 +19,4 @@ name to the description of these interfaces, so that the kernel
developers can easily notify them if any changes occur.
.. kernel-abi:: testing
+ :no-files:
diff --git a/Documentation/admin-guide/abi.rst b/Documentation/admin-guide/abi.rst
index 64e772bde943..15a2dcb1388c 100644
--- a/Documentation/admin-guide/abi.rst
+++ b/Documentation/admin-guide/abi.rst
@@ -4,6 +4,9 @@
Linux ABI description
=====================
+ABI symbols
+-----------
+
.. toctree::
:maxdepth: 2
@@ -11,3 +14,15 @@ Linux ABI description
abi-testing
abi-obsolete
abi-removed
+
+ABI files
+---------
+
+.. toctree::
+ :maxdepth: 2
+
+ abi-readme-file
+ abi-stable-files
+ abi-testing-files
+ abi-obsolete-files
+ abi-removed-files
--
2.48.1
next prev parent reply other threads:[~2025-02-10 10:18 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-10 10:17 [PATCH 00/27] Improve ABI documentation generation Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 01/27] docs: sphinx: remove kernellog.py file Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 02/27] docs: sphinx/kernel_abi: adjust coding style Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 03/27] docs: admin-guide: abi: add SPDX tags to ABI files Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 04/27] ABI: sysfs-class-rfkill: fix kernelversion tags Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 05/27] ABI: sysfs-bus-coresight-*: " Mauro Carvalho Chehab
2025-02-10 10:33 ` Suzuki K Poulose
2025-02-10 10:17 ` [PATCH 06/27] ABI: sysfs-driver-dma-idxd: fix date tags Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 07/27] ABI: sysfs-fs-f2fs: " Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 08/27] ABI: sysfs-power: fix a what tag Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 09/27] scripts/documentation-file-ref-check: don't check perl/python scripts Mauro Carvalho Chehab
2025-02-10 10:17 ` [PATCH 10/27] scripts/get_abi.py: add a Python tool to generate ReST output Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 11/27] scripts/get_abi.py: add support for symbol search Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 12/27] docs: use get_abi.py for ABI generation Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 13/27] scripts/lib/abi/abi_parser.py: optimize parse_abi() function Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 14/27] scripts/lib/abi/abi_parser.py: use an interactor for ReST output Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 15/27] docs: sphinx/kernel_abi: use AbiParser directly Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 16/27] docs: sphinx/kernel_abi: reduce buffer usage for ABI messages Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 17/27] docs: sphinx/kernel_abi: properly split lines Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 18/27] scripts/get_abi.pl: Add filtering capabilities to rest output Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 19/27] scripts/get_abi.pl: add support to parse ABI README file Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 20/27] docs: sphinx/kernel_abi: parse ABI files only once Mauro Carvalho Chehab
2025-02-10 10:18 ` Mauro Carvalho Chehab [this message]
2025-02-10 10:18 ` [PATCH 22/27] docs: sphinx/automarkup: add cross-references for ABI Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 23/27] docs: sphinx/kernel_abi: avoid warnings during Sphinx module init Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 24/27] scripts/lib/abi/abi_parser.py: Rename title name for ABI files Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 25/27] scripts/lib/abi/abi_parser.py: make it backward-compatible with Python 3.6 Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 26/27] scripts/get_abi.py: add support for undefined ABIs Mauro Carvalho Chehab
2025-02-10 10:18 ` [PATCH 27/27] scripts/get_abi.pl: drop now obsoleted script Mauro Carvalho Chehab
2025-02-10 18:30 ` [PATCH 00/27] Improve ABI documentation generation Jonathan Corbet
2025-02-10 20:27 ` Mauro Carvalho Chehab
2025-03-27 21:58 ` [f2fs-dev] " patchwork-bot+f2fs
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=30e3cf2a8aeef23ca889de60a90f7de141e0dc0e.1739182025.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@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
all inboxes | Powered by JetHome®