wayland/doc/publican/sources
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
..
css doc: replace publican with xmlto 2014-09-22 10:30:41 +03:00
images doc: start documenting Xwayland 2017-12-18 12:05:03 +02:00
Architecture.xml doc: Hyphenate compound adjectives window-local, surface-local 2016-04-29 16:38:01 -07:00
Author_Group.xml doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
Book_Info.xml Replace initial 8 spaces with a tab for all xml files 2020-04-29 12:21:33 +00:00
Client.xml doc: Fix a typo in the client documentation 2016-11-16 16:39:44 +00:00
Compositors.xml Replace initial 8 spaces with a tab for all xml files 2020-04-29 12:21:33 +00:00
Foreword.xml Replace initial 8 spaces with a tab for all xml files 2020-04-29 12:21:33 +00:00
Introduction.xml Replace initial 8 spaces with a tab for all xml files 2020-04-29 12:21:33 +00:00
meson.build Add Meson build 2020-01-10 23:44:38 +01:00
Preface.xml Replace initial 8 spaces with a tab for all xml files 2020-04-29 12:21:33 +00:00
Protocol.xml Disrecommend the use of display socket name wayland-0 2021-02-20 20:40:07 -05:00
Revision_History.xml doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
Server.xml doc: fix typos 2020-12-17 16:03:14 -05:00
Wayland.ent doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
Wayland.xml doc: start documenting Xwayland 2017-12-18 12:05:03 +02:00
Xwayland.xml doc: fix typos 2020-12-17 16:03:14 -05:00