From: Bagas Sanjaya <bagasdotme@gmail.com>
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>
Subject: Re: [PATCH] Documentation: workqueue: Inline WQ_* flag pattern
Date: Thu, 18 Apr 2024 20:11:35 +0700 [thread overview]
Message-ID: <6ee54e25-a9a6-4cb2-a2cc-92570ab7ace5@gmail.com> (raw)
In-Reply-To: <6875fb17-f781-4594-803a-c11969f36022@gmail.com>
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
prev parent reply other threads:[~2024-04-18 13:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-18 7:21 [PATCH] Documentation: workqueue: Inline WQ_* flag pattern Bagas Sanjaya
2024-04-18 8:23 ` Akira Yokosawa
2024-04-18 13:11 ` Bagas Sanjaya [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6ee54e25-a9a6-4cb2-a2cc-92570ab7ace5@gmail.com \
--to=bagasdotme@gmail.com \
--cc=Naohiro.Aota@wdc.com \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=frederic@kernel.org \
--cc=jiangshanlai@gmail.com \
--cc=kent.overstreet@linux.dev \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=penguin-kernel@I-love.SAKURA.ne.jp \
--cc=tj@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox