diff options
| author |   Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-10-30 08:40:36 +0100 |
|---|---|---|
| committer |   Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2020-10-30 13:07:01 +0100 |
| commit | a7ee04b3ef0d2b2514730928a04a112f04ffe7df (patch) | |
| tree | a35f0f7f8fa1027d6bb847a75c5c2311b38178f7 /Documentation/admin-guide/abi-stable.rst | |
| parent | docs: kernel_abi.py: Handle with a lazy Sphinx parser (diff) | |
| download | wireguard-linux-a7ee04b3ef0d2b2514730928a04a112f04ffe7df.tar.xz wireguard-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-stable.rst')
| -rw-r--r-- | Documentation/admin-guide/abi-stable.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/admin-guide/abi-stable.rst b/Documentation/admin-guide/abi-stable.rst new file mode 100644 index 000000000000..7495d7a35048 --- /dev/null +++ b/Documentation/admin-guide/abi-stable.rst @@ -0,0 +1,13 @@ +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 |