[PATCH 0/7] docs: ABI: power: Clean it up

[PATCH 0/7] docs: ABI: power: Clean it up

[Waqar Hameed]

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/cover.1788290289.git.waqar.hameed@axis.com/
[2] https://lore.kernel.org/oe-kbuild-all/202610151025.1g5IgCv2-lkp@intel.com/

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 | 5 +++--
 Documentation/ABI/testing/sysfs-class-power-rt9471 | 8 +++++---
 Documentation/ABI/testing/sysfs-class-power-rt9756 | 4 ++--
 3 files changed, 10 insertions(+), 7 deletions(-)


base-commit: 734bef548a96e8774d6eef5dfa2026c6edc4e80b
-- 
2.43.0

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

[Waqar Hameed]

`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 `*`.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202609110722.GAZVme6v-lkp@intel.com/
Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 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@richtek.com>
@@ -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@richtek.com>
-- 
2.43.0

[PATCH 2/7] docs: ABI: power: rt9471: Add newline for paragraphs

[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:

Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 Documentation/ABI/testing/sysfs-class-power-rt9471 | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
index 04a771cd23512..c306e2ead6bb7 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9471
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
@@ -12,6 +12,7 @@ Description:
 		the action before the device really enter shipping mode.
 
 		Access: Read, Write
+
 		Valid values:
 		- 1: enabled
 		- 0: disabled
@@ -27,6 +28,7 @@ Description:
 		datasheet for details. Normally controlled when TypeC/USBPD port integrated.
 
 		Access: Read, Write
+
 		Valid values:
 		- 1: enabled
 		- 0: disabled
-- 
2.43.0

[PATCH 3/7] docs: ABI: power: rt9471: Fix mismatched quote

[Waqar Hameed]

Quotes should have matching characters. Fix this by replacing '"' with
'''.

Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 Documentation/ABI/testing/sysfs-class-power-rt9471 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
index c306e2ead6bb7..eced82ff43022 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9471
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
@@ -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' 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.
 
-- 
2.43.0

[PATCH 4/7] docs: ABI: power: rt9467: Fix invalid inline emphasis

[Waqar Hameed]

`docutils` warns:

  Documentation/ABI/testing/sysfs-class-power-rt9467:1: (WARNING/2) Inline emphasis start-string without end-string.

Fix this by escaping the `*`.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202610151025.1g5IgCv2-lkp@intel.com/
Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
index 619b7c45d145d..db37ca64cb625 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9467
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9467
@@ -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 <chiaen_wu@richtek.com>
-- 
2.43.0

[PATCH 5/7] docs: ABI: power: rt9467: Add newline for paragraphs

[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:

Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 Documentation/ABI/testing/sysfs-class-power-rt9467 | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
index db37ca64cb625..4d9f5893bef50 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9467
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9467
@@ -14,6 +14,7 @@ Description:
 		abort the action before the device really enter shipping mode.
 
 		Access: Read, Write
+
 		Valid values:
 		- 1: enabled
 		- 0: disabled
-- 
2.43.0

[PATCH 6/7] docs: ABI: power: rt9467: Fix mismatched quote

[Waqar Hameed]

Quotes should have matching characters. Fix this by replacing '"' with
'''.

Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
index 4d9f5893bef50..9f9e831b0d1cb 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9467
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9467
@@ -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.
 
-- 
2.43.0

[PATCH 7/7] docs: ABI: power: rt9756: Fix invalid inline emphasis

[Waqar Hameed]

`docutils` 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 `*`.

Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
---
 Documentation/ABI/testing/sysfs-class-power-rt9756 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9756 b/Documentation/ABI/testing/sysfs-class-power-rt9756
index c4d6c2b4715d3..e1ec7977a3402 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9756
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9756
@@ -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 <cy_huang@richtek.com>
@@ -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 <cy_huang@richtek.com>
-- 
2.43.0

Re: [PATCH 2/7] docs: ABI: power: rt9471: Add newline for paragraphs

[Randy Dunlap]

Hi,

On 10/25/26 3:05 PM, Waqar Hameed wrote:
> 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:
> 
> Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
> Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
> ---
>  Documentation/ABI/testing/sysfs-class-power-rt9471 | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
> index 04a771cd23512..c306e2ead6bb7 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-rt9471
> +++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
> @@ -12,6 +12,7 @@ Description:
>  		the action before the device really enter shipping mode.
>  
>  		Access: Read, Write
> +
>  		Valid values:

It would look nicer to add a blank line here (and below) so that the 2
following lines are processed as bullet items.
(as Mauro suggested)

Same for patch 5/7.

>  		- 1: enabled
>  		- 0: disabled
> @@ -27,6 +28,7 @@ Description:
>  		datasheet for details. Normally controlled when TypeC/USBPD port integrated.
>  
>  		Access: Read, Write
> +
>  		Valid values:
>  		- 1: enabled
>  		- 0: disabled

-- 
~Randy

Re: [PATCH 6/7] docs: ABI: power: rt9467: Fix mismatched quote

[Randy Dunlap]

On 10/25/26 3:05 PM, Waqar Hameed wrote:
> Quotes should have matching characters. Fix this by replacing '"' with
> '''.
> 
> Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
> Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
> index 4d9f5893bef50..9f9e831b0d1cb 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-rt9467
> +++ b/Documentation/ABI/testing/sysfs-class-power-rt9467
> @@ -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.
>  

-- 
~Randy

Re: [PATCH 3/7] docs: ABI: power: rt9471: Fix mismatched quote

[Randy Dunlap]

On 10/25/26 3:05 PM, Waqar Hameed wrote:
> Quotes should have matching characters. Fix this by replacing '"' with
> '''.
> 
> Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Closes: https://lore.kernel.org/oe-kbuild-all/20261020101625.01874245@foz.lan/
> Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/ABI/testing/sysfs-class-power-rt9471 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
> index c306e2ead6bb7..eced82ff43022 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-rt9471
> +++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
> @@ -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' 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.
>  

-- 
~Randy

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

[Randy Dunlap]

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.

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

> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202609110722.GAZVme6v-lkp@intel.com/
> Signed-off-by: Waqar Hameed <waqar.hameed@axis.com>
> ---
>  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@richtek.com>
> @@ -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@richtek.com>

-- 
~Randy