Skip to contentSkip to conversation

lis3: fix documentation to fit into 80 columns

PATCH Pavel Machek 4 participants 6 messages Jan 14, 2009 – Jan 20, 2009

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

Fix lis3 documentation to fit into 80 columns.

---
commit eeafe775925cc1d439daab3dfba3bb388ba5e038
tree 0ac90b1670ba7f7351bcdc246f86c66d15febb1f
parent f5f9696042990e4b2e280c6565dce5436e3bbf48
author Pavel <[email protected]> Wed, 14 Jan 2009 18:18:30 +0100 committer Pavel <[email protected]> Wed, 14 Jan 2009 18:18:30 +0100

 Documentation/hwmon/lis3lv02d |   30 +++++++++++++++++-------------
 1 files changed, 17 insertions(+), 13 deletions(-)
Documentation/hwmon/lis3lv02d +17 -13
index 65dfb0c..0fcfc4a 100644
@@ -13,18 +13,21 @@ Author:
 Description
 -----------
 
-This driver provides support for the accelerometer found in various HP laptops
-sporting the feature officially called "HP Mobile Data Protection System 3D" or
-"HP 3D DriveGuard". It detect automatically laptops with this sensor. Known models
-(for now the HP 2133, nc6420, nc2510, nc8510, nc84x0, nw9440 and nx9420) will
-have their axis automatically oriented on standard way (eg: you can directly
-play neverball).  The accelerometer data is readable via
+This driver provides support for the accelerometer found in various HP
+laptops sporting the feature officially called "HP Mobile Data
+Protection System 3D" or "HP 3D DriveGuard". It detect automatically
+laptops with this sensor. Known models (for now the HP 2133, nc6420,
+nc2510, nc8510, nc84x0, nw9440 and nx9420) will have their axis
+automatically oriented on standard way (eg: you can directly play
+neverball).  The accelerometer data is readable via
 /sys/devices/platform/lis3lv02d.
 
 Sysfs attributes under /sys/devices/platform/lis3lv02d/:
 position - 3D position that the accelerometer reports. Format: "(x,y,z)"
-calibrate - read: values (x, y, z) that are used as the base for input class device operation.
-            write: forces the base to be recalibrated with the current position.
+calibrate - read: values (x, y, z) that are used as the base for input
+		  class device operation.
+            write: forces the base to be recalibrated with the current
+		  position.
 rate - reports the sampling rate of the accelerometer device in HZ
 
 This driver also provides an absolute input class device, allowing
@@ -39,11 +42,12 @@ (aka "can play neverball out of the box"
  * When the laptop is horizontal the position reported is about 0 for X and Y
 and a positive value for Z
  * If the left side is elevated, X increases (becomes positive)
- * If the front side (where the touchpad is) is elevated, Y decreases (becomes negative)
+ * If the front side (where the touchpad is) is elevated, Y decreases
+	(becomes negative)
  * If the laptop is put upside-down, Z becomes negative
 
-If your laptop model is not recognized (cf "dmesg"), you can send an email to the
-authors to add it to the database.  When reporting a new laptop, please include
-the output of "dmidecode" plus the value of /sys/devices/platform/lis3lv02d/position
-in these four cases.
+If your laptop model is not recognized (cf "dmesg"), you can send an
+email to the authors to add it to the database.  When reporting a new
+laptop, please include the output of "dmidecode" plus the value of
+/sys/devices/platform/lis3lv02d/position in these four cases.
 
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#1 lore raw

Documentation/hwmon/lis3lv02d Author: · line 30

Quoted 8 lines · Pavel Machek

Sysfs attributes under /sys/devices/platform/lis3lv02d/:
position - 3D position that the accelerometer reports. Format: "(x,y,z)"

Documentation/hwmon/lis3lv02d +4 -2
-calibrate - read: values (x, y, z) that are used as the base for input class device operation.
-            write: forces the base to be recalibrated with the current position.
+calibrate - read: values (x, y, z) that are used as the base for input
+		  class device operation.
+            write: forces the base to be recalibrated with the current
+		  position.

I don't seem to be able to figure out what indentation is being used here. Why two tabs and two spaces? It doesn't align with anything this way.

Signature · 1 line
Jiri Kosina
#2 lore raw
Quoted 13 lines · Jiri Kosina

Documentation/hwmon/lis3lv02d Author: · line 30

Quoted 8 lines · Pavel Machek

Sysfs attributes under /sys/devices/platform/lis3lv02d/:
position - 3D position that the accelerometer reports. Format: "(x,y,z)"

Documentation/hwmon/lis3lv02d +4 -2
-calibrate - read: values (x, y, z) that are used as the base for input class device operation.
-            write: forces the base to be recalibrated with the current position.
+calibrate - read: values (x, y, z) that are used as the base for input
+		  class device operation.
+            write: forces the base to be recalibrated with the current
+		  position.

I don't seem to be able to figure out what indentation is being used here. Why two tabs and two spaces? It doesn't align with anything this way.

Added one more space :-), and fixed indentation in another place, too. Will push with next updates...
Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#3 lore raw
Quoted 10 lines · Pavel Machek
Quoted 10 lines

