diff options
author | Bagas Sanjaya <bagasdotme@gmail.com> | 2023-01-20 19:35:32 +0700 |
---|---|---|
committer | Oded Gabbay <ogabbay@kernel.org> | 2023-01-26 11:52:14 +0200 |
commit | 183ebe0355530835a046f8360aea67528e11ed5d (patch) | |
tree | 6a02a1c842f61d6721bbabcb9548f20ff9498676 | |
parent | 24444a99331af2b51b46f55c06d02ab6e7cb29b4 (diff) |
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>
-rw-r--r-- | Documentation/accel/introduction.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst index 11cade51f387..89984dfececf 100644 --- a/Documentation/accel/introduction.rst +++ b/Documentation/accel/introduction.rst @@ -67,9 +67,9 @@ tree - drivers/accel/. The accelerator devices will be exposed to the user space with the dedicated 261 major number and will have the following convention: -- device char files - /dev/accel/accel* -- sysfs - /sys/class/accel/accel*/ -- debugfs - /sys/kernel/debug/accel/*/ +- device char files - /dev/accel/accel\* +- sysfs - /sys/class/accel/accel\*/ +- debugfs - /sys/kernel/debug/accel/\*/ Getting Started =============== |