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

docs: media: rc: use TOC instead of file contents for LIRC header

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

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

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
94d95887 a7596822

+11 -3
+11 -3
Documentation/userspace-api/media/rc/lirc-header.rst
··· 2 2 3 3 .. _lirc_header: 4 4 5 - **************** 6 - LIRC Header File 7 - **************** 5 + ***************** 6 + LIRC uAPI symbols 7 + ***************** 8 + 9 + .. contents:: Table of Contents 10 + :depth: 2 11 + :local: 12 + 13 + 8 14 9 15 .. kernel-include:: include/uapi/linux/lirc.h 10 16 :generate-cross-refs: 11 17 :exception-file: lirc.h.rst.exceptions 18 + :toc: 19 + :warn-broken: 12 20