From: Akira Yokosawa <akiyks@gmail.com>
To: Utkarsh Tripathi <utripathi2002@gmail.com>, corbet@lwn.net
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
skhan@linuxfoundation.org, Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH v2] Sphinx error fixed for inline literal end-string by changing $type_constant2 in kernel-doc script to include "*" unicode character in highlights_rst.
Date: Thu, 2 May 2024 19:39:48 +0900 [thread overview]
Message-ID: <640114d2-5780-48c3-a294-c0eba230f984@gmail.com> (raw)
In-Reply-To: <20240501175730.23326-1-utripathi2002@gmail.com>
Hi Utkarsh,
First of all, thank you for taking the time!
Besides Jon's comments on the summary and changelog, please find my
suggestion below.
On Wed, 1 May 2024 23:27:30 +0530, Utkarsh Tripathi wrote:
> The kernel-doc script uses the $type_constant2 variable to match
> expressions used to find embedded type information. The current
> implementation of $type_constant2 does not include the "*" unicode
> character, which is used to highlight inline literals in the
> documentation. This causes a Sphinx error when the inline literal
> end-string is used in the documentation.
I'm afraid your description of what is wrong is not clear enough ...
Let me talk using some examples.
Current kernel-doc (script) conversion to reST:
%WQ_* --> ``WQ_``*
Against which Sphinx complains:
WARNING: Inline literal start-string without end-string.
, because ``* is not recognized as end-string (of inline literal).
With your change applied, conversion to reST becomes:
%WQ_* --> ``WQ_*``
, and it is a proper inline literal.
Please update the changelog accordingly.
This is not urgent at all. Please take your time and read through
Documentation/process/submitting-patches.rst (among others) before
submitting v3.
Feel free to add (in v3):
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Thanks, Akira
next prev parent reply other threads:[~2024-05-02 10:39 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-01 13:32 [PATCH] Sphinx error fixed for inline literal end-string in include/linux/workqueue.h Utkarsh Tripathi
2024-05-01 15:05 ` Akira Yokosawa
2024-05-01 17:57 ` [PATCH v2] Sphinx error fixed for inline literal end-string by changing $type_constant2 in kernel-doc script to include "*" unicode character in highlights_rst Utkarsh Tripathi
2024-05-01 18:57 ` Jonathan Corbet
2024-05-02 10:39 ` Akira Yokosawa [this message]
2024-05-01 18:05 ` Utkarsh Tripathi
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=640114d2-5780-48c3-a294-c0eba230f984@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--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).