]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
docs: admin-guide/abi: split files from symbols
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 10 Feb 2025 10:18:10 +0000 (11:18 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 10 Feb 2025 18:19:57 +0000 (11:19 -0700)
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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/30e3cf2a8aeef23ca889de60a90f7de141e0dc0e.1739182025.git.mchehab+huawei@kernel.org
Documentation/admin-guide/abi-obsolete-files.rst [new file with mode: 0644]
Documentation/admin-guide/abi-obsolete.rst
Documentation/admin-guide/abi-readme-file.rst [new file with mode: 0644]
Documentation/admin-guide/abi-removed-files.rst [new file with mode: 0644]
Documentation/admin-guide/abi-removed.rst
Documentation/admin-guide/abi-stable-files.rst [new file with mode: 0644]
Documentation/admin-guide/abi-stable.rst
Documentation/admin-guide/abi-testing-files.rst [new file with mode: 0644]
Documentation/admin-guide/abi-testing.rst
Documentation/admin-guide/abi.rst

diff --git a/Documentation/admin-guide/abi-obsolete-files.rst b/Documentation/admin-guide/abi-obsolete-files.rst
new file mode 100644 (file)
index 0000000..3061a91
--- /dev/null
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Obsolete ABI Files
+==================
+
+.. kernel-abi:: obsolete
+   :no-symbols:
index bdef91d2cea4ad6ab4b2c8b40609412f20751a08..640f3903e84703c62153a0053e4b4ecbac48e48c 100644 (file)
@@ -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 (file)
index 0000000..6172e4c
--- /dev/null
@@ -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 (file)
index 0000000..f1bdfad
--- /dev/null
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Removed ABI Files
+=================
+
+.. kernel-abi:: removed
+   :no-symbols:
index bea0608b844285a0dcfeebaed05c625e992d2842..88832d3eacd6edcfb0293e381ee442c6fe6f03c4 100644 (file)
@@ -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 (file)
index 0000000..f867738
--- /dev/null
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Stable ABI Files
+================
+
+.. kernel-abi:: stable
+   :no-symbols:
index 33637c0d4fd50cacdd6fc91ef079ab373be1c948..528c68401f4b974c79fc1d71e4bca16c12722c0a 100644 (file)
@@ -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 (file)
index 0000000..1da868e
--- /dev/null
@@ -0,0 +1,7 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Testing ABI Files
+=================
+
+.. kernel-abi:: testing
+   :no-symbols:
index 55054985a8ffb6e063e008b0a203ceb777a0cfe7..6153ebd38e2d0b34c4ca977f795f49633d2796cf 100644 (file)
@@ -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:
index 64e772bde943dbae8458da779cea82e8b9f8cbf7..15a2dcb1388ca2f6bf6fdf080d0cdc12816df418 100644 (file)
@@ -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