diff options
| author | Mikhail Gusarov <dottedmag@dottedmag.net> | 2023-04-22 11:46:19 +0200 |
|---|---|---|
| committer | Daniel Stone <daniels@collabora.com> | 2024-01-22 12:37:26 +0000 |
| commit | 88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b (patch) | |
| tree | 0abfdba3edbcc26686fc3d3635ade3258fc19130 /doc | |
| parent | client: Allow setting names for queues (diff) | |
| download | wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.tar wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.tar.gz wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.tar.bz2 wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.tar.lz wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.tar.xz wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.tar.zst wayland-88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b.zip | |
doc: Improve wording for packed IDs
"is incompatible with the implementation in libwayland" is a common
source of confusion as evidenced by repeated discussions in IRC
channel.
Improve the wording by making clear that
- packing IDs is a protocol requirement
- there are implementations (including libwayland) that enforce it
Signed-off-by: Mikhail Gusarov <dottedmag@dottedmag.net>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/publican/sources/Protocol.xml | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml index 57d8835..89d76d8 100644 --- a/doc/publican/sources/Protocol.xml +++ b/doc/publican/sources/Protocol.xml @@ -312,9 +312,10 @@ reserved to represent a null or non-existent object. For efficiency purposes, the IDs are densely packed in the sense that - the ID N will not be used until N-1 has been used. Any ID allocation - algorithm that does not maintain this property is incompatible with - the implementation in libwayland. + the ID N will not be used until N-1 has been used. This ordering is + not merely a guideline, but a strict requirement, and there are + implementations of the protocol that rigorously enforce this rule, + including the ubiquitous libwayland. </para> </section> <section id="sect-Protocol-Compositor"> |