Linux Power Management development
 help / color / mirror / Atom feed
* [PATCH] docs: power: supply: fix inline strings
@ 2026-10-08 17:12 Randy Dunlap
  2026-11-02 15:53 ` Jonathan Corbet
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2026-10-08 17:12 UTC (permalink / raw)
  To: linux-pm
  Cc: patches, Randy Dunlap, kernel test robot,
	Iván Ezequiel Rodriguez, Sebastian Reichel, Jonathan Corbet,
	Shuah Khan, linux-doc

Consistently use `string` to quote code symbols.
This repairs the docs build warning:

  Documentation/power/power_supply_class.rst:211: WARNING: Inline emphasis start-string without end-string. [docutils]

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202610050416.L69x2Wpo-lkp@intel.com/
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Iván Ezequiel Rodriguez <ivanrwcm25@gmail.com>
Cc: Sebastian Reichel <sebastian.reichel@collabora.com>
Cc: linux-pm@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org

 Documentation/power/power_supply_class.rst |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linext-2026-1007.orig/Documentation/power/power_supply_class.rst
+++ linext-2026-1007/Documentation/power/power_supply_class.rst
@@ -97,7 +97,7 @@ AUTHENTIC
 
 HEALTH
   represents health of the battery. Values correspond to
-  POWER_SUPPLY_HEALTH_*, defined in include/linux/power_supply.h.
+  `POWER_SUPPLY_HEALTH_*`, defined in include/linux/power_supply.h.
 
 VOLTAGE_OCV
   open circuit voltage of the battery.
@@ -188,7 +188,7 @@ CAPACITY_ALERT_MIN
 CAPACITY_ALERT_MAX
   maximum capacity alert value in percents.
 CAPACITY_LEVEL
-  capacity level. This corresponds to POWER_SUPPLY_CAPACITY_LEVEL_*.
+  capacity level. This corresponds to `POWER_SUPPLY_CAPACITY_LEVEL_*`.
 
 TEMP
   temperature of the power supply.
@@ -209,8 +209,8 @@ TEMP_MAX
 
 TIME_TO_EMPTY_NOW, TIME_TO_EMPTY_AVG
   seconds left for battery to be considered empty
-  (i.e., while battery powers a load). *_NOW is a
-  momentary reading; *_AVG is averaged over a fixed period.
+  (i.e., while battery powers a load). `*_NOW` is a
+  momentary reading; `*_AVG` is averaged over a fixed period.
 TIME_TO_FULL_NOW, TIME_TO_FULL_AVG
   seconds left for battery to be considered full
   (i.e., while battery is charging). Same now/avg distinction.

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] docs: power: supply: fix inline strings
  2026-10-08 17:12 [PATCH] docs: power: supply: fix inline strings Randy Dunlap
@ 2026-11-02 15:53 ` Jonathan Corbet
  0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2026-11-02 15:53 UTC (permalink / raw)
  To: Randy Dunlap, linux-pm
  Cc: patches, Randy Dunlap, kernel test robot,
	Iván Ezequiel Rodriguez, Sebastian Reichel, Shuah Khan,
	linux-doc

Randy Dunlap <rdunlap@infradead.org> writes:

> Consistently use `string` to quote code symbols.
> This repairs the docs build warning:
>
>   Documentation/power/power_supply_class.rst:211: WARNING: Inline emphasis start-string without end-string. [docutils]
>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202610050416.L69x2Wpo-lkp@intel.com/
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Iván Ezequiel Rodriguez <ivanrwcm25@gmail.com>
> Cc: Sebastian Reichel <sebastian.reichel@collabora.com>
> Cc: linux-pm@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
>
>  Documentation/power/power_supply_class.rst |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-11-02 15:53 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-10-08 17:12 [PATCH] docs: power: supply: fix inline strings Randy Dunlap
2026-11-02 15:53 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox