summaryrefslogtreecommitdiffstats
path: root/Documentation/admin-guide/abi-testing.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-10-30 08:40:36 +0100
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2020-10-30 13:07:01 +0100
commita7ee04b3ef0d2b2514730928a04a112f04ffe7df (patch)
treea35f0f7f8fa1027d6bb847a75c5c2311b38178f7 /Documentation/admin-guide/abi-testing.rst
parentdocs: kernel_abi.py: Handle with a lazy Sphinx parser (diff)
downloadlinux-a7ee04b3ef0d2b2514730928a04a112f04ffe7df.tar.xz
linux-a7ee04b3ef0d2b2514730928a04a112f04ffe7df.zip
docs: add ABI documentation to the admin-guide book
As we don't want a generic Sphinx extension to execute commands, change the one proposed to Markus to call the abi_book.pl script. Use a script to parse the Documentation/ABI directory and output it at the admin-guide. Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/5651482b06500e69a1acdf92152f90a203e6521d.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/admin-guide/abi-testing.rst')
-rw-r--r--Documentation/admin-guide/abi-testing.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/admin-guide/abi-testing.rst b/Documentation/admin-guide/abi-testing.rst
new file mode 100644
index 000000000000..5c886fc50b9e
--- /dev/null
+++ b/Documentation/admin-guide/abi-testing.rst
@@ -0,0 +1,19 @@
+ABI testing symbols
+===================
+
+Documents interfaces that are felt to be stable,
+as the main development of this interface has been completed.
+
+The interface can be changed to add new features, but the
+current interface will not break by doing this, unless grave
+errors or security problems are found in them.
+
+Userspace programs can start to rely on these interfaces, but they must
+be aware of changes that can occur before these interfaces move to
+be marked stable.
+
+Programs that use these interfaces are strongly encouraged to add their
+name to the description of these interfaces, so that the kernel
+developers can easily notify them if any changes occur.
+
+.. kernel-abi:: $srctree/Documentation/ABI/testing