* [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.
@ 2024-05-03 18:26 Utkarsh Tripathi
2024-05-04 7:17 ` Bagas Sanjaya
2024-05-07 14:23 ` Jonathan Corbet
0 siblings, 2 replies; 3+ messages in thread
From: Utkarsh Tripathi @ 2024-05-03 18:26 UTC (permalink / raw
To: corbet, akiyks; +Cc: Utkarsh Tripathi, linux-doc, linux-kernel, skhan
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@gmail.com>
Suggested-by: Akira Yokosawa <akiyks@gmail.com>
Reviewed-by: Akira Yokosawa <akiyks@gmail.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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.
2024-05-03 18:26 [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning Utkarsh Tripathi
@ 2024-05-04 7:17 ` Bagas Sanjaya
2024-05-07 14:23 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2024-05-04 7:17 UTC (permalink / raw
To: Utkarsh Tripathi, corbet, akiyks; +Cc: linux-doc, linux-kernel, skhan
[-- Attachment #1: Type: text/plain, Size: 779 bytes --]
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 <bagasdotme@gmail.com>
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.
2024-05-03 18:26 [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning Utkarsh Tripathi
2024-05-04 7:17 ` Bagas Sanjaya
@ 2024-05-07 14:23 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2024-05-07 14:23 UTC (permalink / raw
To: Utkarsh Tripathi, akiyks; +Cc: Utkarsh Tripathi, linux-doc, linux-kernel, skhan
Utkarsh Tripathi <utripathi2002@gmail.com> 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/640114d2-5780-48c3-a294-c0eba230f984@gmail.com
...should really just be a Link: tag rather than something special.
Thanks,
jon
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-05-07 14:23 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-05-03 18:26 [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning Utkarsh Tripathi
2024-05-04 7:17 ` Bagas Sanjaya
2024-05-07 14:23 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).