diff mbox series

[v3] docs: ABI: sysfs-class-power: Documented cycle_count property

Message ID 20210913132853.606265-1-hdegoede@redhat.com
State Superseded
Headers show
Series [v3] docs: ABI: sysfs-class-power: Documented cycle_count property | expand

Commit Message

Hans de Goede Sept. 13, 2021, 1:28 p.m. UTC
Commit c955fe8e0bdd ("POWER: Add support for cycle_count") added a
POWER_SUPPLY_PROP_CYCLE_COUNT "cycle_count" property to the set of
standard power-supply properties, but this was never documented,
document it now.

Link: https://gitlab.freedesktop.org/upower/upower/-/issues/152
Reported-by: Bastien Nocera <hadess@hadess.net>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
---
Changes in v3 (aka the really really typo free version)
- Fix typo in "cycle_count" in Subject

Changes in v2:
- s/Possitive/Positive/
---
 Documentation/ABI/testing/sysfs-class-power | 11 +++++++++++
 1 file changed, 11 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
index ca830c6cd809..687db552c374 100644
--- a/Documentation/ABI/testing/sysfs-class-power
+++ b/Documentation/ABI/testing/sysfs-class-power
@@ -480,6 +480,17 @@  Description:
 
 		Valid values: Represented in microvolts
 
+What:		/sys/class/power_supply/<supply_name>/cycle_count
+Date:		January 2010
+Contact:	linux-pm@vger.kernel.org
+Description:
+		Reports the number of full charge + discharge cycles the
+		battery has undergone.
+
+		Access: Read
+
+		Valid values: Positive integer representing full cycles
+
 **USB Properties**
 
 What:		/sys/class/power_supply/<supply_name>/input_current_limit