summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2025-10-01 17:49:32 +0300
committerJonathan Corbet <corbet@lwn.net>2025-10-17 22:56:59 +0300
commitf0eb1b4ce75f00e2711fc369cbbcc66d4e90b488 (patch)
tree08d849a8cdeea1b495508545ed1147ec9e87562e
parentd2a72e1f27c16d23938b26a78d7e1644b06bb5aa (diff)
downloadlinux-f0eb1b4ce75f00e2711fc369cbbcc66d4e90b488.tar.xz
docs: media: dvb: use TOC instead of file contents at headers
All we wanted were to have a way to link the comprehensive documentation with the actual symbols parsed from the header file, as this helps to identify any broken references. Use the new :toc: flag for DVB. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <dbe95d83ae2117ed532fda423fd1c1d9906b7a19.1759329363.git.mchehab+huawei@kernel.org>
-rw-r--r--Documentation/userspace-api/media/dvb/headers.rst27
1 files changed, 22 insertions, 5 deletions
diff --git a/Documentation/userspace-api/media/dvb/headers.rst b/Documentation/userspace-api/media/dvb/headers.rst
index c75f64cf21d5..e78122944a69 100644
--- a/Documentation/userspace-api/media/dvb/headers.rst
+++ b/Documentation/userspace-api/media/dvb/headers.rst
@@ -1,25 +1,42 @@
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
-****************************
-Digital TV uAPI header files
-****************************
-
-Digital TV uAPI headers
***********************
+Digital TV uAPI symbols
+***********************
+
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
+
+Frontend
+========
.. kernel-include:: include/uapi/linux/dvb/frontend.h
:generate-cross-refs:
:exception-file: frontend.h.rst.exceptions
+ :toc:
+
+Demux
+=====
.. kernel-include:: include/uapi/linux/dvb/dmx.h
:generate-cross-refs:
:exception-file: dmx.h.rst.exceptions
+ :toc:
+
+Conditional Access
+==================
.. kernel-include:: include/uapi/linux/dvb/ca.h
:generate-cross-refs:
:exception-file: ca.h.rst.exceptions
+ :toc:
+
+Network
+=======
.. kernel-include:: include/uapi/linux/dvb/net.h
:generate-cross-refs:
:exception-file: net.h.rst.exceptions
+ :toc: