2024-05-03 18:27:21

by Utkarsh Tripathi

[permalink] [raw]
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/[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(-)

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



2024-05-04 07:18:00

by Bagas Sanjaya

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

On Fri, May 03, 2024 at 11:56:50PM +0530, Utkarsh Tripathi wrote:
> 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+))*(\.\.\.)?)';
>

The warning gone away, thanks!

Tested-by: Bagas Sanjaya <[email protected]>

--
An old man doll... just what I always wanted! - Clara

Attachments:
(No filename) (779.00 B)
 signature.asc (235.00 B)
 Download all attachments

2024-05-07 14:25:16

by Jonathan Corbet

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

Utkarsh Tripathi <[email protected]> writes:

> 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.

I've applied this. I made a changelog tweak, in that this 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