wayland/doc/publican/sources
Matt Hoosier 1b6521e695 client: Allow absolute paths in WAYLAND_DISPLAY
In order to support system compositor instances, it is necessary to
allow clients' wl_display_connect() to find the compositor's listening
socket somewhere outside of XDG_RUNTIME_DIR. For a full account, see
the discussion beginning here:

https://lists.freedesktop.org/archives/wayland-devel/2017-November/035664.html

This change adjusts the client-side connection logic so that, if
WAYLAND_DISPLAY is formatted as an absolute pathname, the socket
connection attempt is made to just $WAYLAND_DISPLAY rather than
usual user-private location $XDG_RUNTIME_DIR/$WAYLAND_DISPLAY.

This change is based on Davide Bettio's submission of the same concept
at:

https://lists.freedesktop.org/archives/wayland-devel/2015-August/023838.html.

v4 changes:

* Improved internal comments and some boundary-condition
  error checks in test case.
* Refer to compositor as "Wayland server" rather than "Wayland
  display" in wl_display_connect() doxygen comments.
* Remove redundant descriptions of parameter-interpretation
  mechanics from wl_display_connect() manpage. Reworked things
  to make it clear that 'name' and $WAYLAND_DISLAY are each
  capable of encoding absolute server socket paths.
* Remove callout to reference implementation behavior in protocol
  documented. In its place there is now a simple statement that
  implementations can optionally support absolute socket paths.

v3 changes:

* Added test case.
* Clarified documentation to note that 'name' parameter to wl_display_connect()
  can also be an absolute path.

v2 changes:

* Added backward incompatibility note to wl_display_connect() manpage.
* Rephased wl_display_connect() manpage changes to precisely match actual
  changed behavior.
* Added mention of new absolute path behavior in wl_display_connect()
  doxygen comments.
* Mentioned new absolute path interpretation of WAYLAND_DISPLAY in
  protocol documentation.

Signed-off-by: Matt Hoosier <matt.hoosier@gmail.com>
Acked-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
2017-12-11 10:03:59 +02:00
..
css doc: replace publican with xmlto 2014-09-22 10:30:41 +03:00
images doc: Switch from static image files to generated diagrams. 2015-01-28 17:43:16 -08: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 doc: Correct docbook title 2016-09-05 13:55:29 +03:00
Client.xml doc: Fix a typo in the client documentation 2016-11-16 16:39:44 +00:00
Compositors.xml doc: Improve "Library" and "Compositors" chapter 2013-04-04 16:57:44 -04:00
Foreword.xml publican: Cleanup Preface's grammar. 2013-08-08 21:38:14 -07:00
Introduction.xml publican: Drop unneeded 'of' 2013-08-08 21:38:28 -07:00
Preface.xml doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
Protocol.xml client: Allow absolute paths in WAYLAND_DISPLAY 2017-12-11 10:03:59 +02:00
Revision_History.xml doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
Server.xml doc: Intro text for doxygen output in it's own file 2015-01-29 17:13:01 -08:00
Wayland.ent doc: rename "Wayland" to "publican" 2013-04-03 15:44:50 -04:00
Wayland.xml doc: Intro text for doxygen output in it's own file 2015-01-29 17:13:01 -08:00