[7/9] doc: fixed reference to non-existent function

Submitted by Bill Spitzak on Nov. 12, 2014, 2:43 a.m.

Details

Message ID 1415760182-19568-8-git-send-email-spitzak@gmail.com
State Superseded
Headers show

Not browsing as part of any series.

Commit Message

Bill Spitzak Nov. 12, 2014, 2:43 a.m.
This is a guess as to what the correct reference is, please check!
---
 src/wayland-client.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Patch hide | download patch | download mbox

diff --git a/src/wayland-client.c b/src/wayland-client.c
index 21fc3e9..fb459a3 100644
--- a/src/wayland-client.c
+++ b/src/wayland-client.c
@@ -1506,7 +1506,7 @@  wl_display_dispatch_queue_pending(struct wl_display *display,
  * wl_display_dispatch_pending().
  *
  * \note Calling this will release the display file descriptor if this
- * thread acquired it using wl_display_acquire_fd().
+ * thread acquired it using wl_display_prepare_read().
  *
  * \sa wl_display_dispatch_pending(), wl_display_dispatch_queue()
  *

Comments

Actually, this comment should be deleted, wl_display_dispatch() doesn't do
anything like that since the wl_display_acquire_fd() was deleted. Or maybe
better, it should be replaced with current behavior regarding threads, that
is something like:

"This function can not be called simultaneously from more threads or
together with wl_display_prepare_read() and wl_display_read_events()
(unless the user manually serialize the calls using i.e. mutexes)

Nice catch,
Marek

On 12 November 2014 03:43, Bill Spitzak <spitzak@gmail.com> wrote:

> This is a guess as to what the correct reference is, please check!
> ---
>  src/wayland-client.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/src/wayland-client.c b/src/wayland-client.c
> index 21fc3e9..fb459a3 100644
> --- a/src/wayland-client.c
> +++ b/src/wayland-client.c
> @@ -1506,7 +1506,7 @@ wl_display_dispatch_queue_pending(struct wl_display
> *display,
>   * wl_display_dispatch_pending().
>   *
>   * \note Calling this will release the display file descriptor if this
> - * thread acquired it using wl_display_acquire_fd().
> + * thread acquired it using wl_display_prepare_read().
>   *
>   * \sa wl_display_dispatch_pending(), wl_display_dispatch_queue()
>   *
> --
> 1.7.9.5
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
>