Re: [PATCH] input: mt: Augment the event semantics documentation

[Dmitry Torokhov]

Hi Henrik,

On Sun, May 17, 2009 at 10:51:19PM +0200, Henrik Rydberg wrote:
> Through the collaboration to adapt the N-trig and Stantum HID
> drivers to the MT protocol, some semantic clarifications to the
> protocol have been made. This patch adds them to the MT documentation.
> 
> Signed-off-by: Henrik Rydberg <rydberg@xxxxxxxxxxx>
> Tested-by: Stéphane Chatty <chatty@xxxxxxx>

I was wondering if the following changes would not make the text a bit
better:

diff --git a/Documentation/input/multi-touch-protocol.txt b/Documentation/input/multi-touch-protocol.txt
index dd755c2..12f98fb 100644
--- a/Documentation/input/multi-touch-protocol.txt
+++ b/Documentation/input/multi-touch-protocol.txt
@@ -21,9 +21,9 @@ packet. The end of a packet is marked by calling the input_mt_sync()
 function, which generates a SYN_MT_REPORT event. This instructs the
 receiver to accept the data for the current finger and prepare to receive
 another. The end of a multi-touch transfer is marked by calling the usual
-input_sync() function. This instructs the receiver to perform actions based
-on the received packets, and prepare to receive a new set of finger
-packets.
+input_sync() function. This instructs the receiver to act upon events
+accumulated since last EV_SYN/SYN_REPORT and prepare to receive a new
+set of events/packets.
 
 A set of ABS_MT events with the desired properties is defined. The events
 are divided into categories, to allow for partial implementation.  The
@@ -79,8 +79,8 @@ ABS_MT_ORIENTATION
 The orientation of the ellipse. The value should describe a signed quarter
 of a revolution clockwise around the touch center. The signed value range
 is arbitrary, but zero should be returned for a finger aligned along the Y
-axis of the surface, something negative when twisted to the left, and
-something positive when twisted to the right. When completely aligned with
+axis of the surface, a negative value when finger is turned to the left, and
+a positive value when finger turned to the right. When completely aligned with
 the X axis, the range max should be returned.  Orientation can be omitted
 if the touching object is circular, or if the information is not available
 in the kernel driver. Partial orientation support is possible if the device
@@ -176,7 +176,7 @@ could be used to derive tilt.
 time of writing (April 2009), the MT protocol is not yet merged, and the
 prototype implements finger matching, basic mouse support and two-finger
 scrolling. The project aims at improving the quality of current multi-touch
-functionality available in the synaptics X driver, and in addition
+functionality available in the Synaptics X driver, and in addition
 implement more advanced gestures.
 [4] See the section on event computation.
 [5] See the section on finger tracking.


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