linux-kernel - Re: [PATCH v2] Sphinx error fixed for inline literal end-string by changing $type_constant2 in kernel-doc script to include "*" unicode character in highlights

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]

Date: Thu, 2 May 2024 19:39:48 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Utkarsh Tripathi <utripathi2002@...il.com>, corbet@....net
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 skhan@...uxfoundation.org, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v2] Sphinx error fixed for inline literal end-string by
 changing $type_constant2 in kernel-doc script to include "*" unicode
 character in highlights_rst.

Hi Utkarsh,

First of all, thank you for taking the time!

Besides Jon's comments on the summary and changelog, please find my
suggestion below.

On Wed,  1 May 2024 23:27:30 +0530, Utkarsh Tripathi wrote:
> The kernel-doc script uses the $type_constant2 variable to match
> expressions used to find embedded type information. The current
> implementation of $type_constant2 does not include the "*" unicode
> character, which is used to highlight inline literals in the
> documentation. This causes a Sphinx error when the inline literal
> end-string is used in the documentation.

I'm afraid your description of what is wrong is not clear enough ...
Let me talk using some examples.

Current kernel-doc (script) conversion to reST:

    %WQ_* -->  ``WQ_``*

Against which Sphinx complains:

    WARNING: Inline literal start-string without end-string.

, because ``* is not recognized as end-string (of inline literal).

With your change applied, conversion to reST becomes:

    %WQ_* --> ``WQ_*``

, and it is a proper inline literal.

Please update the changelog accordingly.

This is not urgent at all.  Please take your time and read through
Documentation/process/submitting-patches.rst (among others) before
submitting v3.

Feel free to add (in v3):

Reviewed-by: Akira Yokosawa <akiyks@...il.com>

    Thanks, Akira