Bug 29655 - Expand on API docs
Summary: Expand on API docs
Status: NEW
Alias: None
Product: XCB
Classification: Unclassified
Component: Library (show other bugs)
Version: unspecified
Hardware: All All
: medium normal
Assignee: xcb mailing list dummy
QA Contact: xcb mailing list dummy
URL:
Whiteboard:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2010-08-18 13:54 UTC by Havoc Pennington
Modified: 2012-01-11 09:34 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments
more docs! (23.36 KB, patch)
2010-08-18 13:54 UTC, Havoc Pennington
Details | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Havoc Pennington 2010-08-18 13:54:32 UTC
Created attachment 37965 [details] [review]
more docs!

This patch adds quite a bit more detail to the API documentation.

It assumes the small docs patch in bug 29599 has been applied.

There are probably some mistakes in here, but hopefully someone more "in the know" can fix those.

I think it's useful to give a lot more detail about what blocks and what doesn't, how buffering and flushing works, and even spell out some basic info about the X protocol. So I tried to put that kind of thing in here.

I copied a few lines of xcbext.h docs from the wiki, but mostly had to write new docs for it.

These docs could probably still use more info about how to use XCB with threads, 
but I haven't sat down and tried to work that out, so I didn't document it.
Comment 1 Julien Danjou 2012-01-11 09:10:35 UTC
Patch does not apply anymore unfortunately.
Comment 2 Peter Harris 2012-01-11 09:34:52 UTC
Also, when you rebase the patch, could you please add a note to xcb_send_request that vector has to have two empty slots before the beginning (ie. vector[-1] and vector[-2] must be addressable and writable). libxcb will use one of these slots for internal bookkeeping, and the other of those slots to fill in the extended request length if the request is big (in the bigreq extension sense).

Thanks.

In terms of threading, it's supposed to Just Work on pthread enabled platforms, nothing special required.


bug/show.html.tmpl processed on Mar 29, 2017 at 11:01:51.
(provided by the Example extension).