Commit a7ee04b3 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

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: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5651482b06500e69a1acdf92152f90a203e6521d.1604042072.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 3c543d29

Documentation/admin-guide/abi-obsolete.rst

0 → 100644
+10 −0
Original line number Diff line number Diff line 
ABI obsolete symbols

====================



Documents interfaces that are still remaining in the kernel, but are

marked to be removed at some later point in time.



The description of the interface will document the reason why it is

obsolete and when it can be expected to be removed.



.. kernel-abi:: $srctree/Documentation/ABI/obsolete

Documentation/admin-guide/abi-removed.rst

0 → 100644
+4 −0
Original line number Diff line number Diff line 
ABI removed symbols

===================



.. kernel-abi:: $srctree/Documentation/ABI/removed

Documentation/admin-guide/abi-stable.rst

0 → 100644
+13 −0
Original line number Diff line number Diff line 
ABI stable symbols

==================



Documents the interfaces that the developer has defined to be stable.



Userspace programs are free to use these interfaces with no

restrictions, and backward compatibility for them will be guaranteed

for at least 2 years.



Most interfaces (like syscalls) are expected to never change and always

be available.



.. kernel-abi:: $srctree/Documentation/ABI/stable

Documentation/admin-guide/abi-testing.rst

0 → 100644
+19 −0
Original line number Diff line number Diff line 
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

Documentation/admin-guide/abi.rst

0 → 100644
+11 −0
Original line number Diff line number Diff line 
=====================

Linux ABI description

=====================



.. toctree::

   :maxdepth: 1



   abi-stable

   abi-testing

   abi-obsolete

   abi-removed

CRA Git | Maintained and supported by SUSTech CRA and CCSE