GTK-DOC doesn't like enum return types.
[libidn.git] / NEWS
blob27cb18e8325426dcfe8d7b1b8c0f67a4f9841a0e
1 Libidn NEWS -- History of user-visible changes.                 -*- outline -*-
2 Copyright (C) 2002, 2003 Simon Josefsson
3 See the end for copying conditions.
5 * Version 0.2.0 (unreleased)
7 ** Unicode code point data is now uint32_t, defined in "idn-int.h".
8 A header file "idn-int.h" is generated and installed to make sure the
9 "uint32_t" data type is available on all platforms.  The reason for
10 this change is that on 64-bit platforms, the application was required
11 to convert 32 bit integers (which is how Unicode code points are
12 typically represented) into 64 bit integers before calling libidn
13 functions.
15 ** New idna_*() functions have improved flags handling.
16 The allowunassigned and usestd3asciirules parameters were collapsed
17 into a flags parameter, that can take on the IDNA_ALLOW_UNASSIGNED and
18 IDNA_USE_STD3_ASCII_RULES values.  This allows for easier extensions
19 to support, e.g., Unicode 4.0 or RFC 952 ASCII rules checking.  Note
20 that the old entry points are unmodified (in this regard), and new
21 entry points with this modification were added.
23 ** The manual was moved into a separate directory doc/.
25 ** Bugfixes.
27 ** API and ABI is not backwards compatible.
28 In punycode.h and stringprep.h the "unsigned long" data type was
29 changed into "uint32_t", which cause a API and ABI missmatch.  For
30 idna.h, the old entry points that used "unsigned long" still exist,
31 and new entry points that uses "uint32_t" was added.  To update your
32 application, you probably only need to change "unsigned long" to
33 "uint32_t".  As a result of these changes, the shared object version
34 has been increased.
36 * Version 0.1.15 (released 2003-06-07)
38 ** Bugfixes.
40 ** API and ABI is backwards compatible with the previous version.
42 * Version 0.1.14 (released 2003-05-10)
44 ** Experimental documentation generation in contrib/doxygen/.
45 Simply invoke "doxygen" in that directory and it should build the
46 documentation.
48 ** Lisp API bug fixes.
50 ** API and ABI is backwards compatible with the previous version.
52 * Version 0.1.13 (released 2003-03-13)
54 ** Unfinished Java *.class files implementing the libidn API.
55 See the contrib/java/ directory.  It is implemented using the Java
56 Native Interface, and light initial testing indicate interoperability
57 between GCJ, IBM's JDK and Sun's JDK.
59 ** Building is now silent when gengetopt is not present.
61 ** Bug fixes.
63 ** API and ABI is backwards compatible with the previous version.
65 * Version 0.1.12 (released 2003-03-06)
67 ** Building libidn doesn't require gengetopt.
68 Warnings are still printed though.  Gengetopt will be replaced by argp
69 eventually.
71 ** Command line tool "idn" supports stringprep too.
73 ** New stringprep API entry point: stringprep_profile().
74 It takes a name of the stringprep profile as an argument instead of
75 the stringprep table structure.
77 ** stringprep_*.h are deprecated and will be removed in the future.
78 All symbols have been moved to stringprep.h.  The reasons are that (1)
79 the files typically only defined one CPP macro and exported one symbol
80 definition, which is wasteful as it generates too much work in the
81 manual, and (2) using one header file for all profiles allows easier
82 access to all stringprep profiles during runtime.  Note that the files
83 are still installed, but they only #include stringprep.h now, for
84 backwards compatibility.
86 ** GNU Libc add-on build instructions updated to GNU Libc 2.3.2.
88 ** SASLprep stringprep profile added.
90 ** An online interface to libidn written in PHP added to contrib/web/.
92 ** API and ABI is backwards compatible with the previous version.
94 * Version 0.1.11 (released 2003-02-26)
96 ** Command line application "idn" is included.
97 A simple wrapper around the library that allows you to invoke punycode
98 encoding/decoding and IDNA ToASCII/ToUnicode on the command line.
100 ** Emacs Lisp interface for punycode and IDNA included.
101 See punycode.el and idna.el.
103 ** API and ABI is backwards compatible with the previous version.
105 * Version 0.1.10 (released 2003-02-21)
107 ** idna_*_to_ace() and idna_*ace_to_*() are deprecated in favor of
108 ** idna_to_ascii_from_*() and idna_to_unicode_*_from_*() respectively.
109 The reason was that the old interfaces did not accept the
110 AllowUnassigned and UseSTD3ASCIIRules flags.  Note that the old
111 functions are not removed, but will be in the future.
113 ** IPS iSCSI stringprep profile added.
115 ** A new contrib/ directory added.
116 Currently it contains a Python interface to Libidn, contributed by
117 Stephane Bortzmeyer.
119 ** idna.h and punycode.h are now installed by "make install".
121 ** API and ABI is backwards compatible with the previous version.
123 * Version 0.1.9 (released 2003-02-20)
125 ** SASL ANONYMOUS "plain" stringprep profile added.
127 ** XMPP nodeprep profile fixed.
129 ** API and ABI is backwards compatible with the previous version.
130 For future releases, the NEWS entry will specifically mention whether
131 the C header API or library ABI backwards compatibility is affected.
133 * Version 0.1.8 (released 2003-02-14)
135 ** Portability fixes.
136 This includes not building the API Reference Manual with GTK-DOC by
137 default, if you want it use configure parameter --enable-gtk-doc after
138 making sure your gtkdoc-mkdb accept the --tmpl-dir parameter.
140 ** The type for string length variables is now (s)size_t.
141 Unfortunately this means binary shared library binary backwards
142 compatible is lost.
144 ** New nameprep test vectors.
146 * Version 0.1.7 (released 2003-02-12)
148 ** Uses official IDNA ACE prefix.
150 * Version 0.1.6 (released 2003-02-11)
152 ** Uses tentative IDNA ACE prefix.
154 ** Added XMPP Node/Resource Identifiers stringprep profiles.
156 ** Fixed prohibited character checks for bidi.
158 * Version 0.1.5 (released 2003-01-28)
160 ** The library can now be built as part of GNU Libc.
161 This is experimental and only tested against GNU Libc version 2.3.1.
162 See the libc/ directory, and libc/README in particular.
164 ** Bug fixes.
166 * Version 0.1.4 (released 2003-01-15)
168 ** Documentation fixes.
170 ** Portability fixes.
172 ** Bug fixes.
174 * Version 0.1.3 (released 2003-01-15)
176 ** Added texinfo manual.
178 * Version 0.1.2 (released 2003-01-08)
180 ** Added high-level IDNA API.
182 ** Added example3.c and example4.c demonstrating the high-level IDNA API.
184 * Version 0.1.1 (released 2003-01-08)
186 ** Added documentation using GTK-DOC.
188 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
189 By accident it was never removed in 0.1.0.
191 * Version 0.1.0 (released 2003-01-05)
193 ** Official GNU project.
195 ** Renamed from libstringprep to libidn.
197 ** Supports punycode and IDNA.  Caveat emptor: I don't use it myself.
199 ** Uses "unsigned long" for Unicode code points instead of "long".
200 Long is guaranteed to be at least 32 bits by C standards so it is
201 always sufficiently large, no need to use uint32_t and the like.
203 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
205 * Version 0.0.8 (released 2002-12-13)
207 ** Portability fixes (now works under Cygwin on Windows 2000).
209 ** Bug fixes.
211 * Version 0.0.7 (released 2002-12-09)
213 ** Apply all tables to entire strings, not just first hit.
215 ** Fix bidi infloop.
217 * Version 0.0.5 (released 2002-12-07)
219 ** Fix prohibited characters handling.
221 ** Fix bidi.
223 ** Renamed type (struct) stringprep_table_element to Stringprep_table_element.
225 ** Renamed type stringprep_profile to Stringprep_profile.
227 ** Renamed type (struct) stringprep_table to Stringprep_table.
229 ** Added more self-tests.
231 * Version 0.0.4 (released 2002-12-06)
233 ** Add unassigned code point handling, including self test cases.
235 ** Portability fixes.
237 * Version 0.0.3 (released 2002-11-30)
239 ** Exported utility function `stringprep_utf8_to_unichar', complementary
240 to existing `stringprep_unichar_to_utf8'.
242 ** Renamed `stringprep_utf8_to_ucs4_fast' to `stringprep_utf8_to_ucs4' to
243 clean up API. The old entry point is maintained for binary backwards
244 compatibility though.
246 ** The distribution is from now on signed using GnuPG.
248 ** Bug fixes.
250 * Version 0.0.2 (released 2002-11-07)
252 ** NFKC self test.
254 ** Bug fixes.
256 * Version 0.0.1 (released 2002-11-06)
258 ** Add utility functions stringprep_locale_charset(), stringprep_convert() 
259 and stringprep_locale_to_utf8 () that can be used to convert text from
260 system's locale into UTF-8, which should be done before invoking
261 stringprep().  The functions requires iconv() in the operating system.
263 ** An example program (example.c) that illustrates how libstringprep can be
264 used is included.
266 ** The pkg-config --libs output should now include necessary -R options.
268 * Version 0.0.0 (released 2002-11-05)
270 ** Initial release
272 ----------------------------------------------------------------------
273 Copying and distribution of this file, with or without modification,
274 are permitted in any medium without royalty provided the copyright
275 notice and this notice are preserved.