linux-kernel - Re: [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-prev] [day] [month] [year] [list]

Message-ID: <87v83pg0pz.fsf@meer.lwn.net>
Date: Tue, 07 May 2024 08:23:20 -0600
From: Jonathan Corbet <corbet@....net>
To: Utkarsh Tripathi <utripathi2002@...il.com>, akiyks@...il.com
Cc: Utkarsh Tripathi <utripathi2002@...il.com>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, skhan@...uxfoundation.org
Subject: Re: [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix
 'make htmldocs' warning.

Utkarsh Tripathi <utripathi2002@...il.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