From 88ece8a44d13eb6c00bb1c7c3c7c5a8fce2c3f4b Mon Sep 17 00:00:00 2001 From: Mikhail Gusarov Date: Sat, 22 Apr 2023 11:46:19 +0200 Subject: [PATCH] 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 --- doc/publican/sources/Protocol.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/publican/sources/Protocol.xml b/doc/publican/sources/Protocol.xml index 57d88357..89d76d8e 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.