From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>
Cc: Tejun Heo <tj@kernel.org>, Lai Jiangshan <jiangshanlai@gmail.com>,
Frederic Weisbecker <frederic@kernel.org>,
Tetsuo Handa <penguin-kernel@I-love.SAKURA.ne.jp>,
Kent Overstreet <kent.overstreet@linux.dev>,
Naohiro Aota <Naohiro.Aota@wdc.com>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH] Documentation: workqueue: Inline WQ_* flag pattern
Date: Thu, 18 Apr 2024 14:21:01 +0700 [thread overview]
Message-ID: <20240418072100.30670-2-bagasdotme@gmail.com> (raw)
Sphinx reports htmldocs warning:
Documentation/core-api/workqueue:776: ./include/linux/workqueue.h:493: WARNING: Inline literal start-string without end-string.
The warning is caused by unescaped wildcard in the pattern that matches
all workqueue flags (WQ_*). The pattern is rendered as normal text
(with surrounding double backticks due to @argument syntax usage)
instead of inline text like in individual flag names as a result.
Inline the pattern to fix the warning.
Fixes: 5797b1c18919 ("workqueue: Implement system-wide nr_active enforcement for unbound workqueues")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
include/linux/workqueue.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index 158784dd189ab2..c9fec74e130459 100644
--- a/include/linux/workqueue.h
+++ b/include/linux/workqueue.h
@@ -463,7 +463,7 @@ void workqueue_softirq_dead(unsigned int cpu);
/**
* alloc_workqueue - allocate a workqueue
* @fmt: printf format for the name of the workqueue
- * @flags: WQ_* flags
+ * @flags: ``WQ_*`` flags
* @max_active: max in-flight work items, 0 for default
* remaining args: args for @fmt
*
@@ -490,7 +490,7 @@ void workqueue_softirq_dead(unsigned int cpu);
* min_active which is set to min(@max_active, %WQ_DFL_MIN_ACTIVE). This means
* that the sum of per-node max_active's may be larger than @max_active.
*
- * For detailed information on %WQ_* flags, please refer to
+ * For detailed information on ``WQ_*`` flags, please refer to
* Documentation/core-api/workqueue.rst.
*
* RETURNS:
base-commit: a1d34930d1b3782307ef5d0636f4f6a9ac5028e5
--
An old man doll... just what I always wanted! - Clara
next reply other threads:[~2024-04-18 7:21 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-18 7:21 Bagas Sanjaya [this message]
2024-04-18 8:23 ` [PATCH] Documentation: workqueue: Inline WQ_* flag pattern Akira Yokosawa
2024-04-18 13:11 ` Bagas Sanjaya
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=20240418072100.30670-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=Naohiro.Aota@wdc.com \
--cc=frederic@kernel.org \
--cc=jiangshanlai@gmail.com \
--cc=kent.overstreet@linux.dev \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=penguin-kernel@I-love.SAKURA.ne.jp \
--cc=tj@kernel.org \
/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).