[PATCH weston] build: install Weston protocol XML files #89966

[Pekka Paalanen]

On Wed,  5 Aug 2015 00:03:50 -0300
Dawid Gajownik <gajownik at gmail.com> wrote:

> Protocol XML files are required by external applications. This patch
> installs necessary files and makes them discoverable via pkg-config.
> 
> Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=89966
> 
> Signed-off-by: Dawid Gajownik <gajownik at gmail.com>
> ---
>  Makefile.am      | 2 +-
>  src/weston.pc.in | 2 ++
>  2 files changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Makefile.am b/Makefile.am
> index 76ab546..9ce7ea9 100644
> --- a/Makefile.am
> +++ b/Makefile.am
> @@ -1297,7 +1297,7 @@ BUILT_SOURCES +=				\
>  	protocol/text-protocol.c		\
>  	protocol/text-client-protocol.h
>  
> -EXTRA_DIST +=					\
> +dist_pkgdata_DATA =				\
>  	protocol/desktop-shell.xml		\
>  	protocol/screenshooter.xml		\
>  	protocol/text.xml			\

Hi,

NAK.

By policy, we do not install protocol XML files for extensions that
are not stable, or are intended to be private to Weston.

Weston should install only the protocol files which are both stable
and intended for use by external projects. I'm not sure if any
of the extensions defined in Weston qualify as is. They need
to be considered one by one at least.

The bug you refer to mentions desktop-shell.xml. If people agree
that this is a stable, Weston-specific interface, then we could
start by installing only that one.

I think desktop-shell.xml could be stable if it was renamed to
something not so generic, or if we come up with a scheme to mark it
as Weston's desktop-shell specific protocol. After all, it is
specific to not just Weston but Weston's desktop-shell, and it is a
privileged interface which means that only a specially started
client can access it.

weston-test.xml is an example of an extension that must never be
installed. It is an internal testing interface used by Weston's
test suite, and nothing else should ever even know about it. Not to
mention Weston only exposes that interface when loading the test
plugin which is also a thing to be never installed.

Note, that extensions that are not specific to Weston should
probably get moved into the Wayland repository, and be installed
from there. Candidates for such are at least scaler.xml and
presentation_timing.xml - however, they may need some cleaning up
while moving them. E.g. scaler.xml needs the redundant request
removed, which makes the stabilized protocol incompatible with the
current one. This might call for renaming of the global interface.


Thanks,
pq