1 Release 1.8.1 (2012-03-09)
2 ==========================
3 - Fix a busy loop on BSD and Mac OS
4 - Bump xcb-proto requirement
5 - Fallback to TCP if no protocol is specified and the UNIX connection fails
6 - Update use of error_connection under WIN32 to _xcb_conn_ret_error()
7 - Fix build of xcb_auth.c with XDMCP on WIN32
8 - Revert "Fix include order with Xdmcp on WIN32"
9 - darwin: Use read(2) rather than recv(2)
10 - Add xkb_internals and xkb_issues to EXTRA_DIST.
12 Release 1.8 (2012-01-11)
13 ========================
14 - xcb_disconnect: call shutdown() to force a disconnect
15 - Use special path to sockets when running under Solaris Trusted Extensions
16 - Remove unused DECnet code
17 - Add #include <sys/socket.h> to xcb_conn.c
18 - Make launchd code in xcb_util.c match surrounding code indent levels
19 - If protocol is "unix", use a Unix domain socket, not TCP
20 - Added more error states and removed global error_connection
21 - Handle XGE events with the "send event" flag
22 - added xcb_sumof() with restriction to uint8_t
23 - xkb: updated configure.ac/Makefile.am
24 - xkb: added pkg config file
25 - special case 'intermixed variable and fixed size fields': fixed reply side, needs testing
26 - added accessors for special cases
27 - Add support for building with Python 3
28 - Insert, not append explicit xcbgen dir python path
29 - xcb_request_check: Sync even if an event was read for this sequence.
30 - _xcb_conn_wait: Shut down the connection on unexpected poll() events.
31 - xcb_send_request: Send all requests using a common internal send_request.
32 - xcb_request_check: Hold the I/O lock while deciding to sync.
33 - xcb_discard_reply: Simplify by re-using poll_for_reply helper.
34 - xcb_in: Use 64-bit sequence numbers internally everywhere.
35 - Enable AM_SILENT_RULES on automake 1.11 or newer.
36 - Factor reader_list management out of wait_for_reply.
37 - Dequeue readers that can't receive any new responses.
38 - Delete the old c-client.xsl.
39 - Keep ALIGNOF definition out of the public namespace.
40 - darwin: Don't use poll() when expected to run on darwin10 and prior
42 - Allow disconnecting connections that are in error state.
43 - Make xcb_take_socket keep flushing until idle
44 - Support pre-IPv6 systems (without getaddrinfo)
45 - Drop AI_ADDRCONFIG when resolving TCP addresses
46 - xcb_auth: Fix memory leak in _xcb_get_auth_info.
47 - Don't emit out-of-module sizeof definitions
48 - Clean up a couple of warnings in xprint
49 - Prevent reply waiters from being blocked.
50 - Prevent theoretical double free and leak on get_peer_sock_name.
51 - Introduce a variant of xcb_poll_for_event for examining event queue.
52 - xcb_take_socket: Document sequence wrap requirements
53 - Compute alignment correctly
54 - Fix a dead-lock due to xcb_poll_for_reply
56 Release 1.7 (2010-08-13)
57 ========================
58 - Always wake up readers after writing
59 - Get rid of PATH_MAX and MAXPATHLEN
60 - Add ~ operator support in code generator
61 - xcb_open: Improve protocol/host parsing
62 - xcb_connect_to_display_with_auth_info: Fix memory leak
63 - Report which extensions are being built
65 Release 1.6 (2010-04-09)
66 ========================
67 - darwin: xnu doesn't support poll on ttys on the master side
68 - Fix descriptor leak on memory error path
69 - Support xcb_discard_reply
70 - Open the X11 socket with close-on-exec flag
71 - Fix authentication on hpux and Hurd
73 Release 1.5 (2009-12-03)
74 ========================
75 - setsockopt(SO_KEEPALIVE) on TCP display connections
77 - Fix check dependency
78 - Cygwin build fix: Add -no-undefined to libtool flags
80 Release 1.4 (2009-07-15)
81 ========================
82 * Add majorCode, minorCode and resourceID fields to X generic error
83 * Fix precedence bug: wrong length for big-requests preceded by sync
84 * Fix libxcb-randr version info
86 Release 1.3 (2009-05-29)
87 ========================
88 * Copy full IPv4 mapping (Bug #20665)
90 * Use poll() instead of select() when available
91 * Fix local socket connection on Hurd
92 * Fix XDM-AUTHORIZATION-1
93 * Disable Nagle on TCP socket
95 Release 1.2 (2009-02-17)
96 ========================
97 * Stop packaging auto-generated C files into tarball.
99 Release 1.1.93 (2008-12-11)
100 ===========================
102 * Apple: Enable support for launchd DISPLAY socket
103 * Treat XIDs the same as other cardinal values.
105 Release 1.1.92 (2008-11-01)
106 ===========================
108 * Added small fix to support trailing fixed fields; also warning for non-pad fixed fields
109 * Fixed overly aggressive warning about fixed field following variable
110 * Added generation of extern "C" for compatibility with C++
111 * Remove libxcb-xlib and xcbxlib.h.
112 * Inline _xcb_lock_io, _xcb_unlock_io, and _xcb_wait_io.
113 * Track 64-bit sequence numbers internally.
114 * Use sequence number ranges in pending replies
115 * Remove duplicate XCB_EXTENSION calls for Composite extension
116 * Factorize m4 macros and add one to set X extensions
117 * Allow compile-time setting for XCB queue buffer size
118 * Support handing off socket write permission to external code.
119 * Add support for the abstract socket namespace under Linux
122 * Fix tiny memory leak in read_packet
123 * Fix some fd leaks in _xcb_open_*()
125 Release 1.1 (2007-11-04)
126 ========================
128 This release requires xcb-proto 1.1, due to the addition of the
129 extension-multiword attribute to the XML schema.
131 This release contains several important bug fixes, summarized below. It
132 also contains a patch much like Novell's libxcb-sloppy-lock.diff.
133 Rationale from the commit message follows. The patch and this rationale
134 were authored by Jamey Sharp <jamey@minilop.net>, with agreement from
135 Josh Triplett <josh@freedesktop.org>.
137 I strongly opposed proposals like this one for a long time.
138 Originally I had a very good reason: libX11, when compiled to use
139 XCB, would crash soon after a locking correctness violation, so it
140 was better to have an informative assert failure than a mystifying
143 It took some time for me to realize that I'd changed the libX11
144 implementation (for unrelated reasons) so that it could survive most
145 invalid locking situations, as long as it wasn't actually being used
146 from multiple threads concurrently.
148 The other thing that has changed is that most of the code with
149 incorrect locking has now been fixed. The value of the assert is
152 However, remaining broken callers do need to be fixed. That's why
153 libXCB will still noisily print a stacktrace (if possible) on each
154 assertion failure, even when assert isn't actually invoked to
155 abort() the program; and that's why aborting is still default. This
156 environment variable is provided only for use as a temporary
157 workaround for broken applications.
160 * Print a backtrace, if possible, on locking assertion failures.
161 * Skip abort() on locking assertions if LIBXCB_ALLOW_SLOPPY_LOCK is set.
162 * xcb_poll_for_event: Return already-read events before reading again.
163 * Output a configuration summary at the end of ./configure.
166 * Don't hold the xlib-xcb lock while sleeping: that allows deadlock.
167 * Allow unix:<screen> style display names again.
168 * Bug #9119: test xcb_popcount
169 * Fix unit tests for FreeBSD
170 * NetBSD doesn't have AI_ADDRCONFIG: use it only if it's available.
171 * Require libXau >= 0.99.2; earlier versions have a broken .pc file
172 * Use substitition variables in xcb-xinerama.pc.in
173 * Update autogen.sh to one that does objdir != srcdir
174 * Add tools/* and autogen.sh to EXTRA_DIST.
175 * Doxygen can now be fully disabled if desired.
177 Documentation improvements:
178 * Many fixes and updates to the tutorial.
179 * Iterators, requests, and replies get partial Doxygen documentation.
182 Release 1.0 (2006-11-23)
183 ========================
185 The "Thanksgiving" release: We feel thankful to have it released. Five years
186 have passed since XCB's initial commit on September 3rd, 2001:
187 <http://gitweb.freedesktop.org/?p=xcb.git;a=commit;h=09e54c4a3c>
189 * Support IPv6. XCB now supports displays with IPv6 addresses, with or without
190 enclosing square brackets, or with hosts which resolve to IPv6 addresses, by
191 using getaddrinfo instead of gethostbyname, and by including support for
192 authentication for such connections. This allows such displays as "::1:1.1".
194 * XCB now uses the libpthread-stubs, to properly support optional use of
195 pthreads even on platforms which do not have all the necessary pthread stubs
196 in libc or otherwise available by default.
198 * Switch from the old AM_PATH_CHECK macro to pkg-config. check 0.9.4 is now
199 required to build XCB's unit tests. The version that we were requiring was
200 not actually new enough to let our unit tests compile, and the AM_PATH_CHECK
201 macro is now considered deprecated. We know that versions of check using
202 pkg-config are new enough to work, and the check dependency was optional
203 anyway, so we've dropped support for older versions.
205 * Provide a xcb_prefetch_maximum_request_length counterpart to
206 xcb_get_maximum_request_length.
208 * Fix Bug #5958: zero out padding bytes in requests.
210 * Change xcb_connect to pass the display number to _xcb_get_auth_info, which
211 passes it to get_authptr. This allows get_authptr to stop hacking the
212 display number out of the sockaddrs of various address families, such as
213 port - X_TCP_PORT, or the number after the last X in the UNIX socket path.
215 * Remove --with-opt and --with-debug options from configure.ac; configure
216 supports the use of custom CFLAGS, so please use that instead.
218 * Reove support for the <localfield> tag in protocol descriptions, since they
219 no longer use it, and since new protocol descriptions should not need it
222 * xcb-proto has no libraries or headers, so don't use XCBPROTO_CFLAGS or
225 * XCB builds which use xdmcp now include it in Requires.private, to support
228 * Replace "long" with uint32_t when used for a 32-bit quantity
230 * Various enhancements to the generation of documentation with Doxygen:
231 * Check for doxygen in configure.ac
232 * Fix some Doxygen warnings.
233 * Install documentation.
234 * Handle out-of-tree builds, with srcdir != builddir. xcb.doxygen now gets
235 generated from xcb.doxygen.in, so that it can use top_builddir and
236 top_srcdir to find source and to output documentation.
237 * Fill in PROJECT_NUMBER from @VERSION@, now that we have it readily
238 available via autoconf.
241 Release 1.0 RC3 (2006-11-02)
242 ============================
244 Note: Version 0.9.4 of the test suite tool "check" provides a broken
245 version of the AM_PATH_CHECK macro, which causes autoconf to fail due to
246 insufficient quoting on the macro names it prints in its deprecation
247 message. We have written a patch to fix this problem, available at:
248 <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>
249 Version 0.9.4-2 of the Debian package for check includes this patch.
250 Users of other distributions who want to re-autotool libxcb will need to
251 apply this patch, use an older version of check, or wait for a fixed
252 upstream version. This bug does not affect users who use the distributed
253 tarballs and do not re-autotool.
255 * Add library support for xcb-xinerama, using new protocol description
257 * In the generated protocol code, define and use constants for opcode
258 numbers rather than hard-coding them.
259 * In the API conversion script, match only XCB-namespaced XID generators
260 when converting to xcb_generate_id.
261 * Quit treating xproto specially in Makefile.am: handle it like all the
263 * Generate Doxygen documentation comments in the protocol stubs, and
264 provide a Doxygen config file for building HTML documentation for XCB.
265 * Add note to xcbxlib.h that nothing except Xlib/XCB should use it.
266 * Extend test suite to test xcb_parse_display with NULL argument and
270 Release 1.0 RC2 (2006-10-07)
271 ============================
276 In our announcement of XCB 1.0 RC1, we proposed two API changes for
279 We would greatly appreciate API review in this final release
280 candidate period. We've had some limited feedback that our attempts
281 to impose static type safety on XIDs in C pose more a hindrance than
282 a help, so we would appreciate discussion over whether this
283 constitutes a "serious issue with the API". Some question also
284 remains of whether xcb_poll_for_event should have the out-parameter
285 'error', now that XCB has a more uniform mechanism for reporting
286 connection errors. Speak now on these points or leave us alone. ;-)
288 Since we've received feedback agreeing with our proposed changes, and no
289 objections or requests to keep the existing API, we made both changes
290 and bumped the soname to libxcb.so.1.0.0 in preparation for the release
293 * Remove XID wrapper structures and replace them with uint32_t typedefs.
294 XID union types like xcb_drawable_t and xcb_fontable_t also become
295 uint32_t typedefs. The API conversion script now replaces xcb_*_new
296 with calls directly to xcb_generate_id. This change makes
297 xcb_generate_id part of the client API rather than the extension API,
298 so move xcb_generate_id from xcbext.h to xcb.h.
300 * Remove the 'int *error' out-parameter for xcb_poll_for_event.
301 xcb_poll_for_event now shuts down the xcb_connection_t on fatal
302 errors; use xcb_connection_has_error to check.
304 The Xlib-specific API in libxcb-xlib also changed:
306 * Stop exposing the XCB IO lock for Xlib's benefit, by removing
307 xcb_get_io_lock from the Xlib-specific XCB API; instead, libxcb-xlib
308 now provides xcb_xlib_lock and xcb_xlib_unlock.
310 Code generation changes
311 -----------------------
313 * The code generator no longer implicitly imports xproto for extensions.
314 xcb-proto 1.0 RC2 includes the corresponding change to explicitly
315 import xproto in extensions that need it
317 * The generated protocol headers now declare "struct foo", "union foo"
318 or "enum foo", not just the typedef "foo" of an unnamed
319 struct/union/enum type.
324 * Make Plan 7 'checked' requests work correctly.
326 Documentation improvements
327 --------------------------
329 * Document xcb_generate_id.
331 * Tutorial enhancements.
334 Release 1.0 RC1 (2006-09-25)
335 ============================
337 The Great XCB Renaming
338 ----------------------
340 Rename API to follow a new naming convention:
342 * XCB_CONSTANTS_UPPERCASE_WITH_UNDERSCORES
343 * xcb_functions_lowercase_with_underscores
344 * xcb_types_lowercase_with_underscores_and_suffix_t
345 * expand all abbreviations like "req", "rep", and "iter"
347 Word boundaries for the names in the protocol descriptions fall:
349 * Wherever the protocol descriptions already have an underscore
350 * Between a lowercase letter and a subsequent uppercase letter
351 * Before the last uppercase letter in a string of uppercase letters
352 followed by a lowercase letter (such as in LSBFirst between LSB and
354 * Before and after a string of digits (with exceptions for sized types
355 like xcb_char2b_t and xcb_glx_float32_t to match the stdint.h
358 Also fix up some particular naming issues:
360 * Rename shape_op and shape_kind to drop the "shape_" prefix, since
361 otherwise these types end up as xcb_shape_shape_{op,kind}_t.
362 * Remove leading underscores from enums in the GLX protocol description,
363 previously needed to ensure a word separator, but now redundant.
365 This renaming breaks code written for the previous API naming
366 convention. The scripts in XCB's tools directory will convert code
367 written for the old API to use the new API; they work well enough that
368 we used them to convert the non-program-generated code in XCB, and when
369 run on the old program-generated code, they almost exactly reproduce the
370 new program-generated code (modulo whitespace and bugs in the old code
373 Authors: Vincent Torri, Thomas Hunger, Josh Triplett
375 In addition to the API renaming, the library SONAMEs have changed to
376 libxcb.so and libxcb-extname.so. The library major version remains at 0,
377 to become version 1 before 1.0 is released; the SONAME lowercasing means
378 that this will not conflict with XCB 0.9 libraries.
380 The header files have moved from /usr/include/X11/XCB/ to
381 /usr/include/xcb/. The XML-XCB protocol descriptions have moved to
382 /usr/share/xcb, with extension descriptions no longer relegated to an
383 extensions/ subdirectory. The API conversion script api_conv.pl will fix
384 references to the header files, and packages using pkg-config will
385 automatically use the new library names.
387 Error handling Plan 7
388 ---------------------
390 All request functions now come in an "unchecked" and "checked" variant.
391 The checked variant allows callers to handle errors inline where they
392 obtain the reply, or by calling xcb_request_check for requests with no
393 reply. The unchecked variant uses the event queue for errors. Requests
394 with replies default to checked, because the caller must already make a
395 function call to retrieve the reply and can see the error at that time;
396 the unchecked variant uses the suffix _unchecked. Requests without
397 replies default to unchecked, because the caller will not necessarily
398 expect to handle a response, and the checked variant uses the suffix
401 Connection error handling
402 -------------------------
404 Fatal connection errors now put the xcb_connection_t object into an
405 error state, at which point all further operations on that connection
406 will fail. Callers can use the new xcb_connection_has_error function to
407 check for this state in a connection. Functions that return a
408 connection, such as the xcb_connect function, may instead return an
409 xcb_connection_t already in an error state.
411 In the future we expect to add additional API for getting more
412 information about the error condition that caused the connection to get
418 All functions that have been marked 'deprecated' up to now have been
419 removed for this release. After XCB 1.0 is released, functions marked
420 'deprecated' will be preserved until the end of time to maintain
423 XCB no longer provides a sync function. Most callers of this function
424 should use xcb_flush instead, which usually provides the intended
425 functionality and does not require a round-trip to the server. If you
426 really need this functionality, either use xcb_get_input_focus like sync
427 used to do, or use the xcb_aux_sync function from the xcb-aux library in
428 xcb-util. However, note that we do not consider the libraries in
429 xcb-util remotely stable yet.
431 XCB no longer provides xcb_[extension_name]_init functions for each
432 extension. These functions previously caused XCB to issue and process a
433 QueryExtension request. Callers should now directly call
434 xcb_get_extension_data on the xcb_[extension_name]_id, or use
435 xcb_prefetch_extension_data if they do not need to force a round-trip
438 The compatibility functions in xcbxlib.h, provided solely for use by
439 Xlib/XCB, now exist in a separate library libxcb-xlib. We don't want to
440 have to change the libxcb soname if we later change or remove the Xlib
441 compatibility functions, and nothing except Xlib/XCB should ever use
442 them. (Applications which use Xlib/XCB do not need this library either;
443 Xlib/XCB only uses it internally.)
445 The descriptions of several extensions have been updated to match the
446 latest versions implemented in the X.org X server.
451 Previously, several XCB-related projects all existed under the umbrella
452 of a single monolithic GIT repository with per-project subdirectories.
453 We have split this repository into individual per-project repositories.
455 Josh Triplett and Jamey Sharp wrote a tool called git-split to
456 accomplish this repository split. git-split reconstructs the history of
457 a sub-project previously stored in a subdirectory of a larger
458 repository. It constructs new commit objects based on the existing tree
459 objects for the subtree in each commit, and discards commits which do
460 not affect the history of the sub-project, as well as merges made
461 unnecessary due to these discarded commits.
463 We would like to acknowledge the work of the gobby team in creating a
464 collaborative editor which greatly aided the development of git-split
465 (as well as these release notes).
467 Build and implementation fixes
468 ------------------------------
470 XCB no longer needs proto/x11 from X.org; the XCB header xproto.h
471 provides the definitions from X.h, named according to XCB conventions.
473 XCB should now build with non-GNU implementations of Make.
475 XCB properly handles 32-bit wrap of sequence numbers, and thus now
476 supports issuing more than 2**32 requests in one connection.
478 Fixed bugs #7001, #7261.