[PATCH 5/5] docs: userspace-api/api: include ABI/README.rst

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



The rendered ABI documents currently have no introduction or
explanation, which is a bit jarring.

Documentation/ABI/README is a pretty good introduction, even if it's
aimed more at ABI-description producers (rather than consumers) -- we
can always tweak the language to be clearer about this distinction
later.

Include it in userspace-api/api.rst.

Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>
Signed-off-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx>
---
 Documentation/userspace-api/abi.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/userspace-api/abi.rst b/Documentation/userspace-api/abi.rst
index bcab3ef2597c..ea615233a405 100644
--- a/Documentation/userspace-api/abi.rst
+++ b/Documentation/userspace-api/abi.rst
@@ -2,7 +2,10 @@
 Linux ABI description
 =====================
 
+.. include:: ../ABI/README.rst
+
 .. toctree::
+   :caption: Directory
    :maxdepth: 2
 
    abi-stable
-- 
2.34.1





[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux