[PATCH] power/ds2760_battery: document ABI change

From: Daniel Mack
Date: Tue May 18 2010 - 16:26:40 EST

Add some documentation for the newly added writeable properties.

Signed-off-by: Daniel Mack <daniel@xxxxxxxx>
On Tue, May 18, 2010 at 12:56:24PM -0700, Greg KH wrote:
> On Tue, May 18, 2010 at 09:49:52PM +0200, Daniel Mack wrote:
> > This patch adds support for writeable power supply properties and
> > exposes them as writeable to sysfs.
> Please properly document this in Documentation/ABI as you are changing
> the userspace ABI.
> thanks,
> greg k-h

Is something like the following appropriate?

Documentation/ABI/testing/sysfs-class-power | 21 +++++++++++++++++++++
1 files changed, 21 insertions(+), 0 deletions(-)
create mode 100644 Documentation/ABI/testing/sysfs-class-power

diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
new file mode 100644
index 0000000..f46ad66
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-power
@@ -0,0 +1,21 @@
+What: /sys/class/power/ds2760-battery.*/charge_now
+Date: May 2010
+KernelVersion: 2.6.35
+Contact: Daniel Mack <daniel@xxxxxxxx>
+ This file is writeable and can be used to set the current
+ coloumb counter value inside the battery monitor chip. This
+ is needed for unavoidable corrections of aging batteries.
+ A userspace daemon can monitor the battery charging logic
+ and once the counter drops out of considerable bounds, take
+ appropriate action.
+What: /sys/class/power/ds2760-battery.*/charge_full
+Date: May 2010
+KernelVersion: 2.6.35
+Contact: Daniel Mack <daniel@xxxxxxxx>
+ This file is writeable and can be used to set the assumed
+ battery 'full level'. As batteries age, this value has to be
+ amended over time.
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/