From dfae5ff98f15ad65472cb2d39a8153ced14be1b8 Mon Sep 17 00:00:00 2001
From: Markus Ongyerth <ongy@ongy.net>
Date: Sat, 13 Jan 2018 21:41:04 +0100
Subject: [PATCH] Update comment for wlr_headless_backend_create

---
 include/wlr/backend/wayland.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/wlr/backend/wayland.h b/include/wlr/backend/wayland.h
index 02ee5b2d..f89a6383 100644
--- a/include/wlr/backend/wayland.h
+++ b/include/wlr/backend/wayland.h
@@ -11,6 +11,10 @@
 /**
  * Creates a new wlr_wl_backend. This backend will be created with no outputs;
  * you must use wlr_wl_output_create to add them.
+ *
+ * The `remote` argument is the name of the host compositor wayland socket. Set
+ * to NULL for the default behaviour (WAYLAND_DISPLAY env variable or wayland-0
+ * default)
  */
 struct wlr_backend *wlr_wl_backend_create(struct wl_display *display, const char *remote);