archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-08 03:44:45 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
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>
This commit is contained in:
Mauro Carvalho Chehab 2025-10-01 16:49:35 +02:00 • committed by Jonathan Corbet
parent 94d95887ea
commit 2792fc7307
2 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Documentation/userspace-api/media/mediactl/media-header.rst
View file

@ -2,10 +2,12 @@
.. _media_header:
****************************
Media Controller Header File
****************************
*****************************
Media controller uAPI symbols
*****************************
.. kernel-include:: include/uapi/linux/media.h
:generate-cross-refs:
:exception-file: media.h.rst.exceptions
:toc:
:warn-broken:

3
Documentation/userspace-api/media/mediactl/media.h.rst.exceptions
View file

@ -1,5 +1,8 @@
# SPDX-License-Identifier: GPL-2.0
# All symbols are mapped inside MC C domain namespace
namespace MC
# Ignore header name
ignore define __LINUX_MEDIA_H