Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
f0eb1b4c d2a72e1f

+22 -5
+22 -5
Documentation/userspace-api/media/dvb/headers.rst
··· 1 1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later 2 2 3 - **************************** 4 - Digital TV uAPI header files 5 - **************************** 6 - 7 - Digital TV uAPI headers 8 3 *********************** 4 + Digital TV uAPI symbols 5 + *********************** 6 + 7 + .. contents:: Table of Contents 8 + :depth: 2 9 + :local: 10 + 11 + Frontend 12 + ======== 9 13 10 14 .. kernel-include:: include/uapi/linux/dvb/frontend.h 11 15 :generate-cross-refs: 12 16 :exception-file: frontend.h.rst.exceptions 17 + :toc: 18 + 19 + Demux 20 + ===== 13 21 14 22 .. kernel-include:: include/uapi/linux/dvb/dmx.h 15 23 :generate-cross-refs: 16 24 :exception-file: dmx.h.rst.exceptions 25 + :toc: 26 + 27 + Conditional Access 28 + ================== 17 29 18 30 .. kernel-include:: include/uapi/linux/dvb/ca.h 19 31 :generate-cross-refs: 20 32 :exception-file: ca.h.rst.exceptions 33 + :toc: 34 + 35 + Network 36 + ======= 21 37 22 38 .. kernel-include:: include/uapi/linux/dvb/net.h 23 39 :generate-cross-refs: 24 40 :exception-file: net.h.rst.exceptions 41 + :toc: 25 42