[Xcb] documentation patches

Jamey Sharp jamey at minilop.net
Mon Mar 26 10:46:00 PDT 2012


On 3/26/12, Alex Plotnick <shrike at netaxs.com> wrote:
> The
> largest general objection that I have is that the XML protocol
> description is not the right place for language- and API-specific
> documentation. ...
>
> Moreover, we have an excellent and complete description of the X
> protocol: the X protocol specification. I can't see any reason to
> paraphrase or duplicate the spec when we have the authoritative original
> already in a form that, with a little bit of work, could serve the same
> purpose ...

That's certainly where I always imagined the actual documentation text
would come from. In fact I hoped the XCB XML could become the
authoritative source and the protocol specs would be generated from
it.

But I do think it was worth merging the patches as-is so we can
iterate from there. If nothing else, we now have some very nice man
pages on general XCB API usage, which are in libxcb as they should be.
I think just having gotten some documentation infrastructure into
place to play with was worthwhile too.

So: bravo on merging these patches! Let's just not stop there, eh?

Jamey


More information about the Xcb mailing list