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