linux-kernel - Re: [PATCH] Documentation: workqueue: Inline WQ

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: <6ee54e25-a9a6-4cb2-a2cc-92570ab7ace5@gmail.com>
Date: Thu, 18 Apr 2024 20:11:35 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Akira Yokosawa <akiyks@...il.com>
Cc: Naohiro.Aota@....com, frederic@...nel.org, jiangshanlai@...il.com,
 kent.overstreet@...ux.dev, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, penguin-kernel@...ove.SAKURA.ne.jp,
 tj@...nel.org, Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] Documentation: workqueue: Inline WQ_* flag pattern

On 4/18/24 15:23, Akira Yokosawa wrote:
> [+Cc: Jon]
> 
> On Thu, 18 Apr 2024 14:21:01 +0700, Bagas Sanjaya wrote:
>> - * For detailed information on %WQ_* flags, please refer to
>> + * For detailed information on ``WQ_*`` flags, please refer to
>>   * Documentation/core-api/workqueue.rst.
>>   *
>>   * RETURNS:
> 
> 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").
> 

Thanks for the idea!

-- 
An old man doll... just what I always wanted! - Clara