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] [thread-next>] [day] [month] [year] [list]

Message-ID: <87r0elbbsz.fsf@meer.lwn.net>
Date: Wed, 01 May 2024 12:57:00 -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 v2] Sphinx error fixed for inline literal end-string by
 changing $type_constant2 in kernel-doc script to include "*" unicode
 character in highlights_rst.

Utkarsh Tripathi <utripathi2002@...il.com> writes:

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

So I need to look a bit further at the actual change, but I do have a
couple of comments on the patch itself.  First, the text above is a
reasonable description of the problem, as a changelog should have.  That
said, the subject line could be a bit shorter and to the point.

This text below:

> This commit follows the pattern of the commit
> 8aaf297a0dd6 ("docs: scripts: kernel-doc: accept bitwise negation like ~@var")
> and takes inspiration from the following commit
> 69fc23efc7e5 ("kernel-doc: Add unary operator * to $type_param_ref").
>
> Thanks Akira, for your suggestions, I have made the required changes.
> I am fairly new to the kernel community, so if I am making 
> any mistakes while making patches and replying to mails,
> please let me know, it will be very helpful.

..doesn't belong in the changelog.  If you put comments like this below
the "---" line, then the maintainer won't have to edit them out when
applying the patch.

> Signed-off-by: Utkarsh Tripathi <utripathi2002@...il.com>
> Reviewed-by: Akira Yokosawa <akiyks@...il.com>
> Suggested-by: Akira Yokosawa <akiyks@...il.com>

Did Akira offer you that Reviewed-by tag?  I haven't seen it (which
doesn't mean it didn't happen).  If it was not explicitly given to you,
though, you cannot put it here.

Thanks,

jon