server: Clarify fd ownership in wl_client_create()

It's unclear whether one needs to call close() if wl_client_create()
fails. Hopefully this change makes it more clear.

Signed-off-by: Vlad Zahorodnii <vlad.zahorodnii@kde.org>

1 files changed, 5 insertions, 0 deletions

diff --git a/src/wayland-server.c b/src/wayland-server.c
index 2df2e6a..0b5b13b 100644
--- a/src/wayland-server.c
+++ b/src/wayland-server.c
@@ -520,6 +520,11 @@ bind_display(struct wl_client *client, struct wl_display *display);
  *
  * On failure this function sets errno accordingly and returns NULL.
  *
+ * On success, the new client object takes the ownership of the file
+ * descriptor. On failure, the ownership of the socket endpoint file
+ * descriptor is unchanged, it is the responsibility of the caller to
+ * perform cleanup, e.g. call close().
+ *
  * \memberof wl_display
  */
 WL_EXPORT struct wl_client *