workqueue: fix texinfodocs warning for WQ_* flags reference

[PATCH] workqueue: fix texinfodocs warning for WQ_* flags reference

Posted by Kriish Sharma 1 week, 2 days ago

Sphinx emitted a warning during make texinfodocs:

  WARNING: Inline literal start-string without end-string.

This was caused by the trailing '*' in "%WQ_*" being parsed as
reStructuredText markup in the kernel-doc comment.

Escape the '*' in the comment so that Sphinx treats it as a literal
character, resolving the warning.

Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
 include/linux/workqueue.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index 158784dd189a..60f0c7d30337 100644
--- a/include/linux/workqueue.h
+++ b/include/linux/workqueue.h
@@ -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:
-- 
2.34.1

Re: [PATCH] workqueue: fix texinfodocs warning for WQ_* flags reference

Posted by Tejun Heo 1 week, 2 days ago

On Mon, Sep 22, 2025 at 12:26:06PM +0000, Kriish Sharma wrote:
> Sphinx emitted a warning during make texinfodocs:
> 
>   WARNING: Inline literal start-string without end-string.
> 
> This was caused by the trailing '*' in "%WQ_*" being parsed as
> reStructuredText markup in the kernel-doc comment.
> 
> Escape the '*' in the comment so that Sphinx treats it as a literal
> character, resolving the warning.
> 
> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>

Applied to wq/for-6.18.

Thanks.

-- 
tejun