NEWS

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