From 5e0ed917744f2f881956e91ebe971073fd0a7c51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20=C3=85dahl?= Date: Fri, 2 Oct 2015 17:32:54 +0800 Subject: [PATCH] client: Be more clear about when one must call wl_display_flush MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Blocking in general is not what means it is required to flush, but blocking on input from the wl_display file descriptor. Signed-off-by: Jonas Ådahl Reviewed-by: Bryce Harrington --- src/wayland-client.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/wayland-client.c b/src/wayland-client.c index f454b94b..007de0fe 100644 --- a/src/wayland-client.c +++ b/src/wayland-client.c @@ -1777,10 +1777,10 @@ wl_display_get_protocol_error(struct wl_display *display, * \param display The display context object * \return The number of bytes sent on success or -1 on failure * - * Send all buffered data on the client side to the server. Clients - * should call this function before blocking. On success, the number - * of bytes sent to the server is returned. On failure, this - * function returns -1 and errno is set appropriately. + * Send all buffered data on the client side to the server. Clients should + * always call this function before blocking on input from the display fd. + * On success, the number of bytes sent to the server is returned. On + * failure, this function returns -1 and errno is set appropriately. * * wl_display_flush() never blocks. It will write as much data as * possible, but if all data could not be written, errno will be set