The ABI documentation looks a little bit better if it starts
with the contents of the README is placed at the beginning.
Suggested-by: Jonathan Corbet <corbet@xxxxxxx>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
---
Documentation/ABI/README | 3 ++-
Documentation/admin-guide/abi-readme-file.rst | 6 ------
Documentation/admin-guide/abi.rst | 3 ++-
3 files changed, 4 insertions(+), 8 deletions(-)
delete mode 100644 Documentation/admin-guide/abi-readme-file.rst
diff --git a/Documentation/ABI/README b/Documentation/ABI/README
index 8bac9cb09a6d..ef0e6d11e919 100644
--- a/Documentation/ABI/README
+++ b/Documentation/ABI/README
@@ -1,4 +1,5 @@
-This directory attempts to document the ABI between the Linux kernel and
+This part of the documentation inside Documentation/ABI directory
+attempts to document the ABI between the Linux kernel and
userspace, and the relative stability of these interfaces. Due to the
everchanging nature of Linux, and the differing maturity levels, these
interfaces should be used by userspace programs in different ways.
diff --git a/Documentation/admin-guide/abi-readme-file.rst b/Documentation/admin-guide/abi-readme-file.rst
deleted file mode 100644
index 6172e4ccbda2..000000000000
--- a/Documentation/admin-guide/abi-readme-file.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. SPDX-License-Identifier: GPL-2.0
-
-ABI README
-==========
-
-.. kernel-abi:: README
diff --git a/Documentation/admin-guide/abi.rst b/Documentation/admin-guide/abi.rst
index 15a2dcb1388c..c6039359e585 100644
--- a/Documentation/admin-guide/abi.rst
+++ b/Documentation/admin-guide/abi.rst
@@ -4,6 +4,8 @@
Linux ABI description
=====================
+.. kernel-abi:: README
+
ABI symbols
-----------
@@ -21,7 +23,6 @@ ABI files
.. toctree::
:maxdepth: 2
- abi-readme-file
abi-stable-files
abi-testing-files
abi-obsolete-files
--
2.48.1
