Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

workqueue: fix texinfodocs warning for WQ_* flags reference

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>

authored by

Kriish Sharma and committed by
Tejun Heo
0950c64a dadb3ebc

+1 -1
+1 -1
include/linux/workqueue.h
··· 502 502 * min_active which is set to min(@max_active, %WQ_DFL_MIN_ACTIVE). This means 503 503 * that the sum of per-node max_active's may be larger than @max_active. 504 504 * 505 - * For detailed information on %WQ_* flags, please refer to 505 + * For detailed information on %WQ_\* flags, please refer to 506 506 * Documentation/core-api/workqueue.rst. 507 507 * 508 508 * RETURNS: