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@xxxxxxxxx>
Thanks, Akira
