Skip to contentSkip to conversation

kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.

PATCH In review Utkarsh Tripathi 3 participants 3 messages May 3, 2024 – May 7, 2024 Documentation

lore
Share & tools
lore

Utkarsh Tripathi

author
#0 lore raw

PATCH v3 1/1 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.

Quoted 2 lines

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/[email protected]

Signed-off-by Utkarsh Tripathi <[email protected]>
Suggested-by Akira Yokosawa <[email protected]>
Reviewed-by Akira Yokosawa <[email protected]>

---
v2->v3: Updated the changelog of patch.

 scripts/kernel-doc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/kernel-doc +1 -1
index cb1be22afc65..58129b1cf3f4 100755
@@ -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

Signature · 1 line
2.34.1
Tested-by on v3 1/1
#1 lore raw
Quoted 6 lines · Utkarsh Tripathi
scripts/kernel-doc +0 -0
index cb1be22afc65..58129b1cf3f4 100755

scripts/kernel-doc my $anon_struct_union = 0; · line 68

Quoted 8 lines
scripts/kernel-doc +1 -1
@@ -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+))*(\.\.\.)?)';

The warning gone away, thanks!

Tested-by Bagas Sanjaya <[email protected]>
Signature · 1 line
An old man doll... just what I always wanted! - Clara
maintainer
#2 lore raw
In reply to Utkarsh Tripathi
Quoted 11 lines · Utkarsh Tripathi

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.

Quoted 2 lines

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

I've applied this. I made a changelog tweak, in that this line:

Quoted 1 line

v1 and v2 discussions: https://lore.kernel.org/linux-doc/[email protected]

...should really just be a Link: tag rather than something special.

Thanks,

jon