1 Release 1.2 (2009-02-17)
2 ========================
3 * Stop packaging auto-generated C files into tarball.
5 Release 1.1.93 (2008-12-11)
6 ===========================
8 * Apple: Enable support for launchd DISPLAY socket
9 * Treat XIDs the same as other cardinal values.
11 Release 1.1.92 (2008-11-01)
12 ===========================
14 * Added small fix to support trailing fixed fields; also warning for non-pad fixed fields
15 * Fixed overly aggressive warning about fixed field following variable
16 * Added generation of extern "C" for compatibility with C++
17 * Remove libxcb-xlib and xcbxlib.h.
18 * Inline _xcb_lock_io, _xcb_unlock_io, and _xcb_wait_io.
19 * Track 64-bit sequence numbers internally.
20 * Use sequence number ranges in pending replies
21 * Remove duplicate XCB_EXTENSION calls for Composite extension
22 * Factorize m4 macros and add one to set X extensions
23 * Allow compile-time setting for XCB queue buffer size
24 * Support handing off socket write permission to external code.
25 * Add support for the abstract socket namespace under Linux
28 * Fix tiny memory leak in read_packet
29 * Fix some fd leaks in _xcb_open_*()
31 Release 1.1 (2007-11-04)
32 ========================
34 This release requires xcb-proto 1.1, due to the addition of the
35 extension-multiword attribute to the XML schema.
37 This release contains several important bug fixes, summarized below. It
38 also contains a patch much like Novell's libxcb-sloppy-lock.diff.
39 Rationale from the commit message follows. The patch and this rationale
40 were authored by Jamey Sharp <jamey@minilop.net>, with agreement from
41 Josh Triplett <josh@freedesktop.org>.
43 I strongly opposed proposals like this one for a long time.
44 Originally I had a very good reason: libX11, when compiled to use
45 XCB, would crash soon after a locking correctness violation, so it
46 was better to have an informative assert failure than a mystifying
49 It took some time for me to realize that I'd changed the libX11
50 implementation (for unrelated reasons) so that it could survive most
51 invalid locking situations, as long as it wasn't actually being used
52 from multiple threads concurrently.
54 The other thing that has changed is that most of the code with
55 incorrect locking has now been fixed. The value of the assert is
58 However, remaining broken callers do need to be fixed. That's why
59 libXCB will still noisily print a stacktrace (if possible) on each
60 assertion failure, even when assert isn't actually invoked to
61 abort() the program; and that's why aborting is still default. This
62 environment variable is provided only for use as a temporary
63 workaround for broken applications.
66 * Print a backtrace, if possible, on locking assertion failures.
67 * Skip abort() on locking assertions if LIBXCB_ALLOW_SLOPPY_LOCK is set.
68 * xcb_poll_for_event: Return already-read events before reading again.
69 * Output a configuration summary at the end of ./configure.
72 * Don't hold the xlib-xcb lock while sleeping: that allows deadlock.
73 * Allow unix:<screen> style display names again.
74 * Bug #9119: test xcb_popcount
75 * Fix unit tests for FreeBSD
76 * NetBSD doesn't have AI_ADDRCONFIG: use it only if it's available.
77 * Require libXau >= 0.99.2; earlier versions have a broken .pc file
78 * Use substitition variables in xcb-xinerama.pc.in
79 * Update autogen.sh to one that does objdir != srcdir
80 * Add tools/* and autogen.sh to EXTRA_DIST.
81 * Doxygen can now be fully disabled if desired.
83 Documentation improvements:
84 * Many fixes and updates to the tutorial.
85 * Iterators, requests, and replies get partial Doxygen documentation.
88 Release 1.0 (2006-11-23)
89 ========================
91 The "Thanksgiving" release: We feel thankful to have it released. Five years
92 have passed since XCB's initial commit on September 3rd, 2001:
93 <http://gitweb.freedesktop.org/?p=xcb.git;a=commit;h=09e54c4a3c>
95 * Support IPv6. XCB now supports displays with IPv6 addresses, with or without
96 enclosing square brackets, or with hosts which resolve to IPv6 addresses, by
97 using getaddrinfo instead of gethostbyname, and by including support for
98 authentication for such connections. This allows such displays as "::1:1.1".
100 * XCB now uses the libpthread-stubs, to properly support optional use of
101 pthreads even on platforms which do not have all the necessary pthread stubs
102 in libc or otherwise available by default.
104 * Switch from the old AM_PATH_CHECK macro to pkg-config. check 0.9.4 is now
105 required to build XCB's unit tests. The version that we were requiring was
106 not actually new enough to let our unit tests compile, and the AM_PATH_CHECK
107 macro is now considered deprecated. We know that versions of check using
108 pkg-config are new enough to work, and the check dependency was optional
109 anyway, so we've dropped support for older versions.
111 * Provide a xcb_prefetch_maximum_request_length counterpart to
112 xcb_get_maximum_request_length.
114 * Fix Bug #5958: zero out padding bytes in requests.
116 * Change xcb_connect to pass the display number to _xcb_get_auth_info, which
117 passes it to get_authptr. This allows get_authptr to stop hacking the
118 display number out of the sockaddrs of various address families, such as
119 port - X_TCP_PORT, or the number after the last X in the UNIX socket path.
121 * Remove --with-opt and --with-debug options from configure.ac; configure
122 supports the use of custom CFLAGS, so please use that instead.
124 * Reove support for the <localfield> tag in protocol descriptions, since they
125 no longer use it, and since new protocol descriptions should not need it
128 * xcb-proto has no libraries or headers, so don't use XCBPROTO_CFLAGS or
131 * XCB builds which use xdmcp now include it in Requires.private, to support
134 * Replace "long" with uint32_t when used for a 32-bit quantity
136 * Various enhancements to the generation of documentation with Doxygen:
137 * Check for doxygen in configure.ac
138 * Fix some Doxygen warnings.
139 * Install documentation.
140 * Handle out-of-tree builds, with srcdir != builddir. xcb.doxygen now gets
141 generated from xcb.doxygen.in, so that it can use top_builddir and
142 top_srcdir to find source and to output documentation.
143 * Fill in PROJECT_NUMBER from @VERSION@, now that we have it readily
144 available via autoconf.
147 Release 1.0 RC3 (2006-11-02)
148 ============================
150 Note: Version 0.9.4 of the test suite tool "check" provides a broken
151 version of the AM_PATH_CHECK macro, which causes autoconf to fail due to
152 insufficient quoting on the macro names it prints in its deprecation
153 message. We have written a patch to fix this problem, available at:
154 <http://bugs.debian.org/cgi-bin/bugreport.cgi/check-m4-am-path-check-use-quadrigraphs-in-macro-names-to-unbreak-autoconf.patch?bug=395466;msg=20;att=1>
155 Version 0.9.4-2 of the Debian package for check includes this patch.
156 Users of other distributions who want to re-autotool libxcb will need to
157 apply this patch, use an older version of check, or wait for a fixed
158 upstream version. This bug does not affect users who use the distributed
159 tarballs and do not re-autotool.
161 * Add library support for xcb-xinerama, using new protocol description
163 * In the generated protocol code, define and use constants for opcode
164 numbers rather than hard-coding them.
165 * In the API conversion script, match only XCB-namespaced XID generators
166 when converting to xcb_generate_id.
167 * Quit treating xproto specially in Makefile.am: handle it like all the
169 * Generate Doxygen documentation comments in the protocol stubs, and
170 provide a Doxygen config file for building HTML documentation for XCB.
171 * Add note to xcbxlib.h that nothing except Xlib/XCB should use it.
172 * Extend test suite to test xcb_parse_display with NULL argument and
176 Release 1.0 RC2 (2006-10-07)
177 ============================
182 In our announcement of XCB 1.0 RC1, we proposed two API changes for
185 We would greatly appreciate API review in this final release
186 candidate period. We've had some limited feedback that our attempts
187 to impose static type safety on XIDs in C pose more a hindrance than
188 a help, so we would appreciate discussion over whether this
189 constitutes a "serious issue with the API". Some question also
190 remains of whether xcb_poll_for_event should have the out-parameter
191 'error', now that XCB has a more uniform mechanism for reporting
192 connection errors. Speak now on these points or leave us alone. ;-)
194 Since we've received feedback agreeing with our proposed changes, and no
195 objections or requests to keep the existing API, we made both changes
196 and bumped the soname to libxcb.so.1.0.0 in preparation for the release
199 * Remove XID wrapper structures and replace them with uint32_t typedefs.
200 XID union types like xcb_drawable_t and xcb_fontable_t also become
201 uint32_t typedefs. The API conversion script now replaces xcb_*_new
202 with calls directly to xcb_generate_id. This change makes
203 xcb_generate_id part of the client API rather than the extension API,
204 so move xcb_generate_id from xcbext.h to xcb.h.
206 * Remove the 'int *error' out-parameter for xcb_poll_for_event.
207 xcb_poll_for_event now shuts down the xcb_connection_t on fatal
208 errors; use xcb_connection_has_error to check.
210 The Xlib-specific API in libxcb-xlib also changed:
212 * Stop exposing the XCB IO lock for Xlib's benefit, by removing
213 xcb_get_io_lock from the Xlib-specific XCB API; instead, libxcb-xlib
214 now provides xcb_xlib_lock and xcb_xlib_unlock.
216 Code generation changes
217 -----------------------
219 * The code generator no longer implicitly imports xproto for extensions.
220 xcb-proto 1.0 RC2 includes the corresponding change to explicitly
221 import xproto in extensions that need it
223 * The generated protocol headers now declare "struct foo", "union foo"
224 or "enum foo", not just the typedef "foo" of an unnamed
225 struct/union/enum type.
230 * Make Plan 7 'checked' requests work correctly.
232 Documentation improvements
233 --------------------------
235 * Document xcb_generate_id.
237 * Tutorial enhancements.
240 Release 1.0 RC1 (2006-09-25)
241 ============================
243 The Great XCB Renaming
244 ----------------------
246 Rename API to follow a new naming convention:
248 * XCB_CONSTANTS_UPPERCASE_WITH_UNDERSCORES
249 * xcb_functions_lowercase_with_underscores
250 * xcb_types_lowercase_with_underscores_and_suffix_t
251 * expand all abbreviations like "req", "rep", and "iter"
253 Word boundaries for the names in the protocol descriptions fall:
255 * Wherever the protocol descriptions already have an underscore
256 * Between a lowercase letter and a subsequent uppercase letter
257 * Before the last uppercase letter in a string of uppercase letters
258 followed by a lowercase letter (such as in LSBFirst between LSB and
260 * Before and after a string of digits (with exceptions for sized types
261 like xcb_char2b_t and xcb_glx_float32_t to match the stdint.h
264 Also fix up some particular naming issues:
266 * Rename shape_op and shape_kind to drop the "shape_" prefix, since
267 otherwise these types end up as xcb_shape_shape_{op,kind}_t.
268 * Remove leading underscores from enums in the GLX protocol description,
269 previously needed to ensure a word separator, but now redundant.
271 This renaming breaks code written for the previous API naming
272 convention. The scripts in XCB's tools directory will convert code
273 written for the old API to use the new API; they work well enough that
274 we used them to convert the non-program-generated code in XCB, and when
275 run on the old program-generated code, they almost exactly reproduce the
276 new program-generated code (modulo whitespace and bugs in the old code
279 Authors: Vincent Torri, Thomas Hunger, Josh Triplett
281 In addition to the API renaming, the library SONAMEs have changed to
282 libxcb.so and libxcb-extname.so. The library major version remains at 0,
283 to become version 1 before 1.0 is released; the SONAME lowercasing means
284 that this will not conflict with XCB 0.9 libraries.
286 The header files have moved from /usr/include/X11/XCB/ to
287 /usr/include/xcb/. The XML-XCB protocol descriptions have moved to
288 /usr/share/xcb, with extension descriptions no longer relegated to an
289 extensions/ subdirectory. The API conversion script api_conv.pl will fix
290 references to the header files, and packages using pkg-config will
291 automatically use the new library names.
293 Error handling Plan 7
294 ---------------------
296 All request functions now come in an "unchecked" and "checked" variant.
297 The checked variant allows callers to handle errors inline where they
298 obtain the reply, or by calling xcb_request_check for requests with no
299 reply. The unchecked variant uses the event queue for errors. Requests
300 with replies default to checked, because the caller must already make a
301 function call to retrieve the reply and can see the error at that time;
302 the unchecked variant uses the suffix _unchecked. Requests without
303 replies default to unchecked, because the caller will not necessarily
304 expect to handle a response, and the checked variant uses the suffix
307 Connection error handling
308 -------------------------
310 Fatal connection errors now put the xcb_connection_t object into an
311 error state, at which point all further operations on that connection
312 will fail. Callers can use the new xcb_connection_has_error function to
313 check for this state in a connection. Functions that return a
314 connection, such as the xcb_connect function, may instead return an
315 xcb_connection_t already in an error state.
317 In the future we expect to add additional API for getting more
318 information about the error condition that caused the connection to get
324 All functions that have been marked 'deprecated' up to now have been
325 removed for this release. After XCB 1.0 is released, functions marked
326 'deprecated' will be preserved until the end of time to maintain
329 XCB no longer provides a sync function. Most callers of this function
330 should use xcb_flush instead, which usually provides the intended
331 functionality and does not require a round-trip to the server. If you
332 really need this functionality, either use xcb_get_input_focus like sync
333 used to do, or use the xcb_aux_sync function from the xcb-aux library in
334 xcb-util. However, note that we do not consider the libraries in
335 xcb-util remotely stable yet.
337 XCB no longer provides xcb_[extension_name]_init functions for each
338 extension. These functions previously caused XCB to issue and process a
339 QueryExtension request. Callers should now directly call
340 xcb_get_extension_data on the xcb_[extension_name]_id, or use
341 xcb_prefetch_extension_data if they do not need to force a round-trip
344 The compatibility functions in xcbxlib.h, provided solely for use by
345 Xlib/XCB, now exist in a separate library libxcb-xlib. We don't want to
346 have to change the libxcb soname if we later change or remove the Xlib
347 compatibility functions, and nothing except Xlib/XCB should ever use
348 them. (Applications which use Xlib/XCB do not need this library either;
349 Xlib/XCB only uses it internally.)
351 The descriptions of several extensions have been updated to match the
352 latest versions implemented in the X.org X server.
357 Previously, several XCB-related projects all existed under the umbrella
358 of a single monolithic GIT repository with per-project subdirectories.
359 We have split this repository into individual per-project repositories.
361 Josh Triplett and Jamey Sharp wrote a tool called git-split to
362 accomplish this repository split. git-split reconstructs the history of
363 a sub-project previously stored in a subdirectory of a larger
364 repository. It constructs new commit objects based on the existing tree
365 objects for the subtree in each commit, and discards commits which do
366 not affect the history of the sub-project, as well as merges made
367 unnecessary due to these discarded commits.
369 We would like to acknowledge the work of the gobby team in creating a
370 collaborative editor which greatly aided the development of git-split
371 (as well as these release notes).
373 Build and implementation fixes
374 ------------------------------
376 XCB no longer needs proto/x11 from X.org; the XCB header xproto.h
377 provides the definitions from X.h, named according to XCB conventions.
379 XCB should now build with non-GNU implementations of Make.
381 XCB properly handles 32-bit wrap of sequence numbers, and thus now
382 supports issuing more than 2**32 requests in one connection.
384 Fixed bugs #7001, #7261.