summaryrefslogtreecommitdiff
path: root/doc/xml-xcb.txt
diff options
context:
space:
mode:
authorChristian Linhart <chris@demorecorder.com>2016-01-18 06:52:02 +0100
committerChristian Linhart <chris@demorecorder.com>2016-01-27 06:39:14 +0100
commit21b11ee553a0bf074e9672be9107e11c97704195 (patch)
tree689ea65518835c71fdfdc274cdd201ce02f99c77 /doc/xml-xcb.txt
parent811e038c9501dfe95301d5f148be1f2b1bafbc1e (diff)
downloadxcb-proto-21b11ee553a0bf074e9672be9107e11c97704195.tar.gz
optionally enforce serialization of pads
From now on, due to a patch in libxcb, pads will not be serialized anymore. This is to maintain ABI-compatibility when adding explicit align pads. However, some align pads were already be serialized in prior official versions of libxcb. Therefore we need a method to enforce serialization, so we can maintainn ABI compatibility with that legacy. Signed-off-by: Christian Linhart <chris@demorecorder.com>
Diffstat (limited to 'doc/xml-xcb.txt')
-rw-r--r--doc/xml-xcb.txt9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/xml-xcb.txt b/doc/xml-xcb.txt
index 12c0881..9cef1de 100644
--- a/doc/xml-xcb.txt
+++ b/doc/xml-xcb.txt
@@ -191,11 +191,18 @@ enum; the value is restricted to one of the constants named in the enum.
"mask" refers to an exhaustive enum to be used as a bitmask.
"altmask" may be a mask from the referred enum, but it need not be.
-<pad bytes="integer" />
+<pad bytes="integer" serialize="bool" />
This element declares some padding in a data structure. The bytes
attribute declares the number of bytes of padding.
+ If serialize="true", then the pad will be serialized/deserialized.
+ This is only needed for ABI compatibility with legacy.
+ Newly added pads should not be defined with serialize="true".
+
+ The serialize attribute may be omitted.
+ Default is serialize="false".
+
<field type="identifier" name="identifier" />
This element represents a field in a data structure. The type attribute