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

Documentation: accel: escape wildcard in special file path

Stephen Rothwell reported htmldocs warning then merging accel tree:

Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string.

Sphinx confuses the file wildcards with inline emphasis (italics), hence
the warning.

Fix the warning by escaping wildcards.

Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
Signed-off-by: Oded Gabbay <ogabbay@kernel.org>

authored by

Bagas Sanjaya and committed by
Oded Gabbay
183ebe03 24444a99

+3 -3
+3 -3
Documentation/accel/introduction.rst
··· 67 67 The accelerator devices will be exposed to the user space with the dedicated 68 68 261 major number and will have the following convention: 69 69 70 - - device char files - /dev/accel/accel* 71 - - sysfs - /sys/class/accel/accel*/ 72 - - debugfs - /sys/kernel/debug/accel/*/ 70 + - device char files - /dev/accel/accel\* 71 + - sysfs - /sys/class/accel/accel\*/ 72 + - debugfs - /sys/kernel/debug/accel/\*/ 73 73 74 74 Getting Started 75 75 ===============