linux-kernel - [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 20 Jan 2023 19:35:32 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Freedesktop DRI List <dri-devel@...ts.freedesktop.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Documentation <linux-doc@...r.kernel.org>,
        Linux KVM <kvm@...r.kernel.org>,
        Linux Next Mailing List <linux-next@...r.kernel.org>
Cc:     Oded Gabbay <ogabbay@...nel.org>, Jonathan Corbet <corbet@....net>,
        Paolo Bonzini <pbonzini@...hat.com>,
        Jeffrey Hugo <quic_jhugo@...cinc.com>,
        Ofir Bitton <obitton@...ana.ai>,
        Sean Christopherson <seanjc@...gle.com>,
        Aaron Lewis <aaronlewis@...gle.com>,
        Bagas Sanjaya <bagasdotme@...il.com>,
        Stephen Rothwell <sfr@...b.auug.org.au>
Subject: [PATCH linux-next 1/3] 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/
Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path")
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/accel/introduction.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
index 11cade51f387a6..89984dfececf0b 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
 ===============
-- 
An old man doll... just what I always wanted! - Clara