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

[PATCH v2 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/

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/cover.1792965060.git.waqar.hameed@axis.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 |  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
-- 
2.43.0

[PATCH v2 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: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 <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 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
index 90cf94c1cbf6b..d4ea9c9a5a9b2 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>
@@ -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 <cy_huang@richtek.com>
-- 
2.43.0

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

[Randy Dunlap]

On 10/28/26 3:39 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: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 <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>

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

> ---
>  Documentation/ABI/testing/sysfs-class-power-rt9471 | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
> index 90cf94c1cbf6b..d4ea9c9a5a9b2 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>
> @@ -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 <cy_huang@richtek.com>

-- 
~Randy

[PATCH v2 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 | 4 ++++
 1 file changed, 4 insertions(+)

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

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

[Randy Dunlap]

On 10/28/26 3:39 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>

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

> ---
>  Documentation/ABI/testing/sysfs-class-power-rt9471 | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9471 b/Documentation/ABI/testing/sysfs-class-power-rt9471
> index d4ea9c9a5a9b2..53393488ec419 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-rt9471
> +++ b/Documentation/ABI/testing/sysfs-class-power-rt9471
> @@ -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

-- 
~Randy

[PATCH v2 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/
Acked-by: Randy Dunlap <rdunlap@infradead.org>
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 53393488ec419..89455f6b44a47 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 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 v2 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.
  Documentation/ABI/testing/sysfs-class-power-rt9471:16: (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 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
index bfbfd78ec1c19..bfb9c0f478e45 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>
@@ -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:
-- 
2.43.0

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

[Randy Dunlap]

On 10/28/26 3:39 PM, Waqar Hameed wrote:
> `docutils` 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.

rt9471 above! :)

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

> 
> 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 | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
> index bfbfd78ec1c19..bfb9c0f478e45 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>
> @@ -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:

-- 
~Randy

[PATCH v2 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 | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
index bfb9c0f478e45..3090e188ec493 100644
--- a/Documentation/ABI/testing/sysfs-class-power-rt9467
+++ b/Documentation/ABI/testing/sysfs-class-power-rt9467
@@ -16,6 +16,8 @@ Description:
 		Note: use /sys/class/power_supply/rt9467-\*/load_switch instead.
 
 		Access: Read, Write
+
 		Valid values:
+
 		- 1: enabled
 		- 0: disabled
-- 
2.43.0

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

[Randy Dunlap]

On 10/28/26 3:39 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>

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

> ---
>  Documentation/ABI/testing/sysfs-class-power-rt9467 | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power-rt9467 b/Documentation/ABI/testing/sysfs-class-power-rt9467
> index bfb9c0f478e45..3090e188ec493 100644
> --- a/Documentation/ABI/testing/sysfs-class-power-rt9467
> +++ b/Documentation/ABI/testing/sysfs-class-power-rt9467
> @@ -16,6 +16,8 @@ Description:
>  		Note: use /sys/class/power_supply/rt9467-\*/load_switch instead.
>  
>  		Access: Read, Write
> +
>  		Valid values:
> +
>  		- 1: enabled
>  		- 0: disabled

-- 
~Randy

[PATCH v2 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 v2 7/7] docs: ABI: power: rt9756: Fix invalid inline emphasis

[Randy Dunlap]

On 10/28/26 3:39 PM, Waqar Hameed wrote:
> `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>

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

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

The bullet list above could be improved (probably just add
a blank line before it).

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

-- 
~Randy

[PATCH v2 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/
Acked-by: Randy Dunlap <rdunlap@infradead.org>
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 3090e188ec493..a36f5e6dd9160 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