[Wayland-bugs] [Bug 91767] wl_display_dispatch(_queue) documentation about thread safeness is probably wrong

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=91767

Jonas Ådahl <jadahl at gmail.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         Resolution|---                         |FIXED
             Status|NEW                         |RESOLVED

--- Comment #5 from Jonas Ådahl <jadahl at gmail.com> ---
Marking this as fixed now, since the following patch is now merged:

commit 0edeeb9cd5806959660af54d63fe9d402d50e6e7
Author: Jonas Ådahl <jadahl at gmail.com>
Date:   Fri Oct 2 11:12:02 2015 +0800

    client: Correct documentation regarding thread safeness

    The current documentation about wl_display_dispatch() states one may not
    mix wl_display_dispatch(_queue)() with wl_display_prepare_read() and
    friends, but this is a misconception about how
    wl_display_dispatch(_queue)() works. The fact is that the dispatch
    functions does the equivalent of what the preparation API does
    internally, and it is safe to use together.

    What is not safe is to dispatch using the wl_display_dispatch(_queue)()
    functions while being prepared to read using wl_display_read_events().

    This patch rewrites the documentation to correctly state when the
    various API's are thread safe and how they may not be used.

    https://bugs.freedesktop.org/show_bug.cgi?id=91767

    Signed-off-by: Jonas Ådahl <jadahl at gmail.com>
    Reviewed-by: Daniel Stone <daniels at collabora.com>

-- 
You are receiving this mail because:
You are the assignee for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/wayland-bugs/attachments/20160202/6a94836b/attachment-0001.html>