]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
workqueue: fix texinfodocs warning for WQ_* flags reference
authorKriish Sharma <kriish.sharma2006@gmail.com>
Mon, 22 Sep 2025 12:26:06 +0000 (12:26 +0000)
committerTejun Heo <tj@kernel.org>
Mon, 22 Sep 2025 15:37:20 +0000 (05:37 -1000)
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>
Signed-off-by: Tejun Heo <tj@kernel.org>
include/linux/workqueue.h

index 71a9900c03c706070d44b35bd7f45aead4b37d75..dabc351cc127d4d4a074b01581618a565a3c4864 100644 (file)
@@ -502,7 +502,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: