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

docs: media: mediactl: use TOC instead of file contents

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 media controller and enable warnings.

Here, we need to adjust the exceptions file to setup the C
namespace accordingly.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <5c8a87be712397563fc8ca914c3d92fe675e4071.1759329363.git.mchehab+huawei@kernel.org>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
2792fc73 94d95887

+8 -3
+5 -3
Documentation/userspace-api/media/mediactl/media-header.rst
··· 2 2 3 3 .. _media_header: 4 4 5 - **************************** 6 - Media Controller Header File 7 - **************************** 5 + ***************************** 6 + Media controller uAPI symbols 7 + ***************************** 8 8 9 9 .. kernel-include:: include/uapi/linux/media.h 10 10 :generate-cross-refs: 11 11 :exception-file: media.h.rst.exceptions 12 + :toc: 13 + :warn-broken:
+3
Documentation/userspace-api/media/mediactl/media.h.rst.exceptions
··· 1 1 # SPDX-License-Identifier: GPL-2.0 2 2 3 + # All symbols are mapped inside MC C domain namespace 4 + namespace MC 5 + 3 6 # Ignore header name 4 7 ignore define __LINUX_MEDIA_H 5 8