mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-29 05:40:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Improve wording for packed IDs

Browse source 
"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>
This commit is contained in:
Mikhail Gusarov 2023-04-22 11:46:19 +02:00 • committed by Daniel Stone
parent b42218f790
commit 88ece8a44d
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/publican/sources/Protocol.xml
View file

@ -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">