modules/wayland: document that scan_xml can take any protocol. #13724
Conversation
mesonbuild/modules/wayland.py
Outdated
| @@ -112,11 +112,13 @@ def scan_xml(self, state: ModuleState, args: T.Tuple[T.List[FileOrString]], kwar | |||
| 'wayland.find_protocol', | |||
| KwargInfo('state', str, default='stable', validator=in_set_validator({'stable', 'staging', 'unstable'})), | |||
| KwargInfo('version', (int, NoneType)), | |||
| KwargInfo('vendored', bool, default=False, since='1.6.0'), | |||
There was a problem hiding this comment.
How can I indicate that this should be the next release?
There was a problem hiding this comment.
Just write the next release like you have, if this doesn't make it in till the next release, then we'd review saying "please update this to the next release"
mesonbuild/modules/wayland.py
Outdated
| @@ -112,11 +112,13 @@ def scan_xml(self, state: ModuleState, args: T.Tuple[T.List[FileOrString]], kwar | |||
| 'wayland.find_protocol', | |||
| KwargInfo('state', str, default='stable', validator=in_set_validator({'stable', 'staging', 'unstable'})), | |||
| KwargInfo('version', (int, NoneType)), | |||
| KwargInfo('vendored', bool, default=False, since='1.6.0'), | |||
There was a problem hiding this comment.
Just write the next release like you have, if this doesn't make it in till the next release, then we'd review saying "please update this to the next release"
mesonbuild/modules/wayland.py
Outdated
| ) | ||
| def find_protocol(self, state: ModuleState, args: T.Tuple[str], kwargs: FindProtocol) -> File: | ||
| base_name = args[0] | ||
| xml_state = kwargs['state'] | ||
| version = kwargs['version'] | ||
| vendored = kwargs['vendored'] |
There was a problem hiding this comment.
you also need to add the vendored keyword to the FindProtocol definition.
|
Hmm, turns out this is already supported, as used by GNOME: https://gitlab.gnome.org/GNOME/gtk/-/blob/2d1367ccdc4c604d8e5f5308763746eab01e6b6e/gdk/wayland/meson.build#L158 I will transition this PR into simply documenting that use case. |
The quick example can be slightly misleading in implying that scan_xml must use find_protocol, which is not the case. So explicitly mention it in the scan_xml docs.
ericonr
force-pushed
the
wayland-vendor
branch
from
bc5bad2
to
000fe8f
Compare
ericonr
changed the title
|
Ping? |
A lot of projects vendor protocols, since the ones they are using aren't available in default system directories. One example would be kanshi, where I am trying to use the wayland module (see ericonr/kanshi#2).
Right now this PR has a few issues. The main one is that the first configuration works and the project can be built successfully, but then, when I touch any of the
meson.buildfiles, the reconfiguration fails:I feel like I'm using a totally wrong way of getting the current source directory.
Furthermore, I don't think this is the ideal interface. A "directory" key might work better? For example in cases where people grab the protocol from a git submodule, so they can't have a
meson.buildin the same directory as the protocol definition. I would appreciate guidance on the interface definition and in actually implementing it.