docs: ABI: power: Clean it up
v2 cover docs: ABI: power: Clean it up
While working on adding sysfs support for system load control [1], kernel test robot reported some warnings. This patch series fixes those and some additional ones that were discovered during discussions [2].
[1] https://lore.kernel.org/lkml/[email protected]/
[2] https://lore.kernel.org/oe-kbuild-all/[email protected]/
Changes in v2:
* Add additional newlines after "Valid values:" (as originally reported by Mauro Carvalho Chehab and pointed out by Randy Dunlap).
* Rebase to latest linux-next master (and thus fix the additional invalid inline emphasis as reported by Randy Dunlap).
* When fixing mismatch quotes on patch 3, somehow the word "key" was dropped. Restore it.
Link to v1: https://lore.kernel.org/lkml/[email protected]/
Waqar Hameed (7):
docs: ABI: power: rt9471: Fix invalid inline emphasis
docs: ABI: power: rt9471: Add newline for paragraphs
docs: ABI: power: rt9471: Fix mismatched quote
docs: ABI: power: rt9467: Fix invalid inline emphasis
docs: ABI: power: rt9467: Add newline for paragraphs
docs: ABI: power: rt9467: Fix mismatched quote
docs: ABI: power: rt9756: Fix invalid inline emphasis
Documentation/ABI/testing/sysfs-class-power-rt9467 | 8 +++++--- Documentation/ABI/testing/sysfs-class-power-rt9471 | 12 ++++++++---- Documentation/ABI/testing/sysfs-class-power-rt9756 | 4 ++-- 3 files changed, 15 insertions(+), 9 deletions(-)
base-commit: 151a134a4e6ec66f69db8750c66006f5207f7a9d
Signature · 1 line
2.43.0
PATCH v2 1/7 docs: ABI: power: rt9471: Fix invalid inline emphasis
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:14: (WARNING/2) Inline emphasis start-string without end-string. Documentation/ABI/testing/sysfs-class-power-rt9471:21: (WARNING/2) Inline emphasis start-string without end-string.
Fix this by escaping the *.
--- Documentation/ABI/testing/sysfs-class-power-rt9471 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/ABI/testing/sysfs-class-power-rt9471 +3 -3
@@ -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 <[email protected]>
@@ -11,14 +11,14 @@ Description: 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/rt9471-*/load_switch instead. + Note: use /sys/class/power_supply/rt9471-\*/load_switch instead. Access: Read, Write Valid values: - 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 <[email protected]>
Signature · 1 line
2.43.0
Re: [PATCH v2 1/7] docs: ABI: power: rt9471: Fix invalid inline emphasis
Quoted 11 lines · Waqar Hameed
docutilswarns:
Documentation/ABI/testing/sysfs-class-power-rt9471:1: (WARNING/2) Inline emphasis start-string without end-string.Documentation/ABI/testing/sysfs-class-power-rt9471:14: (WARNING/2) Inline emphasis start-string without end-string.Documentation/ABI/testing/sysfs-class-power-rt9471:21: (WARNING/2) Inline emphasis start-string without end-string.Fix this by escaping the
*.Reported-by kernel test robot <[email protected]>Signed-off-by Waqar Hameed <[email protected]>
Quoted 31 lines
--- Documentation/ABI/testing/sysfs-class-power-rt9471 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)Documentation/ABI/testing/sysfs-class-power-rt9471 +3
-3@@ -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 <[email protected]>@@ -11,14 +11,14 @@ Description: 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/rt9471-*/load_switch instead. + Note: use /sys/class/power_supply/rt9471-\*/load_switch instead. Access: Read, Write Valid values: - 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 <[email protected]>
Signature · 1 line
~Randy
PATCH v2 2/7 docs: ABI: power: rt9471: Add newline for paragraphs
In reply to Waqar HameedTo split paragraphs in reStructuredText, an empty line is needed. Otherwise the output will be:
Access: Read, Write Valid values: - 1: enabled - 0: disabled
Add a newline in order to properly format it as intended.
--- Documentation/ABI/testing/sysfs-class-power-rt9471 | 4 ++++ 1 file changed, 4 insertions(+)
Documentation/ABI/testing/sysfs-class-power-rt9471 +4 -0
@@ -14,7 +14,9 @@ Description: Note: use /sys/class/power_supply/rt9471-\*/load_switch instead. Access: Read, Write + Valid values: + - 1: enabled - 0: disabled
@@ -29,6 +31,8 @@ Description: datasheet for details. Normally controlled when TypeC/USBPD port integrated. Access: Read, Write + Valid values: + - 1: enabled - 0: disabled
Signature · 1 line
2.43.0
Re: [PATCH v2 2/7] docs: ABI: power: rt9471: Add newline for paragraphs
Quoted 10 lines · Waqar Hameed
To split paragraphs in reStructuredText, an empty line is needed. Otherwise the output will be:
Access: Read, Write Valid values: - 1: enabled - 0: disabled
Add a newline in order to properly format it as intended.
Quoted 27 lines
--- Documentation/ABI/testing/sysfs-class-power-rt9471 | 4 ++++ 1 file changed, 4 insertions(+)Documentation/ABI/testing/sysfs-class-power-rt9471 +4
-0@@ -14,7 +14,9 @@ Description: Note: use /sys/class/power_supply/rt9471-\*/load_switch instead. Access: Read, Write + Valid values: + - 1: enabled - 0: disabled@@ -29,6 +31,8 @@ Description: datasheet for details. Normally controlled when TypeC/USBPD port integrated. Access: Read, Write + Valid values: + - 1: enabled - 0: disabled
Signature · 1 line
~Randy
PATCH v2 3/7 docs: ABI: power: rt9471: Fix mismatched quote
In reply to Waqar HameedQuotes should have matching characters. Fix this by replacing '"' with '''.
--- Documentation/ABI/testing/sysfs-class-power-rt9471 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-class-power-rt9471 +1 -1
@@ -7,7 +7,7 @@ Description: 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 + 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.
Signature · 1 line
2.43.0
PATCH v2 4/7 docs: ABI: power: rt9467: Fix invalid inline emphasis
In reply to Waqar Hameeddocutils warns:
Documentation/ABI/testing/sysfs-class-power-rt9467:1: (WARNING/2) Inline emphasis start-string without end-string. Documentation/ABI/testing/sysfs-class-power-rt9471:16: (WARNING/2) Inline emphasis start-string without end-string.
Fix this by escaping the *.
--- Documentation/ABI/testing/sysfs-class-power-rt9467 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-class-power-rt9467 +2 -2
@@ -1,4 +1,4 @@ -What: /sys/class/power_supply/rt9467-*/sysoff_enable +What: /sys/class/power_supply/rt9467-\*/sysoff_enable Date: Feb 2023 KernelVersion: 6.3 Contact: ChiaEn Wu <[email protected]>
@@ -13,7 +13,7 @@ Description: '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. + Note: use /sys/class/power_supply/rt9467-\*/load_switch instead. Access: Read, Write Valid values:
Signature · 1 line
2.43.0
Re: [PATCH v2 4/7] docs: ABI: power: rt9467: Fix invalid inline emphasis
Quoted 4 lines · Waqar Hameed
docutilswarns:
Documentation/ABI/testing/sysfs-class-power-rt9467:1: (WARNING/2) Inline emphasis start-string without end-string.Documentation/ABI/testing/sysfs-class-power-rt9471:16: (WARNING/2) Inline emphasis start-string without end-string.
rt9471 above! :)
Quoted 29 lines
Fix this by escaping the
*.Reported-by kernel test robot <[email protected]>Signed-off-by Waqar Hameed <[email protected]>--- Documentation/ABI/testing/sysfs-class-power-rt9467 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/ABI/testing/sysfs-class-power-rt9467 +2
-2@@ -1,4 +1,4 @@ -What: /sys/class/power_supply/rt9467-*/sysoff_enable +What: /sys/class/power_supply/rt9467-\*/sysoff_enable Date: Feb 2023 KernelVersion: 6.3 Contact: ChiaEn Wu <[email protected]>@@ -13,7 +13,7 @@ Description: '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. + Note: use /sys/class/power_supply/rt9467-\*/load_switch instead. Access: Read, Write Valid values:
Signature · 1 line
~Randy
Re: [PATCH v2 4/7] docs: ABI: power: rt9467: Fix invalid inline emphasis
Quoted 7 lines · On Thu, Oct 29, 2026 at 09:06 -0700 Randy Dunlap <[email protected]> wrote:
Quoted 4 lines · Waqar Hameed
docutilswarns:
Documentation/ABI/testing/sysfs-class-power-rt9467:1: (WARNING/2) Inline emphasis start-string without end-string.Documentation/ABI/testing/sysfs-class-power-rt9471:16: (WARNING/2) Inline emphasis start-string without end-string.rt9471 above! :)
Good catch! Copy-paste mistake...
I'm thinking Sebastian could just amend this when picking this up? Will wait for him before doing anything.
Quoted 33 lines
Tested-by Randy Dunlap <[email protected]>Acked-by Randy Dunlap <[email protected]>Quoted 29 lines
Fix this by escaping the
*.Reported-by kernel test robot <[email protected]>Signed-off-by Waqar Hameed <[email protected]>--- Documentation/ABI/testing/sysfs-class-power-rt9467 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/ABI/testing/sysfs-class-power-rt9467 +2
-2@@ -1,4 +1,4 @@ -What: /sys/class/power_supply/rt9467-*/sysoff_enable +What: /sys/class/power_supply/rt9467-\*/sysoff_enable Date: Feb 2023 KernelVersion: 6.3 Contact: ChiaEn Wu <[email protected]>@@ -13,7 +13,7 @@ Description: '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. + Note: use /sys/class/power_supply/rt9467-\*/load_switch instead. Access: Read, Write Valid values:
PATCH v2 5/7 docs: ABI: power: rt9467: Add newline for paragraphs
In reply to Waqar HameedTo split paragraphs in reStructuredText, an empty line is needed. Otherwise the output will be:
Access: Read, Write Valid values: - 1: enabled - 0: disabled
Add a newline in order to properly format it as intended.
--- Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 ++ 1 file changed, 2 insertions(+)
Documentation/ABI/testing/sysfs-class-power-rt9467 +2 -0
@@ -16,6 +16,8 @@ Description: Note: use /sys/class/power_supply/rt9467-\*/load_switch instead. Access: Read, Write + Valid values: + - 1: enabled - 0: disabled
Signature · 1 line
2.43.0
Re: [PATCH v2 5/7] docs: ABI: power: rt9467: Add newline for paragraphs
Quoted 10 lines · Waqar Hameed
To split paragraphs in reStructuredText, an empty line is needed. Otherwise the output will be:
Access: Read, Write Valid values: - 1: enabled - 0: disabled
Add a newline in order to properly format it as intended.
Quoted 17 lines
--- Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 ++ 1 file changed, 2 insertions(+)Documentation/ABI/testing/sysfs-class-power-rt9467 +2
-0@@ -16,6 +16,8 @@ Description: Note: use /sys/class/power_supply/rt9467-\*/load_switch instead. Access: Read, Write + Valid values: + - 1: enabled - 0: disabled
Signature · 1 line
~Randy
PATCH v2 6/7 docs: ABI: power: rt9467: Fix mismatched quote
In reply to Waqar HameedQuotes should have matching characters. Fix this by replacing '"' with '''.
--- Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-class-power-rt9467 +1 -1
@@ -9,7 +9,7 @@ Description: 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. + 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.
Signature · 1 line
2.43.0
PATCH v2 7/7 docs: ABI: power: rt9756: Fix invalid inline emphasis
In reply to Waqar Hameeddocutils warns:
Documentation/ABI/testing/sysfs-class-power-rt9756:1: (WARNING/2) Inline emphasis start-string without end-string. Documentation/ABI/testing/sysfs-class-power-rt9756:17: (WARNING/2) Inline emphasis start-string without end-string.
Fix this by escaping the *.
--- Documentation/ABI/testing/sysfs-class-power-rt9756 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/ABI/testing/sysfs-class-power-rt9756 +2 -2
@@ -1,4 +1,4 @@ -What: /sys/class/power_supply/rt9756-*/watchdog_timer +What: /sys/class/power_supply/rt9756-\*/watchdog_timer Date: Dec 2025 KernelVersion: 6.19 Contact: ChiYuan Huang <[email protected]>
@@ -14,7 +14,7 @@ Description: - 500, 1000, 5000, 30000, 40000, 80000, 128000 or 255000 (milliseconds), - 0: disabled -What: /sys/class/power_supply/rt9756-*/operation_mode +What: /sys/class/power_supply/rt9756-\*/operation_mode Date: Dec 2025 KernelVersion: 6.19 Contact: ChiYuan Huang <[email protected]>
Signature · 1 line
2.43.0
Re: [PATCH v2 7/7] docs: ABI: power: rt9756: Fix invalid inline emphasis
Quoted 8 lines · Waqar Hameed
docutilswarns:
Documentation/ABI/testing/sysfs-class-power-rt9756:1: (WARNING/2) Inline emphasis start-string without end-string.Documentation/ABI/testing/sysfs-class-power-rt9756:17: (WARNING/2) Inline emphasis start-string without end-string.Fix this by escaping the
*.Signed-off-by Waqar Hameed <[email protected]>
Quoted 15 lines
--- Documentation/ABI/testing/sysfs-class-power-rt9756 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/ABI/testing/sysfs-class-power-rt9756 +1
-1@@ -1,4 +1,4 @@ -What: /sys/class/power_supply/rt9756-*/watchdog_timer +What: /sys/class/power_supply/rt9756-\*/watchdog_timer Date: Dec 2025 KernelVersion: 6.19 Contact: ChiYuan Huang <[email protected]>
Documentation/ABI/testing/sysfs-class-power-rt9756 Description: · line 15
Quoted 2 lines
Documentation/ABI/testing/sysfs-class-power-rt9756 +0
-0@@ -14,7 +14,7 @@ Description: - 500, 1000, 5000, 30000, 40000, 80000, 128000 or 255000 (milliseconds), - 0: disabled
The bullet list above could be improved (probably just add a blank line before it).
Quoted 6 lines
Documentation/ABI/testing/sysfs-class-power-rt9756 +1
-1-What: /sys/class/power_supply/rt9756-*/operation_mode +What: /sys/class/power_supply/rt9756-\*/operation_mode Date: Dec 2025 KernelVersion: 6.19 Contact: ChiYuan Huang <[email protected]>
Signature · 1 line
~Randy