[Xcb] documentation again
Thomas Hunger
hto at arcor.de
Fri Apr 20 07:29:33 PDT 2007
Hello,
there was some discussion about documenting the protocol via the xml
description: e.g.
http://lists.freedesktop.org/archives/xcb/2007-January/002534.html
http://lists.freedesktop.org/archives/xcb/2006-November/002400.html
All of X is documented already in the description of the core protocol
and its extension descriptions. E.g.
http://rfc.net/rfc1013.html
http://keithp.com/~keithp/render/protocol.html
It's just the format that is very inaccessible. If, somehow, these
descriptions could get a little extra markup [1], it would be
possible to merge the names from xcb to the fitting description.
Now the extensions have been written by different persons in very
different times, so they lack a uniform format. Maybe it would be
nice to convert all the protocol descriptions into a uniform format
(and adding that little bit of extra markup).
This has the advantage of a single canonical copy of the
documentation. It would also leave the protocol description
uncluttered.
What do you think?
Tom
[1] something like "this is a request", "this is an error", etc.
basically a tag for each possible xml-node
(xidtype, request, etc.)
More information about the Xcb
mailing list