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