Documentation/hwmon/lis3lv02d Author: · line 30

Quoted 8 lines

Sysfs attributes under /sys/devices/platform/lis3lv02d/:
position - 3D position that the accelerometer reports. Format: "(x,y,z)"

Documentation/hwmon/lis3lv02d +4 -2
-calibrate - read: values (x, y, z) that are used as the base for input class device operation.
-            write: forces the base to be recalibrated with the current position.
+calibrate - read: values (x, y, z) that are used as the base for input
+		  class device operation.
+            write: forces the base to be recalibrated with the current
+		  position.

I don't seem to be able to figure out what indentation is being used here. Why two tabs and two spaces? It doesn't align with anything this way.

Quoted 2 lines

Added one more space :-), and fixed indentation in another place, too. Will push with next updates...

Never mind, I have noticed that it's already in Linus' tree even with the little bit wonky formatting, so I am not going to take it to trivial tree anyway.

Thanks,

Signature · 1 line
Jiri Kosina
#4 lore raw
In reply to Pavel Machek

Am Tuesday 20 January 2009 11:13:49 schrieb Pavel Machek:

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

 Sysfs attributes under /sys/devices/platform/lis3lv02d/:
 position - 3D position that the accelerometer reports. Format: "(x,y,z)" -calibrate - read: values (x, y, z) that are used as the base for input class device operation.
-            write: forces the base to be recalibrated with the current position.

So you are computing a position according acceleration readings? Isn't that common code to all accelerometers and should be put into a higher level?

Regards
Oliver

#5 lore raw

Oliver Neukum schreef:

Quoted 7 lines

Am Tuesday 20 January 2009 11:13:49 schrieb Pavel Machek:

Quoted 4 lines
Quoted 4 lines

Documentation/hwmon/lis3lv02d Author: · line 27

Quoted 4 lines

Sysfs attributes under /sys/devices/platform/lis3lv02d/:
position - 3D position that the accelerometer reports. Format: "(x,y,z)"

Documentation/hwmon/lis3lv02d +0 -2
-calibrate - read: values (x, y, z) that are used as the base for input class device operation.
-            write: forces the base to be recalibrated with the current position.

So you are computing a position according acceleration readings?

Not really, the "position" is actually only the current acceleration read from the sensor minus the calibration vector. It's more wording problem, nothing fancy like double integration ;-)

Quoted 2 lines

Isn't that common code to all accelerometers and should be put into a higher level?

Nevertheless, this remark is still valid, there are various code that all the accelerometer drivers could share. I'm thinking in particular of the sysfs interface, and joystick interface. There has been some work in this direction with the "industrialio" subsystem. So for now I'm in "wait and see" mode about this :-)

See you,
Eric