[PATCH] documentation: Update documentation for calling wl_display_sync

Christopher Michael cpmichael at osg.samsung.com
Wed Jul 8 08:32:02 PDT 2015

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
+      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

More information about the wayland-devel mailing list