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

docs: media: dvb: enable warnings for most headers

Except for two exception rules and dmx.h, the other files
are already handling properly cross references.

Fix the two exception rules for frontend.h, as those are
false-positives:

include/uapi/linux/dvb/frontend.h:959: WARNING: can't link to: c:type:: FE_GET_PROPERTY
include/uapi/linux/dvb/frontend.h:933: WARNING: can't link to: c:func:: FE_SET_FRONTEND_TUNE_MODE

The dmx.h are actual issues that will require an extra
patch to fill gaps.

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

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
a7596822 f0eb1b4c

+6 -2
+3 -2
Documentation/userspace-api/media/dvb/frontend.h.rst.exceptions
··· 28 28 ignore define DTV_IOCTL_MAX_MSGS 29 29 30 30 # the same reference is used for both get and set ioctls 31 - replace ioctl FE_SET_PROPERTY :c:type:`FE_GET_PROPERTY` 31 + replace ioctl FE_SET_PROPERTY :ref:`FE_GET_PROPERTY` 32 + replace ioctl FE_GET_PROPERTY :ref:`FE_GET_PROPERTY` 32 33 33 34 # Typedefs that use the enum reference 34 35 replace typedef fe_sec_voltage_t :c:type:`fe_sec_voltage` 35 36 36 37 # Replaces for flag constants 37 - replace define FE_TUNE_MODE_ONESHOT :c:func:`FE_SET_FRONTEND_TUNE_MODE` 38 + replace define FE_TUNE_MODE_ONESHOT :ref:`FE_SET_FRONTEND_TUNE_MODE` 38 39 replace define LNA_AUTO dtv-lna 39 40 replace define NO_STREAM_ID_FILTER dtv-stream-id 40 41
+3
Documentation/userspace-api/media/dvb/headers.rst
··· 15 15 :generate-cross-refs: 16 16 :exception-file: frontend.h.rst.exceptions 17 17 :toc: 18 + :warn-broken: 18 19 19 20 Demux 20 21 ===== ··· 32 31 :generate-cross-refs: 33 32 :exception-file: ca.h.rst.exceptions 34 33 :toc: 34 + :warn-broken: 35 35 36 36 Network 37 37 ======= ··· 41 39 :generate-cross-refs: 42 40 :exception-file: net.h.rst.exceptions 43 41 :toc: 42 + :warn-broken: 44 43