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