1 Release 1.0 (2006-11-23)
2 ========================
4 The "Thanksgiving" release: We feel thankful to have it released. Five years
5 have passed since XCB's initial commit on September 3rd, 2001:
6 <http://gitweb.freedesktop.org/?p=xcb.git;a=commit;h=09e54c4a3c>
8 * Support IPv6. XCB now supports displays with IPv6 addresses, with or without
9 enclosing square brackets, or with hosts which resolve to IPv6 addresses, by
10 using getaddrinfo instead of gethostbyname, and by including support for
11 authentication for such connections. This allows such displays as "::1:1.1".
13 * XCB now uses the libpthread-stubs, to properly support optional use of
14 pthreads even on platforms which do not have all the necessary pthread stubs
15 in libc or otherwise available by default.
17 * Switch from the old AM_PATH_CHECK macro to pkg-config. check 0.9.4 is now
18 required to build XCB's unit tests. The version that we were requiring was
19 not actually new enough to let our unit tests compile, and the AM_PATH_CHECK
20 macro is now considered deprecated. We know that versions of check using
21 pkg-config are new enough to work, and the check dependency was optional
22 anyway, so we've dropped support for older versions.
24 * Provide a xcb_prefetch_maximum_request_length counterpart to
25 xcb_get_maximum_request_length.
27 * Fix Bug #5958: zero out padding bytes in requests.
29 * Change xcb_connect to pass the display number to _xcb_get_auth_info, which
30 passes it to get_authptr. This allows get_authptr to stop hacking the
31 display number out of the sockaddrs of various address families, such as
32 port - X_TCP_PORT, or the number after the last X in the UNIX socket path.
34 * Remove --with-opt and --with-debug options from configure.ac; configure
35 supports the use of custom CFLAGS, so please use that instead.
37 * Reove support for the <localfield> tag in protocol descriptions, since they
38 no longer use it, and since new protocol descriptions should not need it
41 * xcb-proto has no libraries or headers, so don't use XCBPROTO_CFLAGS or
44 * XCB builds which use xdmcp now include it in Requires.private, to support
47 * Replace "long" with uint32_t when used for a 32-bit quantity
49 * Various enhancements to the generation of documentation with Doxygen:
50 * Check for doxygen in configure.ac
51 * Fix some Doxygen warnings.
52 * Install documentation.
53 * Handle out-of-tree builds, with srcdir != builddir. xcb.doxygen now gets
54 generated from xcb.doxygen.in, so that it can use top_builddir and
55 top_srcdir to find source and to output documentation.
56 * Fill in PROJECT_NUMBER from @VERSION@, now that we have it readily
57 available via autoconf.
60 Release 1.0 RC3 (2006-11-02)
61 ============================
63 Note: Version 0.9.4 of the test suite tool "check" provides a broken
64 version of the AM_PATH_CHECK macro, which causes autoconf to fail due to
65 insufficient quoting on the macro names it prints in its deprecation
66 message. We have written a patch to fix this problem, available at:
67 <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>
68 Version 0.9.4-2 of the Debian package for check includes this patch.
69 Users of other distributions who want to re-autotool libxcb will need to
70 apply this patch, use an older version of check, or wait for a fixed
71 upstream version. This bug does not affect users who use the distributed
72 tarballs and do not re-autotool.
74 * Add library support for xcb-xinerama, using new protocol description
76 * In the generated protocol code, define and use constants for opcode
77 numbers rather than hard-coding them.
78 * In the API conversion script, match only XCB-namespaced XID generators
79 when converting to xcb_generate_id.
80 * Quit treating xproto specially in Makefile.am: handle it like all the
82 * Generate Doxygen documentation comments in the protocol stubs, and
83 provide a Doxygen config file for building HTML documentation for XCB.
84 * Add note to xcbxlib.h that nothing except Xlib/XCB should use it.
85 * Extend test suite to test xcb_parse_display with NULL argument and
89 Release 1.0 RC2 (2006-10-07)
90 ============================
95 In our announcement of XCB 1.0 RC1, we proposed two API changes for
98 We would greatly appreciate API review in this final release
99 candidate period. We've had some limited feedback that our attempts
100 to impose static type safety on XIDs in C pose more a hindrance than
101 a help, so we would appreciate discussion over whether this
102 constitutes a "serious issue with the API". Some question also
103 remains of whether xcb_poll_for_event should have the out-parameter
104 'error', now that XCB has a more uniform mechanism for reporting
105 connection errors. Speak now on these points or leave us alone. ;-)
107 Since we've received feedback agreeing with our proposed changes, and no
108 objections or requests to keep the existing API, we made both changes
109 and bumped the soname to libxcb.so.1.0.0 in preparation for the release
112 * Remove XID wrapper structures and replace them with uint32_t typedefs.
113 XID union types like xcb_drawable_t and xcb_fontable_t also become
114 uint32_t typedefs. The API conversion script now replaces xcb_*_new
115 with calls directly to xcb_generate_id. This change makes
116 xcb_generate_id part of the client API rather than the extension API,
117 so move xcb_generate_id from xcbext.h to xcb.h.
119 * Remove the 'int *error' out-parameter for xcb_poll_for_event.
120 xcb_poll_for_event now shuts down the xcb_connection_t on fatal
121 errors; use xcb_connection_has_error to check.
123 The Xlib-specific API in libxcb-xlib also changed:
125 * Stop exposing the XCB IO lock for Xlib's benefit, by removing
126 xcb_get_io_lock from the Xlib-specific XCB API; instead, libxcb-xlib
127 now provides xcb_xlib_lock and xcb_xlib_unlock.
129 Code generation changes
130 -----------------------
132 * The code generator no longer implicitly imports xproto for extensions.
133 xcb-proto 1.0 RC2 includes the corresponding change to explicitly
134 import xproto in extensions that need it
136 * The generated protocol headers now declare "struct foo", "union foo"
137 or "enum foo", not just the typedef "foo" of an unnamed
138 struct/union/enum type.
143 * Make Plan 7 'checked' requests work correctly.
145 Documentation improvements
146 --------------------------
148 * Document xcb_generate_id.
150 * Tutorial enhancements.
153 Release 1.0 RC1 (2006-09-25)
154 ============================
156 The Great XCB Renaming
157 ----------------------
159 Rename API to follow a new naming convention:
161 * XCB_CONSTANTS_UPPERCASE_WITH_UNDERSCORES
162 * xcb_functions_lowercase_with_underscores
163 * xcb_types_lowercase_with_underscores_and_suffix_t
164 * expand all abbreviations like "req", "rep", and "iter"
166 Word boundaries for the names in the protocol descriptions fall:
168 * Wherever the protocol descriptions already have an underscore
169 * Between a lowercase letter and a subsequent uppercase letter
170 * Before the last uppercase letter in a string of uppercase letters
171 followed by a lowercase letter (such as in LSBFirst between LSB and
173 * Before and after a string of digits (with exceptions for sized types
174 like xcb_char2b_t and xcb_glx_float32_t to match the stdint.h
177 Also fix up some particular naming issues:
179 * Rename shape_op and shape_kind to drop the "shape_" prefix, since
180 otherwise these types end up as xcb_shape_shape_{op,kind}_t.
181 * Remove leading underscores from enums in the GLX protocol description,
182 previously needed to ensure a word separator, but now redundant.
184 This renaming breaks code written for the previous API naming
185 convention. The scripts in XCB's tools directory will convert code
186 written for the old API to use the new API; they work well enough that
187 we used them to convert the non-program-generated code in XCB, and when
188 run on the old program-generated code, they almost exactly reproduce the
189 new program-generated code (modulo whitespace and bugs in the old code
192 Authors: Vincent Torri, Thomas Hunger, Josh Triplett
194 In addition to the API renaming, the library SONAMEs have changed to
195 libxcb.so and libxcb-extname.so. The library major version remains at 0,
196 to become version 1 before 1.0 is released; the SONAME lowercasing means
197 that this will not conflict with XCB 0.9 libraries.
199 The header files have moved from /usr/include/X11/XCB/ to
200 /usr/include/xcb/. The XML-XCB protocol descriptions have moved to
201 /usr/share/xcb, with extension descriptions no longer relegated to an
202 extensions/ subdirectory. The API conversion script api_conv.pl will fix
203 references to the header files, and packages using pkg-config will
204 automatically use the new library names.
206 Error handling Plan 7
207 ---------------------
209 All request functions now come in an "unchecked" and "checked" variant.
210 The checked variant allows callers to handle errors inline where they
211 obtain the reply, or by calling xcb_request_check for requests with no
212 reply. The unchecked variant uses the event queue for errors. Requests
213 with replies default to checked, because the caller must already make a
214 function call to retrieve the reply and can see the error at that time;
215 the unchecked variant uses the suffix _unchecked. Requests without
216 replies default to unchecked, because the caller will not necessarily
217 expect to handle a response, and the checked variant uses the suffix
220 Connection error handling
221 -------------------------
223 Fatal connection errors now put the xcb_connection_t object into an
224 error state, at which point all further operations on that connection
225 will fail. Callers can use the new xcb_connection_has_error function to
226 check for this state in a connection. Functions that return a
227 connection, such as the xcb_connect function, may instead return an
228 xcb_connection_t already in an error state.
230 In the future we expect to add additional API for getting more
231 information about the error condition that caused the connection to get
237 All functions that have been marked 'deprecated' up to now have been
238 removed for this release. After XCB 1.0 is released, functions marked
239 'deprecated' will be preserved until the end of time to maintain
242 XCB no longer provides a sync function. Most callers of this function
243 should use xcb_flush instead, which usually provides the intended
244 functionality and does not require a round-trip to the server. If you
245 really need this functionality, either use xcb_get_input_focus like sync
246 used to do, or use the xcb_aux_sync function from the xcb-aux library in
247 xcb-util. However, note that we do not consider the libraries in
248 xcb-util remotely stable yet.
250 XCB no longer provides xcb_[extension_name]_init functions for each
251 extension. These functions previously caused XCB to issue and process a
252 QueryExtension request. Callers should now directly call
253 xcb_get_extension_data on the xcb_[extension_name]_id, or use
254 xcb_prefetch_extension_data if they do not need to force a round-trip
257 The compatibility functions in xcbxlib.h, provided solely for use by
258 Xlib/XCB, now exist in a separate library libxcb-xlib. We don't want to
259 have to change the libxcb soname if we later change or remove the Xlib
260 compatibility functions, and nothing except Xlib/XCB should ever use
261 them. (Applications which use Xlib/XCB do not need this library either;
262 Xlib/XCB only uses it internally.)
264 The descriptions of several extensions have been updated to match the
265 latest versions implemented in the X.org X server.
270 Previously, several XCB-related projects all existed under the umbrella
271 of a single monolithic GIT repository with per-project subdirectories.
272 We have split this repository into individual per-project repositories.
274 Josh Triplett and Jamey Sharp wrote a tool called git-split to
275 accomplish this repository split. git-split reconstructs the history of
276 a sub-project previously stored in a subdirectory of a larger
277 repository. It constructs new commit objects based on the existing tree
278 objects for the subtree in each commit, and discards commits which do
279 not affect the history of the sub-project, as well as merges made
280 unnecessary due to these discarded commits.
282 We would like to acknowledge the work of the gobby team in creating a
283 collaborative editor which greatly aided the development of git-split
284 (as well as these release notes).
286 Build and implementation fixes
287 ------------------------------
289 XCB no longer needs proto/x11 from X.org; the XCB header xproto.h
290 provides the definitions from X.h, named according to XCB conventions.
292 XCB should now build with non-GNU implementations of Make.
294 XCB properly handles 32-bit wrap of sequence numbers, and thus now
295 supports issuing more than 2**32 requests in one connection.
297 Fixed bugs #7001, #7261.