linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Power Management <linux-pm@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	Daniel Lezcano <daniel.lezcano@linaro.org>,
	Amit Kucheria <amitk@kernel.org>, Zhang Rui <rui.zhang@intel.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>,
	Thorsten Leemhuis <linux@leemhuis.info>,
	Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>,
	Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
	Arjan van de Ven <arjan@linux.intel.com>,
	Jacob Pan <jacob.jun.pan@linux.intel.com>,
	oe-kbuild-all@lists.linux.dev, kernel test robot <lkp@intel.com>
Subject: [PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description
Date: Mon, 13 Feb 2023 17:08:00 +0700	[thread overview]
Message-ID: <20230213100800.28333-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20230213100800.28333-1-bagasdotme@gmail.com>

kernel test robot reported htmldocs warning:

Documentation/admin-guide/thermal/intel_powerclamp.rst:328: WARNING: Inline emphasis start-string without end-string.

The mistaken asterisk in /proc/irq/*/smp_affinity is rendered as hyperlink
as the result.

Escape the asterisk to fix above warning.

Link: https://lore.kernel.org/linux-doc/202302122247.N4S791c4-lkp@intel.com/
Fixes: ebf51971021881 ("thermal: intel: powerclamp: Add two module parameters")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/thermal/intel_powerclamp.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/thermal/intel_powerclamp.rst b/Documentation/admin-guide/thermal/intel_powerclamp.rst
index 2d9d2d739f0256..f919fbe1cdd942 100644
--- a/Documentation/admin-guide/thermal/intel_powerclamp.rst
+++ b/Documentation/admin-guide/thermal/intel_powerclamp.rst
@@ -326,7 +326,7 @@ Module Parameters
 
 ``cpumask`` (RW)
 	A bit mask of CPUs to inject idle. The format of the bitmask is same as
-	used in other subsystems like in /proc/irq/*/smp_affinity. The mask is
+	used in other subsystems like in /proc/irq/\*/smp_affinity. The mask is
 	comma separated 32 bit groups. Each CPU is one bit. For example for a 256
 	CPU system the full mask is:
 	ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff,ffffffff
-- 
An old man doll... just what I always wanted! - Clara


  parent reply	other threads:[~2023-02-13 10:08 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-13 10:07 [PATCH 0/3] Documentation fixes for thermal/bleeding-edge Bagas Sanjaya
2023-02-13 10:07 ` [PATCH 1/3] Documentation: admin-guide: Add toctree entry for thermal docs Bagas Sanjaya
2023-02-13 10:15   ` srinivas pandruvada
2023-02-14  2:16     ` Bagas Sanjaya
2023-02-13 10:08 ` Bagas Sanjaya [this message]
2023-02-13 10:17   ` [PATCH 2/3] Documentation: powerclamp: Escape wildcard in cpumask description srinivas pandruvada
2023-02-14  2:16     ` Bagas Sanjaya
2023-02-13 10:08 ` [PATCH 3/3] Documentation: powerclamp: Fix numbered lists formatting Bagas Sanjaya
2023-02-13 10:18 ` [PATCH 0/3] Documentation fixes for thermal/bleeding-edge srinivas pandruvada
2023-02-13 15:34   ` Rafael J. Wysocki

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=20230213100800.28333-3-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=amitk@kernel.org \
    --cc=arjan@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=daniel.lezcano@linaro.org \
    --cc=jacob.jun.pan@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=linux@leemhuis.info \
    --cc=lkp@intel.com \
    --cc=mchehab+samsung@kernel.org \
    --cc=oe-kbuild-all@lists.linux.dev \
    --cc=rafael@kernel.org \
    --cc=rui.zhang@intel.com \
    --cc=srinivas.pandruvada@linux.intel.com \
    /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).