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