[PATCH 05/21] doc: Improve various sections of the documentation

[Pekka Paalanen]

On Sat, 30 Mar 2013 01:11:31 -0400
matthias.clasen at gmail.com wrote:

> From: Matthias Clasen <mclasen at redhat.com>
> 
> ---
>  doc/Wayland/en_US/Protocol.xml | 71 ++++++++++++++++++------------------------
>  1 file changed, 31 insertions(+), 40 deletions(-)
> 
> diff --git a/doc/Wayland/en_US/Protocol.xml b/doc/Wayland/en_US/Protocol.xml
> index 955b054..9bc8232 100644
> --- a/doc/Wayland/en_US/Protocol.xml
> +++ b/doc/Wayland/en_US/Protocol.xml
> @@ -196,19 +196,10 @@
>    <section id="sect-Protocol-Creating-Objects">
>      <title>Creating Objects</title>
>      <para>
> -      <itemizedlist>
> -	<listitem>
> -	  <para>
> -	    client allocates object ID, uses range protocol
> -	  </para>
> -	</listitem>
> -	<listitem>
> -	  <para>
> -	    server tracks how many IDs are left in current range, sends
> -	    new range when client is about to run out.
> -	  </para>
> -	</listitem>
> -      </itemizedlist>
> +      Each object has a unique ID. The IDs are allocated by the
> +      client, from a range of IDs. The server tracks how many
> +      IDs are left in the current range and sends a new range
> +      when the client is about to run out.

Hi,

I think this paragraph is not true anymore. It'd be more like:

"Each object has a unique ID for a client. The ID name space is
private to each client (wl_display connection), and consists of the
32-bit unsigned integers. The ID 0 is reserved to denote no object
(NULL). The 32-bit integer range is split into client-allocated and
server-allocated IDs.

Destruction of an object is tied to specific requests, usually the
destroy request, or in rare cases to a certain event (see e.g.
wl_callback). When an object is finally destroyed, the server sends
a wl_display.delete_id event with the ID, denoting that the ID can
be recycled."

I wrote that from the top of my head, so some checking would be in
order. Feel free to take this verbatim, if it's accurate.


Thanks,
pq