[PATCH 1/2] docs: Document granularity of timestamps

[Jason Ekstrand]

I don't know that these extra comments are needed.  This information
is provided in the protocol documentation.  Also, if we do want them,
"timestamp in milliseconds" seems nicer to read than "timestamp with
millisecond granularity".
--Jason Ekstrand

On Sat, Mar 30, 2013 at 1:09 PM,  <matthias.clasen at gmail.com> wrote:
> From: Matthias Clasen <mclasen at redhat.com>
>
> This information is necessary to make any use of these fields.
> ---
>  protocol/wayland.xml | 20 ++++++++++++--------
>  1 file changed, 12 insertions(+), 8 deletions(-)
>
> diff --git a/protocol/wayland.xml b/protocol/wayland.xml
> index 2a27b1b..718a4a5 100644
> --- a/protocol/wayland.xml
> +++ b/protocol/wayland.xml
> @@ -543,7 +543,7 @@
>         is provided by the x an y arguments, in surface local
>         coordinates.
>        </description>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="x" type="fixed"/>
>        <arg name="y" type="fixed"/>
>      </event>
> @@ -1249,7 +1249,7 @@
>         focused surface.
>        </description>
>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="surface_x" type="fixed"/>
>        <arg name="surface_y" type="fixed"/>
>      </event>
> @@ -1269,10 +1269,12 @@
>
>         The location of the click is given by the last motion or
>         enter event.
> +        The time argument is a timestamp with millisecond
> +        granularity, with an undefined base.
>        </description>
>
>        <arg name="serial" type="uint"/>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="button" type="uint"/>
>        <arg name="state" type="uint"/>
>      </event>
> @@ -1305,7 +1307,7 @@
>         scroll distance.
>        </description>
>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="axis" type="uint"/>
>        <arg name="value" type="fixed"/>
>      </event>
> @@ -1368,10 +1370,12 @@
>      <event name="key">
>        <description summary="key event">
>         A key was pressed or released.
> +        The time argument is a timestamp with millisecond
> +        granularity, with an undefined base.
>        </description>
>
>        <arg name="serial" type="uint"/>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="key" type="uint"/>
>        <arg name="state" type="uint"/>
>      </event>
> @@ -1408,7 +1412,7 @@
>          of its surfaces.
>        </description>
>        <arg name="serial" type="uint"/>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="surface" type="object" interface="wl_surface"/>
>        <arg name="id" type="int" summary="ID of the touch sequence"/>
>        <arg name="x" type="fixed"/>
> @@ -1420,7 +1424,7 @@
>          Notifies the client that a touch has ended.
>        </description>
>        <arg name="serial" type="uint"/>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="id" type="int"/>
>      </event>
>
> @@ -1429,7 +1433,7 @@
>          Notifies the client that the position of a contact point
>          has changed.
>        </description>
> -      <arg name="time" type="uint"/>
> +      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
>        <arg name="id" type="int" summary="ID of the touch sequence"/>
>        <arg name="x" type="fixed"/>
>        <arg name="y" type="fixed"/>
> --
> 1.8.2
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel