From: Jonathan Corbet <corbet@lwn.net>
To: Utkarsh Tripathi <utripathi2002@gmail.com>, akiyks@gmail.com
Cc: Utkarsh Tripathi <utripathi2002@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
skhan@linuxfoundation.org
Subject: Re: [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning.
Date: Tue, 07 May 2024 08:23:20 -0600 [thread overview]
Message-ID: <87v83pg0pz.fsf@meer.lwn.net> (raw)
In-Reply-To: <20240503182650.7761-1-utripathi2002@gmail.com>
Utkarsh Tripathi <utripathi2002@gmail.com> writes:
> Fixed: WARNING: Inline literal start-string without end-string in
> Documentation/core-api/workqueue.rst
>
> Added "*" in $type_constants2 in kernel-doc script to include "*" in the
> conversion to hightlights.
> Previously: %WQ_* --> ``WQ_``*
> After Changes: %WQ_* --> ``WQ_*``
> Need for the fix: ``* is not recognized as a valid end-string for inline literal.
>
>> The kernel-doc script uses the $type_constant2 variable to match
>> expressions used to find embedded type information.
I've applied this. I made a changelog tweak, in that this line:
> v1 and v2 discussions: https://lore.kernel.org/linux-doc/640114d2-5780-48c3-a294-c0eba230f984@gmail.com
...should really just be a Link: tag rather than something special.
Thanks,
jon
prev parent reply other threads:[~2024-05-07 14:23 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-03 18:26 [PATCH v3] kernel-doc: Added "*" in $type_constants2 to fix 'make htmldocs' warning Utkarsh Tripathi
2024-05-04 7:17 ` Bagas Sanjaya
2024-05-07 14:23 ` Jonathan Corbet [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=87v83pg0pz.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=akiyks@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=utripathi2002@gmail.com \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).