summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPekka Paalanen <pekka.paalanen@collabora.co.uk>2015-08-17 15:20:28 +0300
committerPekka Paalanen <pekka.paalanen@collabora.co.uk>2015-08-24 12:55:24 +0300
commitc7dbaa1cfda68185b3b0d3665efdf4620c66531e (patch)
treee4db1de8c2e8d9dada3f1955f778d1e1648937cc /doc
parentc0636ddcacc72c34a773f170aabdb46a5a21c275 (diff)
downloadwayland-c7dbaa1cfda68185b3b0d3665efdf4620c66531e.tar.gz
Revert "client: require WAYLAND_DISPLAY to be set"
This reverts commit fb7e13021730d0a5516ecbd3712ea4235e05d24d. Developers have been trying to reduce the number of by default required environment variables, and the mentioned commit is a step backwards in that sense. The fundamental assumption is that a user has only one main (Wayland) display server where all programs should connect to by default, and do so with an a priori known socket name. The commit also broke various use cases in the wild, some accidentally due to other causes, some intentionally. This revert allows those use cases to continue. The original problem of running Weston in a window in an existing GNOME X11 session and getting applications unintentionally launched into Weston can be circumvented by letting Weston use a non-default socket name, leaving wayland-0 unused. Discussion: http://lists.freedesktop.org/archives/wayland-devel/2015-August/023927.html http://lists.freedesktop.org/archives/wayland-devel/2015-August/023937.html Cc: Dima Ryazanov <dima@gmail.com> Cc: Giulio Camuffo <giuliocamuffo@gmail.com> Cc: Daniel Stone <daniel@fooishbar.org> Cc: Jasper St. Pierre <jstpierre@mecheye.net> Cc: Ryo Munakata <ryomnktml@gmail.com> Cc: Ray Strode <halfline@gmail.com> Cc: Peter Hutterer <peter.hutterer@who-t.net> Cc: Matthias Clasen <mclasen@redhat.com> Cc: Sjoerd Simons <sjoerd.simons@collabora.co.uk> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> Acked-by: Ray Strode <rstrode@redhat.com> Acked-by: Dima Ryazanov <dima@gmail.com> Reviewed-by: Bryce Harrington <bryce@osg.samsung.com> Acked-By: Sjoerd Simons <sjoerd.simons@collabora.co.uk> Acked-By: Ryo Munakata <ryomnktml@gmail.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/man/wl_display_connect.xml5
-rw-r--r--doc/publican/sources/Protocol.xml8
2 files changed, 7 insertions, 6 deletions
diff --git a/doc/man/wl_display_connect.xml b/doc/man/wl_display_connect.xml
index ded3cbd..7e6e05c 100644
--- a/doc/man/wl_display_connect.xml
+++ b/doc/man/wl_display_connect.xml
@@ -57,8 +57,9 @@
that was previously opened by a Wayland server. The server socket must
be placed in <envar>XDG_RUNTIME_DIR</envar> for this function to
find it. The <varname>name</varname> argument specifies the name of
- the socket or <constant>NULL</constant> to use the default
- (which is the value of <envar>WAYLAND_DISPLAY</envar>). If
+ the socket or <constant>NULL</constant> to use the default (which is
+ <constant>"wayland-0"</constant>). The environment variable
+ <envar>WAYLAND_DISPLAY</envar> replaces the default value. If
<envar>WAYLAND_SOCKET</envar> is set, this function behaves like
<function>wl_display_connect_to_fd</function> with the file-descriptor
number taken from the environment variable.</para>
diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml
index 9464953..477063b 100644
--- a/doc/publican/sources/Protocol.xml
+++ b/doc/publican/sources/Protocol.xml
@@ -60,10 +60,10 @@
<title>Wire Format</title>
<para>
The protocol is sent over a UNIX domain stream socket, where the endpoint
- name is determined by the <emphasis>WAYLAND_DISPLAY</emphasis>
- environment variable. Its value will usually be
- <systemitem class="service">wayland-0</systemitem>. The protocol is message-based.
- A message sent by a client to the server is called request. A message
+ usually is named <systemitem class="service">wayland-0</systemitem>
+ (although it can be changed via <emphasis>WAYLAND_DISPLAY</emphasis>
+ in the environment). The protocol is message-based. A
+ message sent by a client to the server is called request. A message
from the server to a client is called event. Every message is
structured as 32-bit words, values are represented in the host's
byte-order.