Document unusual wl_registry.bind new_id behavior
authorDrew DeVault <sir@cmpwn.com>
Tue, 30 Jul 2019 02:39:00 +0000 (22:39 -0400)
committerDrew DeVault <sir@cmpwn.com>
Tue, 30 Jul 2019 11:32:29 +0000 (07:32 -0400)
commita2f1343b7e7c8f0a548b13a3424b7660a9ec0000
tree5bce411ab9075c6a33595b1e6a13cc8990657573
parent493ab79bd2cdf8f9f12fb9e5522200dc668b85e0
Document unusual wl_registry.bind new_id behavior

When wayland-scanner encounters a new_id field with no corresponding
interface name defined, instead of emitting a function whose signature
lines up with the usual case (a uint32_t ID), it adds the interface name
as a string and the version number so that the interface can be
identified from the protcol message.

Without docs, this was previously left for the interprid wire protocol
implementor (e.g. me an hour ago) to discover when Wayland clients send
them apparently bogus messages.

I would have preferred if a different primitive type were used here
(e.g. typed_new_id) to reflect the fact that the wire protocol is
different, but I felt it unwise to add a new primitive to wayland.xml in
$current_year.
doc/publican/sources/Protocol.xml