[PATCH] documentation: Update documentation for calling wl_display_sync

[Bryce Harrington]

On Wed, Jul 08, 2015 at 11:32:02AM -0400, Christopher Michael 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>
Reviewed-by: Bryce Harrington <bryce at osg.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
> -- 
> 2.4.4
> 
> 
> 
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel