NEWS: add some spacing
[platform/upstream/libxkbcommon.git] / NEWS
1 libxkbcommon 0.5.0 - 2014-10-18
2 ==================
3
4 - Added support for Compose/dead keys in a new module (included in
5   libxkbcommon). See the documentation or the
6   xkbcommon/xkbcommon-compose.h header file for more details.
7
8 - Improved and reordered some sections of the documentation.
9
10 - The doxygen HTML pages were made nicer to read.
11
12 - Most tests now run also on non-linux platforms.
13
14 - A warning is emitted by default about RMLVO values which are not used
15   during keymap compilation, which are most often a user misconfiguration.
16   For example, "terminate:ctrl_alt_backspace" instead of
17   "terminate:ctrl_alt_bksp".
18
19 - Added symbol versioning for libxkbcommon and libxkbcommon-x11.
20   Note: binaries compiled against this and future versions will not be
21   able to link against the previous versions of the library.
22
23 - Removed several compatablity symbols from the binary (the API isn't
24   affected). This affects binaries which
25
26   1. Were compiled against a pre-stable (<0.2.0) version of libxkbcommon, and
27   2. Are linked against the this or later version of libxkbcommon.
28
29   Such a scenario is likely to fail already.
30
31 - If Xvfb is not available, the x11comp test is now correctly skipped
32   instead of hanging.
33
34 - Benchmarks were moved to a separate bench/ directory.
35
36 - Build fixes from OpenBSD.
37
38 - Fixed a bug where key type entries such as "map[None] = Level2;" were
39   ignored.
40
41 - New API:
42   XKB_COMPOSE_*
43   xkb_compose_*
44
45
46 libxkbcommon 0.4.3 - 2014-08-19
47 ==================
48
49 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to misrepresent
50   modifiers for some keymaps.
51
52   https://github.com/xkbcommon/libxkbcommon/issues/9
53
54 - Fixed a bug which caused xkb_x11_keymap_new_from_device() to ignore XKB
55   PrivateAction's.
56
57 - Modifiers are now always fully resolved after xkb_state_update_mask().
58   Previously the given state components were used as-is, without
59   considering virtual modifier mappings.
60   Note: this only affects non-standard uses of xkb_state_update_mask().
61
62 - Added a test for xkbcommon-x11, "x11comp". The test uses the system's
63   Xvfb server and xkbcomp. If they do not exist or fail, the test is
64   skipped.
65
66 - Fixed memory leaks after parse errors in the XKB yacc parser.
67   The fix required changes which are currently incompatible with byacc.
68
69
70 libxkbcommon 0.4.2 - 2014-05-15
71 ==================
72
73 - Fixed a bug where explicitly passing "--enable-x11" to ./configure would
74   in fact disable it (regressed in 0.4.1).
75
76 - Added @since version annotations to the API documentation for everything
77   introduced after the initial stable release (0.2.0).
78
79 - Added a section to the documentation about keysym transformations, and
80   clarified which functions perform a given transformation.
81
82 - XKB files which fail to compile during keymap construction can no longer
83   have any effect on the resulting keymap: changes are only applied when
84   the entire compilation succeeds.
85   Note: this was a minor correctness issue inherited from xkbcomp.
86
87 - Fix an out-of-bounds array access in src/x11/util.c:adopt_atoms()
88   error-handling code.
89   Note: it seems impossible to trigger in the current code since the input
90   size cannot exceed the required size.
91
92
93 libxkbcommon 0.4.1 - 2014-03-27
94 ==================
95
96 - Converted README to markdown and added a Quick Guide to the
97   documentation, which breezes through the most common parts of
98   xkbcommon.
99
100 - Added two new functions, xkb_state_key_get_utf{8,32}(). They
101   combine the operations of xkb_state_key_get_syms() and
102   xkb_keysym_to_utf{8,32}(), and provide a nicer interface for it
103   (espcially for multiple-keysyms-per-level).
104
105 - The xkb_state_key_get_utf{8,32}() functions now apply Control
106   transformation: when the Control modifier is active, the string
107   is converted to an appropriate control character.
108   This matches the behavior of libX11's XLookupString(3), and
109   required by the XKB specification:
110   http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Control_Modifier
111
112   https://bugs.freedesktop.org/show_bug.cgi?id=75892
113
114 - The consumed modifiers for a key are now calculated similarly
115   to libX11. The previous behavior caused a bug where Shift would
116   not cancel an active Caps Lock.
117
118 - Make xkbcommon-x11 work with the keymap reported by the XQuartz
119   X server.
120
121   https://bugs.freedesktop.org/show_bug.cgi?id=75798
122
123 - Reduce memory usage during keymap compilation some more.
124
125 - New API:
126   xkb_state_key_get_consumed_mods()
127   xkb_state_key_get_utf8()
128   xkb_state_key_get_utf32()
129
130 - Deprecated API:
131   XKB_MAP_COMPILE_PLACEHOLDER, XKB_MAP_NO_FLAGS
132     use XKB_KEYMAP_NO_FLAGS instead.
133
134 - Bug fixes.
135
136
137 libxkbcommon 0.4.0 - 2014-02-02
138 ==================
139
140 - Add a new add-on library, xkbcommon-x11, to support creating keymaps
141   with the XKB X11 protocol, by querying the X server directly.
142   See the xkbcommon/xkbcommon-x11.h header file for more details.
143   This library requires libxcb-xkb >= 1.10, and is enabled by default.
144   It can be disabled with the --disable-x11 configure switch.
145   Distributions are encouraged to split the necessary files for this
146   library (libxkbcommon-x11.so, xkbcommon-x11.pc, xkbcommon/xkbcommon-x11.h)
147   to a separate package, such that the main package does not depend on
148   X11 libraries.
149
150 - Fix the keysym <-> name lookup table to not require huge amounts of
151   relocations.
152
153 - Fix a bug in the keysym <-> name lookup, whereby lookup might fail in
154   some rare cases.
155
156 - Reduce memory usage during keymap compilation.
157
158 - New API:
159   New keysyms from xproto 7.0.25 (German T3 layout keysyms).
160   XKB_MOD_NAME_NUM for the usual NumLock modifier.
161   xkb_x11_* types and functions, XKB_X11_* constants.
162
163
164 libxkbcommon 0.3.2 - 2013-11-22
165 ==================
166
167 - Log messages from the library now look like "xkbcommon: ERROR" by
168   default, instead of xkbcomp-like "Error:   ".
169
170 - Apply capitalization transformation on keysyms in
171   xkb_keysym_get_one_sym(), to match the behavior specified in the XKB
172   specification:
173   http://www.x.org/releases/current/doc/kbproto/xkbproto.html#Interpreting_the_Lock_Modifier
174
175 - Support byacc for generating the parser, in addition to Bison.
176
177 - New API:
178   XKB_KEY_XF86AudioMicMute keysym from xproto 7.0.24.
179   XKB_KEYSYM_NO_FLAGS
180   XKB_CONTEXT_NO_FLAGS
181   XKB_MAP_COMPILE_NO_FLAGS
182
183 - Bug fixes.
184
185
186 libxkbcommon 0.3.1 - 2013-06-03
187 ==================
188
189 - Replace the flex scanner with a hand-written one. flex is no longer
190   a build requirement.
191
192 - New API:
193   xkb_keymap_min_keycode()
194   xkb_keymap_max_keycode()
195   xkb_keymap_key_for_each()
196
197
198 libxkbcommon 0.3.0 - 2013-04-01
199 ==================
200
201 - Allow passing NULL to *_unref() functions; do nothing instead of
202   crashing.
203
204 - The functions xkb_keymap_num_levels_for_key() and
205   xkb_keymap_get_syms_by_level() now allow out-of-range values for the
206   'layout' parameter. The functions now wrap the value around the number
207   of layouts instead of failing.
208
209 - The function xkb_keysym_get_name() now types unicode keysyms in
210   uppercase and 0-padding, to match the format used by XKeysymToString().
211
212 - Building Linux-specific tests is no longer attempted on non-Linux
213   environments.
214
215 - The function xkb_keymap_new_from_names() now accepts a NULL value for
216   the 'names' parameter, instead of failing. This is equivalent to passing
217   a 'struct xkb_rule_names' with all fields set to NULL.
218
219 - New API:
220   xkb_keymap_new_from_buffer()
221
222 - Bug fixes.