wayland/doc/publican
Manuel Stoeckl 8f518f958a Disrecommend the use of display socket name wayland-0
Connecting by default to wayland-0 when environment variables
WAYLAND_DISPLAY/WAYLAND_SOCKET are not set can cause unexpected
connections when more than one session is being used. Specifically, if you
run a program from a non-Wayland context (over ssh, on a VT, in an X11
session, from a job scheduler), while some unrelated compositor is
listening on wayland-0, the program may connect to the compositor and
leave the user wondering what has happened.

This commit adjusts the documentation to clarify that the wayland-0
fallback is kept "for compatibility reasons", implying that in typical
use programs do not rely on it. The changes to the wayland-server
documentation (+ publican docs) briefly explain why compositors should
avoid providing wayland-0.

To avoid breaking existing software, the fallback to wayland-0 has not
been removed (and perhaps never will be).

As part of this change, the wl_display_add_socket_auto function has been
documented to describe its action as well as the recommended alternative
of connecting to the first available socket in the sequence wayland-1,
wayland-2, etc.

Signed-off-by: Manuel Stoeckl <code@mstoeckl.com>
2021-02-20 20:40:07 -05:00
..
sources Disrecommend the use of display socket name wayland-0 2021-02-20 20:40:07 -05:00
.gitignore doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
doxygen-to-publican.xsl doc: Unpublish wl_display_get_additional_shm_formats 2016-06-01 17:34:17 -07:00
Makefile.am doc: start documenting Xwayland 2017-12-18 12:05:03 +02:00
merge-mapcoords.xsl doc: Create hot-linked areas in documents. 2015-01-28 17:43:18 -08:00
meson.build doc: make reproducible 2020-10-29 12:56:15 +00:00
protocol-interfaces-to-docbook.xsl doc: removed the word "interface" from the link names 2014-12-19 16:15:29 +02:00
protocol-to-docbook.xsl doc: fix typos 2020-12-17 16:03:14 -05:00