Re: [PATCH 1/7] docs: ABI: power: rt9471: Fix invalid inline emphasis

[Randy Dunlap]

On 10/26/26 6:26 AM, Waqar Hameed wrote:
> On Sun, Oct 25, 2026 at 19:39 -0700 Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
> 
>> On 10/25/26 3:05 PM, Waqar Hameed wrote:
>>> `docutils` warns:
>>>
>>>   Documentation/ABI/testing/sysfs-class-power-rt9471:1: (WARNING/2) Inline emphasis start-string without end-string.
>>>   Documentation/ABI/testing/sysfs-class-power-rt9471:20: (WARNING/2) Inline
>>> emphasis start-string without end-string.
>>>
>>> Fix this by escaping the `*`.
>>
>> I'm still seeing this issue after the patch is applied (same for patch 4/7).
>> Maybe we are fighting a docutils your-version vs. my-version problem
>> or just a moving target.
> 
> Hm, that's weird. What output do you actually get? The '*' is escaped
> now, so it shouldn't complain...
> 

docutils still complains:

Documentation/ABI/testing/sysfs-class-power-rt9467:1: WARNING: Inline emphasis start-string without end-string. [docutils]
Documentation/ABI/testing/sysfs-class-power-rt9471:1: WARNING: Inline emphasis start-string without end-string. [docutils]

and running the command that Mauro provided:
$ ./tools/docs/get_abi.py -D Documentation/ABI/testing/ rest --enable-lineno|grep -A20 rt9467

gives me:
.. LINENO Documentation/ABI/testing/sysfs-class-power-rt9467#1

.. _abi_sys_class_power_supply_rt9467_sysoff_enable:

+------------------------------------------------------------+
| **\/sys\/class\/power_supply\/rt9467\-\\*\/sysoff_enable** |
+------------------------------------------------------------+

Defined on file :ref:`sysfs-class-power-rt9467 <abi_file_testing_sysfs_class_pow
er_rt9467>`

This entry allows enabling the sysoff mode of rt9467 charger
devices.
If enabled and the input is removed, the internal battery FET
is turned off to reduce the leakage from the BAT pin. See
device datasheet for details. It's commonly used when the
product enter shipping stage. After entering shipping mode,
only 'VBUS' or 'Power key' pressed can make it leave this mode.
'Disable' also can help to leave it, but it's more like to
abort the action before the device really enter shipping mode.

Note: use /sys/class/power_supply/rt9467-*/load_switch instead.
---

Aha. It's the line above that now needs to have the '*' character
escaped. I have no warnings after that is done.


>>
>> $ docutils --version
>> docutils-3.13 (Docutils 0.23, Python 3.13.16, on linux)
> 
> I have
> 
>   docutils (Docutils 0.20.1, Python 3.12.3, on linux)
> 
>>
>>> Reported-by: kernel test robot <lkp@xxxxxxxxx>
>>> Closes: https://lore.kernel.org/oe-kbuild-all/202609110722.GAZVme6v-lkp@xxxxxxxxx/
>>> Signed-off-by: Waqar Hameed <waqar.hameed@xxxxxxxx>
>>> ---
>>>  Documentation/ABI/testing/sysfs-class-power-rt9471 | 4 ++--
>>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
>>> index 0a390ee5ac21c..04a771cd23512 100644
>>> --- a/Documentation/ABI/testing/sysfs-class-power-rt9471
>>> +++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
>>> @@ -1,4 +1,4 @@
>>> -What:                /sys/class/power_supply/rt9471-*/sysoff_enable
>>> +What:                /sys/class/power_supply/rt9471-\*/sysoff_enable
>>>  Date:                Feb 2023
>>>  KernelVersion:       6.3
>>>  Contact:     ChiYuan Huang <cy_huang@xxxxxxxxxxx>
>>> @@ -16,7 +16,7 @@ Description:
>>>               - 1: enabled
>>>               - 0: disabled
>>>
>>> -What:                /sys/class/power_supply/rt9471-*/port_detect_enable
>>> +What:                /sys/class/power_supply/rt9471-\*/port_detect_enable
>>>  Date:                Feb 2023
>>>  KernelVersion:       6.3
>>>  Contact:     ChiYuan Huang <cy_huang@xxxxxxxxxxx>

-- 
~Randy