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

PATCH kernel test robot 4 participants 5 messages Oct 15 – Oct 21 Documentation

lore

Share & tools

lore

kernel test robot

author build bot

2026-10-15 08:12 UTC #0 lore raw

Hi Waqar,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
head:   d419d682257d813f6cb7a28e42b35d0edf4ad038
commit: 3f21de6784a654503cc148169d1f59d89971da13 [3622/16987] power: supply: rt9467: Use POWER_SUPPLY_PROP_LOAD_SWITCH
compiler: clang version 22.1.8 (https://github.com/llvm/llvm-project ca7933e47d3a3451d81e72ac174dcb5aa28b59d1)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)
reproduce: (https://download.01.org/0day-ci/archive/20261015/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All warnings (new ones prefixed by >>):

Using alabaster theme
WARNING: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/os_mode is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:364; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:234
WARNING: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/os_mode_index is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:373; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:243
WARNING: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/touchpad/enabled is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:636; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:252
WARNING: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/touchpad/enabled_index is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:645; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:261

>> 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]
   WARNING: ./block/blk-map.c:366 Excess function parameter 'op' description in 'bio_copy_kern'
   Documentation/driver-api/basics:42: ./kernel/time/time.c:387: WARNING: Duplicate C declaration, also defined at driver-api/basics:436.
   Declaration is '.. c:function:: unsigned int jiffies_to_msecs (const unsigned long j)'. [duplicate_declaration.c]
   Documentation/driver-api/basics:42: ./kernel/time/time.c:410: WARNING: Duplicate C declaration, also defined at driver-api/basics:453.

vim +1 Documentation/ABI/testing/sysfs-class-power-rt9467

eedb923279b78cb ChiaEn Wu 2023-01-03 @1 What: /sys/class/power_supply/rt9467-*/sysoff_enable

:::::: The code at line 1 was first introduced by commit
:::::: eedb923279b78cbfe16dd54dade0d73e9977f118 Documentation: power: rt9467: Document exported sysfs entries

:::::: TO: ChiaEn Wu <[email protected]>
:::::: CC: Sebastian Reichel <[email protected]>

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

Randy Dunlap

reviewer

2026-10-20 00:15 UTC #1 lore raw

[for kernel-doc people]

Quoted 9 lines · kernel test robot

Hi Waqar,

FYI, the error/warning still remains.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
head:   d419d682257d813f6cb7a28e42b35d0edf4ad038
commit: 3f21de6784a654503cc148169d1f59d89971da13 [3622/16987] power: supply: rt9467: Use POWER_SUPPLY_PROP_LOAD_SWITCH
compiler: clang version 22.1.8 (https://github.com/llvm/llvm-project ca7933e47d3a3451d81e72ac174dcb5aa28b59d1)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)

I am using:

$ docutils --version
docutils-3.13 (Docutils 0.23, Python 3.13.16, on linux)
$ python3 --version
Python 3.13.16

Quoted 7 lines

reproduce: (https://download.01.org/0day-ci/archive/20261015/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

Quoted 7 lines

All warnings (new ones prefixed by >>):
Using alabaster theme
Quoted 1 line
Quoted 1 line
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 I only see one of these warnings (rt9467), although the sources for them are VERY similar.Why would that happen?
Do we need to fix anything?

Quoted 9 lines

vim +1 Documentation/ABI/testing/sysfs-class-power-rt9467
eedb923279b78cb ChiaEn Wu 2023-01-03 @1 What: /sys/class/power_supply/rt9467-*/sysoff_enable
:::::: The code at line 1 was first introduced by commit
:::::: eedb923279b78cbfe16dd54dade0d73e9977f118 Documentation: power: rt9467: Document exported sysfs entries
:::::: TO: ChiaEn Wu <[email protected]>
:::::: CC: Sebastian Reichel <[email protected]>

Signature · 1 line

~Randy

Mauro Carvalho Chehab

2026-10-20 08:16 UTC #2 lore raw

Quoted 32 lines · On Mon, 19 Oct 2026 17:15:02 -0700 Randy Dunlap <[email protected]> wrote:

[for kernel-doc people]
Quoted 9 lines · kernel test robot
Hi Waqar,
FYI, the error/warning still remains.
tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
head:   d419d682257d813f6cb7a28e42b35d0edf4ad038
commit: 3f21de6784a654503cc148169d1f59d89971da13 [3622/16987] power: supply: rt9467: Use POWER_SUPPLY_PROP_LOAD_SWITCH
compiler: clang version 22.1.8 (https://github.com/llvm/llvm-project ca7933e47d3a3451d81e72ac174dcb5aa28b59d1)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)  
I am using:
$ docutils --version
docutils-3.13 (Docutils 0.23, Python 3.13.16, on linux)
$ python3 --version
Python 3.13.16
Quoted 10 lines
reproduce: (https://download.01.org/0day-ci/archive/20261015/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
Using alabaster theme

Quoted 10 lines

Quoted 2 lines
Quoted 1 line
Quoted 1 line
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 I only see one of these warnings (rt9467), although the sources for them are VERY similar.Why would that happen?
Do we need to fix anything?
Quoted 3 lines
vim +1 Documentation/ABI/testing/sysfs-class-power-rt9467
eedb923279b78cb ChiaEn Wu 2023-01-03 @1 What: /sys/class/power_supply/rt9467-*/sysoff_enable

Getting just line 1 is wrong. See:

	$ ./tools/docs/get_abi.py -D Documentation/ABI/testing/ rest --enable-lineno|grep -A20 rt9467

.. 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_power_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.

Access: Read, Write
Valid values:
- 1: enabled
- 0: disabled

.. LINENO Documentation/ABI/testing/sysfs-class-power-rt9471#19

Just like kernel-doc, lines are incremented per symbol.

Line 1 means the sysfs data that starts on line 1. In this specific case, I'm seeing two issues there:

- 'Power key" - I guess it won't generate a warning, but the quote types don't match.

- Here, blank lines are missing:

Access: Read, Write
Valid values:
- 1: enabled
- 0: disabled

Causing this output:

Access: Read, Write Valid values: - 1: enabled - 0: disabled

The right way to format it would be:

Access: Read, Write

Valid values:

- 1: enabled
- 0: disabled

As RST format considers a single "\n" as if the next line to be part of the same paragraph. So, to split paragraphs, a blank line is needed.

If you want to test it, I suggest placing the rst content on a file and ask Sphinx to build it. What I usually do to test stuff created via kernel-doc/get_abi/... is to create a:

Documentation/<temp_dir>

adding there just an index file and the output I want to test. Then, I use make with SPHINXDIRS=<temp_dir>, as this is a lot faster than building the entire Kernel.

	$ mkdir Documentation/get_abi_tmp_dir
	$ ./tools/docs/get_abi.py -D Documentation/ABI/testing/ rest > Documentation/get_abi_tmp_dir/testing_abi.rst
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/os_mode is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:364; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:234
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/os_mode_index is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:373; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:243
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/touchpad/enabled is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:636; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:252
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/touchpad/enabled_index is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:645; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:261
	[INFO] Didn't find ABI reference for 'Documentation/ABI/stable/sysfs-devices-node'
	[INFO] Didn't find ABI reference for 'Documentation/ABI/stable/sysfs-devices-node'

	$ cat <<EOF > get_abi_tmp_dir/index.rst
	Test
	====

	.. toctree::
	   :maxdepth: 1

	   testing_abi
	EOF

	$ make SPHINXDIRS=get_abi_tmp_dir htmldocs

here, I'm placing the entire content of the abi testing, but you could alternatively create a dir with a subset of files under ABI and test only the ones that hits errors. Once fixed, you can copy them back to the ABI directory.

Btw, at least here (docs/docs-mw branch), I can´t see any such errors.

Quoted 7 lines

Quoted 6 lines
:::::: The code at line 1 was first introduced by commit
:::::: eedb923279b78cbfe16dd54dade0d73e9977f118 Documentation: power: rt9467: Document exported sysfs entries
:::::: TO: ChiaEn Wu <[email protected]>
:::::: CC: Sebastian Reichel <[email protected]>

Thanks,
Mauro

Randy Dunlap

reviewer

2026-10-21 02:22 UTC #3 lore raw

Quoted 80 lines · Mauro Carvalho Chehab

Quoted 32 lines · On Mon, 19 Oct 2026 17:15:02 -0700 Randy Dunlap <[email protected]> wrote:
[for kernel-doc people]
Quoted 9 lines · kernel test robot
Hi Waqar,
FYI, the error/warning still remains.
tree:   https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master
head:   d419d682257d813f6cb7a28e42b35d0edf4ad038
commit: 3f21de6784a654503cc148169d1f59d89971da13 [3622/16987] power: supply: rt9467: Use POWER_SUPPLY_PROP_LOAD_SWITCH
compiler: clang version 22.1.8 (https://github.com/llvm/llvm-project ca7933e47d3a3451d81e72ac174dcb5aa28b59d1)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)  
I am using:
$ docutils --version
docutils-3.13 (Docutils 0.23, Python 3.13.16, on linux)
$ python3 --version
Python 3.13.16
Quoted 10 lines
reproduce: (https://download.01.org/0day-ci/archive/20261015/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
Using alabaster theme
Quoted 10 lines
Quoted 2 lines
Quoted 1 line
Quoted 1 line
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 I only see one of these warnings (rt9467), although the sources for them are VERY similar.Why would that happen?
Do we need to fix anything?
Quoted 3 lines
vim +1 Documentation/ABI/testing/sysfs-class-power-rt9467
eedb923279b78cb ChiaEn Wu 2023-01-03 @1 What: /sys/class/power_supply/rt9467-*/sysoff_enable
Getting just line 1 is wrong. See:
	$ ./tools/docs/get_abi.py -D Documentation/ABI/testing/ rest --enable-lineno|grep -A20 rt9467
.. 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_power_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.
Access: Read, Write
Valid values:
- 1: enabled
- 0: disabled
.. LINENO Documentation/ABI/testing/sysfs-class-power-rt9471#19

Quoted 7 lines

Just like kernel-doc, lines are incremented per symbol.
Line 1 means the sysfs data that starts on line 1. In this specific case, I'm seeing two issues there:
- 'Power key" - I guess it won't generate a warning, but the quote types don't match.

Your eyes must be better than mine. :)

Quoted 7 lines

- Here, blank lines are missing:
Access: Read, Write
Valid values:
- 1: enabled
- 0: disabled

Yes, I've seen plenty of that issue.

Quoted 49 lines

Causing this output:
Access: Read, Write Valid values: - 1: enabled - 0: disabled
The right way to format it would be:
Access: Read, Write
Valid values:
- 1: enabled
- 0: disabled
As RST format considers a single "\n" as if the next line to be part of the same paragraph. So, to split paragraphs, a blank line is needed.
If you want to test it, I suggest placing the rst content on a file and ask Sphinx to build it. What I usually do to test stuff created via kernel-doc/get_abi/... is to create a:
Documentation/<temp_dir>
adding there just an index file and the output I want to test. Then, I use make with SPHINXDIRS=<temp_dir>, as this is a lot faster than building the entire Kernel.
	$ mkdir Documentation/get_abi_tmp_dir
	$ ./tools/docs/get_abi.py -D Documentation/ABI/testing/ rest > Documentation/get_abi_tmp_dir/testing_abi.rst
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/os_mode is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:364; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:234
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/os_mode_index is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:373; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:243
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/touchpad/enabled is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:636; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:252
	[WARNING] /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/touchpad/enabled_index is defined 2 times: Documentation/ABI/testing/sysfs-driver-hid-lenovo-go:645; Documentation/ABI/testing/sysfs-driver-hid-lenovo-go-s:261
	[INFO] Didn't find ABI reference for 'Documentation/ABI/stable/sysfs-devices-node'
	[INFO] Didn't find ABI reference for 'Documentation/ABI/stable/sysfs-devices-node'
	$ cat <<EOF > get_abi_tmp_dir/index.rst
	Test
	====
	.. toctree::
	   :maxdepth: 1

	   testing_abi
	EOF

	$ make SPHINXDIRS=get_abi_tmp_dir htmldocs

Quoted 4 lines

here, I'm placing the entire content of the abi testing, but you could alternatively create a dir with a subset of files under ABI and test only the ones that hits errors. Once fixed, you can copy them back to the ABI directory.

I see.

Quoted 2 lines

Btw, at least here (docs/docs-mw branch), I can´t see any such errors.

I don't know why that would be. The files haven't been corrected for the issues that you identified.

Quoted 6 lines

Quoted 6 lines
Quoted 6 lines
:::::: The code at line 1 was first introduced by commit
:::::: eedb923279b78cbfe16dd54dade0d73e9977f118 Documentation: power: rt9467: Document exported sysfs entries
:::::: TO: ChiaEn Wu <[email protected]>
:::::: CC: Sebastian Reichel <[email protected]>

Thanks for your informative help.

Waqar, do you want to update these 2 files for the 2 issues that Mauro pointed out? or I can do it...

Signature · 1 line

~Randy

Waqar Hameed

2026-10-21 09:50 UTC #4 lore raw

On Tue, Oct 20, 2026 at 19:22 -0700 Randy Dunlap <[email protected]> wrote:

[...]

Quoted 4 lines

Thanks for your informative help.
Waqar, do you want to update these 2 files for the 2 issues that Mauro pointed out? or I can do it...

I was waiting for Sebastian on the other thread [1]. But as I answered there, I'll just send the patch instead. Please stand by!

[1] https://lore.kernel.org/linux-doc/[email protected]/