linux-kernel - [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240503182650.7761-1-utripathi2002@gmail.com>
Date: Fri,  3 May 2024 23:56:50 +0530
From: Utkarsh Tripathi <utripathi2002@...il.com>
To: corbet@....net,
	akiyks@...il.com
Cc: Utkarsh Tripathi <utripathi2002@...il.com>,
	linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	skhan@...uxfoundation.org
Subject: [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.

Fixed: WARNING: Inline literal start-string without end-string in 
Documentation/core-api/workqueue.rst

Added "*" in $type_constants2 in kernel-doc script to include "*" in the
conversion to hightlights.
Previously: %WQ_* -->  ``WQ_``*
After Changes: %WQ_* -->  ``WQ_*``
Need for the fix: ``* is not recognized as a valid end-string for inline literal.

> The kernel-doc script uses the $type_constant2 variable to match
> expressions used to find embedded type information.

v1 and v2 discussions: https://lore.kernel.org/linux-doc/640114d2-5780-48c3-a294-c0eba230f984@gmail.com
Signed-off-by: Utkarsh Tripathi <utripathi2002@...il.com>
Suggested-by: Akira Yokosawa <akiyks@...il.com>
Reviewed-by: Akira Yokosawa <akiyks@...il.com>
---
v2->v3:  Updated the changelog of patch.

 scripts/kernel-doc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index cb1be22afc65..58129b1cf3f4 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -62,7 +62,7 @@ my $anon_struct_union = 0;
 
 # match expressions used to find embedded type information
 my $type_constant = '\b``([^\`]+)``\b';
-my $type_constant2 = '\%([-_\w]+)';
+my $type_constant2 = '\%([-_*\w]+)';
 my $type_func = '(\w+)\(\)';
 my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
 my $type_param_ref = '([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';

base-commit: 4d2008430ce87061c9cefd4f83daf2d5bb323a96
-- 
2.34.1