git.demorecorder.com Git - free-sw/xcb/libxcb/blob - NEWS

   1 Release 1.0 RC3 (2006-11-02)
   2 ============================
   3
   4 Note: Version 0.9.4 of the test suite tool "check" provides a broken
   5 version of the AM_PATH_CHECK macro, which causes autoconf to fail due to
   6 insufficient quoting on the macro names it prints in its deprecation
   7 message. We have written a patch to fix this problem, available at:
   8 <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>
   9 Version 0.9.4-2 of the Debian package for check includes this patch.
  10 Users of other distributions who want to re-autotool libxcb will need to
  11 apply this patch, use an older version of check, or wait for a fixed
  12 upstream version. This bug does not affect users who use the distributed
  13 tarballs and do not re-autotool.
  14
  15 * Add library support for xcb-xinerama, using new protocol description
  16   from xcb-proto.
  17 * In the generated protocol code, define and use constants for opcode
  18   numbers rather than hard-coding them.
  19 * In the API conversion script, match only XCB-namespaced XID generators
  20   when converting to xcb_generate_id.
  21 * Quit treating xproto specially in Makefile.am: handle it like all the
  22   extensions.
  23 * Generate Doxygen documentation comments in the protocol stubs, and
  24   provide a Doxygen config file for building HTML documentation for XCB.
  25 * Add note to xcbxlib.h that nothing except Xlib/XCB should use it.
  26 * Extend test suite to test xcb_parse_display with NULL argument and
  27   display in $DISPLAY.
  28
  29
  30 Release 1.0 RC2 (2006-10-07)
  31 ============================
  32
  33 API changes
  34 -----------
  35
  36 In our announcement of XCB 1.0 RC1, we proposed two API changes for
  37 community feedback:
  38
  39     We would greatly appreciate API review in this final release
  40     candidate period. We've had some limited feedback that our attempts
  41     to impose static type safety on XIDs in C pose more a hindrance than
  42     a help, so we would appreciate discussion over whether this
  43     constitutes a "serious issue with the API". Some question also
  44     remains of whether xcb_poll_for_event should have the out-parameter
  45     'error', now that XCB has a more uniform mechanism for reporting
  46     connection errors. Speak now on these points or leave us alone. ;-)
  47
  48 Since we've received feedback agreeing with our proposed changes, and no
  49 objections or requests to keep the existing API, we made both changes
  50 and bumped the soname to libxcb.so.1.0.0 in preparation for the release
  51 of XCB 1.0.
  52
  53 * Remove XID wrapper structures and replace them with uint32_t typedefs.
  54   XID union types like xcb_drawable_t and xcb_fontable_t also become
  55   uint32_t typedefs. The API conversion script now replaces xcb_*_new
  56   with calls directly to xcb_generate_id.  This change makes
  57   xcb_generate_id part of the client API rather than the extension API,
  58   so move xcb_generate_id from xcbext.h to xcb.h.
  59
  60 * Remove the 'int *error' out-parameter for xcb_poll_for_event.
  61   xcb_poll_for_event now shuts down the xcb_connection_t on fatal
  62   errors; use xcb_connection_has_error to check.
  63
  64 The Xlib-specific API in libxcb-xlib also changed:
  65
  66 * Stop exposing the XCB IO lock for Xlib's benefit, by removing
  67   xcb_get_io_lock from the Xlib-specific XCB API; instead, libxcb-xlib
  68   now provides xcb_xlib_lock and xcb_xlib_unlock.
  69
  70 Code generation changes
  71 -----------------------
  72
  73 * The code generator no longer implicitly imports xproto for extensions.
  74   xcb-proto 1.0 RC2 includes the corresponding change to explicitly
  75   import xproto in extensions that need it
  76
  77 * The generated protocol headers now declare "struct foo", "union foo"
  78   or "enum foo", not just the typedef "foo" of an unnamed
  79   struct/union/enum type.
  80
  81 Bug Fixes
  82 ---------
  83
  84 * Make Plan 7 'checked' requests work correctly.
  85
  86 Documentation improvements
  87 --------------------------
  88
  89 * Document xcb_generate_id.
  90
  91 * Tutorial enhancements.
  92
  93
  94 Release 1.0 RC1 (2006-09-25)
  95 ============================
  96
  97 The Great XCB Renaming
  98 ----------------------
  99
 100 Rename API to follow a new naming convention:
 101
 102 * XCB_CONSTANTS_UPPERCASE_WITH_UNDERSCORES
 103 * xcb_functions_lowercase_with_underscores
 104 * xcb_types_lowercase_with_underscores_and_suffix_t
 105 * expand all abbreviations like "req", "rep", and "iter"
 106
 107 Word boundaries for the names in the protocol descriptions fall:
 108
 109 * Wherever the protocol descriptions already have an underscore
 110 * Between a lowercase letter and a subsequent uppercase letter
 111 * Before the last uppercase letter in a string of uppercase letters
 112   followed by a lowercase letter (such as in LSBFirst between LSB and
 113   First)
 114 * Before and after a string of digits (with exceptions for sized types
 115   like xcb_char2b_t and xcb_glx_float32_t to match the stdint.h
 116   convention)
 117
 118 Also fix up some particular naming issues:
 119
 120 * Rename shape_op and shape_kind to drop the "shape_" prefix, since
 121   otherwise these types end up as xcb_shape_shape_{op,kind}_t.
 122 * Remove leading underscores from enums in the GLX protocol description,
 123   previously needed to ensure a word separator, but now redundant.
 124
 125 This renaming breaks code written for the previous API naming
 126 convention. The scripts in XCB's tools directory will convert code
 127 written for the old API to use the new API; they work well enough that
 128 we used them to convert the non-program-generated code in XCB, and when
 129 run on the old program-generated code, they almost exactly reproduce the
 130 new program-generated code (modulo whitespace and bugs in the old code
 131 generator).
 132
 133 Authors: Vincent Torri, Thomas Hunger, Josh Triplett
 134
 135 In addition to the API renaming, the library SONAMEs have changed to
 136 libxcb.so and libxcb-extname.so. The library major version remains at 0,
 137 to become version 1 before 1.0 is released; the SONAME lowercasing means
 138 that this will not conflict with XCB 0.9 libraries.
 139
 140 The header files have moved from /usr/include/X11/XCB/ to
 141 /usr/include/xcb/. The XML-XCB protocol descriptions have moved to
 142 /usr/share/xcb, with extension descriptions no longer relegated to an
 143 extensions/ subdirectory. The API conversion script api_conv.pl will fix
 144 references to the header files, and packages using pkg-config will
 145 automatically use the new library names.
 146
 147 Error handling Plan 7
 148 ---------------------
 149
 150 All request functions now come in an "unchecked" and "checked" variant.
 151 The checked variant allows callers to handle errors inline where they
 152 obtain the reply, or by calling xcb_request_check for requests with no
 153 reply. The unchecked variant uses the event queue for errors. Requests
 154 with replies default to checked, because the caller must already make a
 155 function call to retrieve the reply and can see the error at that time;
 156 the unchecked variant uses the suffix _unchecked. Requests without
 157 replies default to unchecked, because the caller will not necessarily
 158 expect to handle a response, and the checked variant uses the suffix
 159 _checked.
 160
 161 Connection error handling
 162 -------------------------
 163
 164 Fatal connection errors now put the xcb_connection_t object into an
 165 error state, at which point all further operations on that connection
 166 will fail. Callers can use the new xcb_connection_has_error function to
 167 check for this state in a connection. Functions that return a
 168 connection, such as the xcb_connect function, may instead return an
 169 xcb_connection_t already in an error state.
 170
 171 In the future we expect to add additional API for getting more
 172 information about the error condition that caused the connection to get
 173 into an error state.
 174
 175 Smaller API changes
 176 -------------------
 177
 178 All functions that have been marked 'deprecated' up to now have been
 179 removed for this release. After XCB 1.0 is released, functions marked
 180 'deprecated' will be preserved until the end of time to maintain
 181 compatibility.
 182
 183 XCB no longer provides a sync function. Most callers of this function
 184 should use xcb_flush instead, which usually provides the intended
 185 functionality and does not require a round-trip to the server. If you
 186 really need this functionality, either use xcb_get_input_focus like sync
 187 used to do, or use the xcb_aux_sync function from the xcb-aux library in
 188 xcb-util. However, note that we do not consider the libraries in
 189 xcb-util remotely stable yet.
 190
 191 XCB no longer provides xcb_[extension_name]_init functions for each
 192 extension. These functions previously caused XCB to issue and process a
 193 QueryExtension request. Callers should now directly call
 194 xcb_get_extension_data on the xcb_[extension_name]_id, or use
 195 xcb_prefetch_extension_data if they do not need to force a round-trip
 196 immediately.
 197
 198 The compatibility functions in xcbxlib.h, provided solely for use by
 199 Xlib/XCB, now exist in a separate library libxcb-xlib. We don't want to
 200 have to change the libxcb soname if we later change or remove the Xlib
 201 compatibility functions, and nothing except Xlib/XCB should ever use
 202 them. (Applications which use Xlib/XCB do not need this library either;
 203 Xlib/XCB only uses it internally.)
 204
 205 The descriptions of several extensions have been updated to match the
 206 latest versions implemented in the X.org X server.
 207
 208 GIT Repository split
 209 --------------------
 210
 211 Previously, several XCB-related projects all existed under the umbrella
 212 of a single monolithic GIT repository with per-project subdirectories.
 213 We have split this repository into individual per-project repositories.
 214
 215 Josh Triplett and Jamey Sharp wrote a tool called git-split to
 216 accomplish this repository split. git-split reconstructs the history of
 217 a sub-project previously stored in a subdirectory of a larger
 218 repository. It constructs new commit objects based on the existing tree
 219 objects for the subtree in each commit, and discards commits which do
 220 not affect the history of the sub-project, as well as merges made
 221 unnecessary due to these discarded commits.
 222
 223 We would like to acknowledge the work of the gobby team in creating a
 224 collaborative editor which greatly aided the development of git-split
 225 (as well as these release notes).
 226
 227 Build and implementation fixes
 228 ------------------------------
 229
 230 XCB no longer needs proto/x11 from X.org; the XCB header xproto.h
 231 provides the definitions from X.h, named according to XCB conventions.
 232
 233 XCB should now build with non-GNU implementations of Make.
 234
 235 XCB properly handles 32-bit wrap of sequence numbers, and thus now
 236 supports issuing more than 2**32 requests in one connection.
 237
 238 Fixed bugs #7001, #7261.