linux-kernel - Re: [PATCH] Sphinx error fixed for inline literal end-string in include/linux/workqueue.h

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: <b9e4bedb-6678-42ed-9ac1-c10179be5b69@gmail.com>
Date: Thu, 2 May 2024 00:05:36 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: utripathi2002@...il.com
Cc: jiangshanlai@...il.com, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, skhan@...uxfoundation.org, tj@...nel.org,
 Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH] Sphinx error fixed for inline literal end-string in
 include/linux/workqueue.h

Hello,

On Wed,  1 May 2024 19:02:40 +0530, Utkarsh Tripathi wrote:
> Fixed Error in Workqueue Documentation in the kernel-doc comment 
> for alloc_workqueue function in include/linux/workqueue.h, 
> the error was "Inline literal start-string without end-string" 
> which was fixed by removing the inline literal.
> Kernel Version - 6.9.0-rc5
> 
> Signed-off-by: Utkarsh Tripathi <utripathi2002@...il.com>

There was a slightly different patch submission on the same issue the
other day.  You might be interested in seeing my response to it [1].

[1]: https://lore.kernel.org/r/6875fb17-f781-4594-803a-c11969f36022@gmail.com/

Quoting below for your convenience:

> In my opinion, reST-specific clutters like these should be avoided in
> kernel-doc comments as far as possible.
> 
> Instead, I think you can educate kernel-doc (script) so that "*" is
> allowed in the %CONSTANT pattern, meaning %WQ_* can be converted
> to ``WQ_*`` in reST.
> 
> For similar changes made against the @param pattern, see commits
> 69fc23efc7e5 ("kernel-doc: Add unary operator * to $type_param_ref")
> and 8aaf297a0dd6 ("docs: scripts: kernel-doc: accept bitwise negation
> like ~@var").
> 
> I guess it is $type_constant2 that needs a tweak in this case.

Unfortunately, there's been no patch submission in this direction so far.
I'd be delighted if you can try this approach instead.

Thanks, Akira