[PATCH] documentation: Update documentation for calling wl_display_sync

[Pekka Paalanen]

On Wed, 8 Jul 2015 11:32:02 -0400
Christopher Michael <cpmichael at osg.samsung.com> wrote:

> The documentation for the wl_registry global object is partially
> incorrect. It stated that clients can use wl_display_sync immediately
> after calling wl_display.get_registry however this is misleading. If a
> client calls wl_display_sync without first setting up a registry
> listener, then clients will miss the advertisement of registry globals.
> 
> Signed-off-by: Chris Michael <cp.michael at samsung.com>
> ---
>   protocol/wayland.xml | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/protocol/wayland.xml b/protocol/wayland.xml
> index 42c9309..4db64bf 100644
> --- a/protocol/wayland.xml
> +++ b/protocol/wayland.xml
> @@ -115,8 +115,8 @@
>         registry will send out global and global_remove events to
>         keep the client up to date with the changes.  To mark the end
>         of the initial burst of events, the client can use the
> -      wl_display.sync request immediately after calling
> -      wl_display.get_registry.
> +      wl_display.sync request immediately after setting up a registry
> listener
> +      on the returned registry.
> 
>         A client can bind to a global object by using the bind
>         request.  This creates a client-side handle that lets the object

Hi,

<nitpick>
FYI, we don't have the concept of "listener" in the protocol. It is a C
bindings specific thing.

There is also no such thing as "returned" registry. The registry object
gets created by sending the get_registry request, there is nothing to
return. The returning you refer to is also just a C bindings thing.
</nitpick>


Thanks,
pq