[Wayland-bugs] [Bug 55183] New: protocol: XML files need to be installed and discoverable

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=55183

             Bug #: 55183
           Summary: protocol: XML files need to be installed and
                    discoverable
    Classification: Unclassified
           Product: Wayland
           Version: unspecified
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: medium
         Component: wayland
        AssignedTo: wayland-bugs at lists.freedesktop.org
        ReportedBy: ppaalanen at gmail.com


So far, we have always had the situation, that no project needs to generate
protocol bindings from a protocol extension defined in another project.
Libwayland's wayland.xml is only used in libwayland, and the full protocol is
exposed in the public library. Weston's special protocols are only used by
Weston and its demos. Therefore we have not seen a problem yet. Except maybe
for wl_drm sharing between Mesa and libva? And Qt projects?

Protocol XML files need to be installed and discoverable, perhaps via
pkg-config. We need to define the standard way to offer the protocol XML files
for both build time and runtime.

This is essential for non-C language bindings, which need to be able to find
wayland.xml to generate their bindings. Interpreted or dynamic languages may
need the XML files also during runtime.

It is also possible, that a server will offer a public protocol extension. In
that case, to be able to build clients using it, we need at least the protocol
XML file. For C, we might also install the generated headers (in dev packages),
but the XML file is essential, also for runtime.

Also a server plugin could expose a public protocol extension. Then this
plugin, which is possibly a project separate to the server, needs to install
the XML file.

The current situation:
- no XML files are installed by libwayland nor weston. Libwayland does install
wayland.xml under share/doc/, but that is perhaps for docs only? Does not sound
like the right place in any case.
- there is no way to find the XML files, if they were installed
- the current wayland-scanner.m4 and wayland-scanner.mk files from libwayland
assume that there is only a single directory for XML files in the project being
built, so they do not support installed XML files at all
- (OT: wayland-scanner.mk does not support non-recursive makefiles, where the
generated C files should be put in a subdirectory instead of the cwd)

-- 
Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.