Received-SPF: pass (google.com: domain of linux-kernel+bounces-150139-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Message-ID: <6ee54e25-a9a6-4cb2-a2cc-92570ab7ace5@gmail.com>
Date: Thu, 18 Apr 2024 20:11:35 +0700
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH] Documentation: workqueue: Inline WQ_* flag pattern
To: Akira Yokosawa <akiyks@gmail.com>
Cc: Naohiro.Aota@wdc.com, frederic@kernel.org, jiangshanlai@gmail.com,
 kent.overstreet@linux.dev, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, penguin-kernel@I-love.SAKURA.ne.jp,
 tj@kernel.org, Jonathan Corbet <corbet@lwn.net>
References: <20240418072100.30670-2-bagasdotme@gmail.com>
 <6875fb17-f781-4594-803a-c11969f36022@gmail.com>
Content-Language: en-US
From: Bagas Sanjaya <bagasdotme@gmail.com>
In-Reply-To: <6875fb17-f781-4594-803a-c11969f36022@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

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