linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Freedesktop DRI List <dri-devel@lists.freedesktop.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux KVM <kvm@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Cc: Oded Gabbay <ogabbay@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Paolo Bonzini <pbonzini@redhat.com>,
	Jeffrey Hugo <quic_jhugo@quicinc.com>,
	Ofir Bitton <obitton@habana.ai>,
	Sean Christopherson <seanjc@google.com>,
	Aaron Lewis <aaronlewis@google.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path
Date: Fri, 20 Jan 2023 19:35:32 +0700	[thread overview]
Message-ID: <20230120123534.137413-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20230120123534.137413-1-bagasdotme@gmail.com>

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@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.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


  reply	other threads:[~2023-01-20 12:36 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-20 12:35 [PATCH linux-next 0/3] Documentation fixes for linux-next (Jan 20) Bagas Sanjaya
2023-01-20 12:35 ` Bagas Sanjaya [this message]
2023-01-20 14:59   ` [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path Jeffrey Hugo
2023-01-22  9:35     ` Oded Gabbay
2023-01-20 12:35 ` [PATCH linux-next 2/3] habanalabs: Fix list of /sys/class/habanalabs/hl<n>/status Bagas Sanjaya
2023-01-22  9:37   ` Oded Gabbay
2023-01-20 12:35 ` [PATCH linux-next 3/3] kvm: x86/pmu: Add blank line separator before KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list Bagas Sanjaya
2023-01-20 18:04   ` Sean Christopherson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230120123534.137413-2-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=aaronlewis@google.com \
    --cc=corbet@lwn.net \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=kvm@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=obitton@habana.ai \
    --cc=ogabbay@kernel.org \
    --cc=pbonzini@redhat.com \
    --cc=quic_jhugo@quicinc.com \
    --cc=seanjc@google.com \
    --cc=sfr@canb.auug.org.au \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).