*** empty log message ***
[libidn.git] / NEWS
blobc8c4aca13ab50da69b737dff64e90a9bfd4ee26f
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.3.0 (unreleased)
7 ** Ported to Mac OS X.
9 ** Gnulib code removed, we now assume a C89 compatible environment.
11 ** Building libidn as a libc add-on now works again.
13 ** Man pages for all public API functions are included.
15 ** API and ABI is NOT backwards compatible with the previous version.
16 All previously labeled (since 0.1.x) obsolete functions have been dropped.
17 The use of 'enum' types instead of 'int' added in 0.2.3 reverted, it
18 confused documentation generators and wasn't all that common practice.
20 * Version 0.2.3 (released 2003-08-26)
22 ** Example 4 was the same as example 3, now changed to demo ToUnicode.
24 ** Documentation improvements.
26 ** Prototype cleanups.
27 The proper enum types (Stringprep_rc, Idna_rc, etc) are now used in
28 several places where plain int where used before.  String lengths are
29 handled by (s)size_t instead of int.
31 ** API and ABI is backwards compatible with the previous version.
33 * Version 0.2.2 (released 2003-08-13)
35 ** Fixed problem with strings longer than 4GB in punycode functions.
36 The punycode code cannot handle strings longer than 4GB.  The code now
37 return PUNYCODE_BAD_INPUT on too long input, instead of failing in an
38 unknown way.
40 ** The "idn --idna-to-unicode" command now output locale encoded strings.
42 ** Build fixes, bug fixes.
44 ** API and ABI is backwards compatible with the previous version.
46 * Version 0.2.1 (released 2003-07-04)
48 ** Don't reject zero-length trailing labels as in, e.g., "www.example.org.".
49 The IDNA RFC is not clear on this topic, zero-length labels in general
50 are forbidden by the ToASCII algorithm in section 4.1 step 8, but the
51 terminology section define, inside a parenthesis, that the zero-length
52 root label is in fact not considered a label at all in IDNA.
54 ** Bug fixes.
56 ** API and ABI is backwards compatible with the previous version.
58 * Version 0.2.0 (released 2003-06-19)
60 ** Unicode code point data is now uint32_t, defined in "idn-int.h".
61 A header file "idn-int.h" is generated and installed to make sure the
62 "uint32_t" data type is available on all platforms.  The reason for
63 this change is that on 64-bit platforms, the application was required
64 to convert 32 bit integers (which is how Unicode code points are
65 typically represented) into 64 bit integers before calling libidn
66 functions.
68 ** New idna_*() functions have improved flags handling.
69 The allowunassigned and usestd3asciirules parameters were collapsed
70 into a flags parameter, that can take on the IDNA_ALLOW_UNASSIGNED and
71 IDNA_USE_STD3_ASCII_RULES values.  This allows for easier extensions
72 to support, e.g., Unicode 4.0 or RFC 952 ASCII rules checking.  Note
73 that the old entry points are unmodified (in this regard), and new
74 entry points with this modification were added.
76 ** The manual was moved into a separate directory doc/.
78 ** Bugfixes.
80 ** API and ABI is not backwards compatible.
81 In punycode.h and stringprep.h the "unsigned long" data type was
82 changed into "uint32_t", which cause a API and ABI missmatch.  For
83 idna.h, the old entry points that used "unsigned long" still exist,
84 and new entry points that uses "uint32_t" was added.  To update your
85 application, you probably only need to change "unsigned long" to
86 "uint32_t".  As a result of these changes, the shared object version
87 has been increased.
89 * Version 0.1.15 (released 2003-06-07)
91 ** Bugfixes.
93 ** API and ABI is backwards compatible with the previous version.
95 * Version 0.1.14 (released 2003-05-10)
97 ** Experimental documentation generation in contrib/doxygen/.
98 Simply invoke "doxygen" in that directory and it should build the
99 documentation.
101 ** Lisp API bug fixes.
103 ** API and ABI is backwards compatible with the previous version.
105 * Version 0.1.13 (released 2003-03-13)
107 ** Unfinished Java *.class files implementing the libidn API.
108 See the contrib/java/ directory.  It is implemented using the Java
109 Native Interface, and light initial testing indicate interoperability
110 between GCJ, IBM's JDK and Sun's JDK.
112 ** Building is now silent when gengetopt is not present.
114 ** Bug fixes.
116 ** API and ABI is backwards compatible with the previous version.
118 * Version 0.1.12 (released 2003-03-06)
120 ** Building libidn doesn't require gengetopt.
121 Warnings are still printed though.  Gengetopt will be replaced by argp
122 eventually.
124 ** Command line tool "idn" supports stringprep too.
126 ** New stringprep API entry point: stringprep_profile().
127 It takes a name of the stringprep profile as an argument instead of
128 the stringprep table structure.
130 ** stringprep_*.h are deprecated and will be removed in the future.
131 All symbols have been moved to stringprep.h.  The reasons are that (1)
132 the files typically only defined one CPP macro and exported one symbol
133 definition, which is wasteful as it generates too much work in the
134 manual, and (2) using one header file for all profiles allows easier
135 access to all stringprep profiles during runtime.  Note that the files
136 are still installed, but they only #include stringprep.h now, for
137 backwards compatibility.
139 ** GNU Libc add-on build instructions updated to GNU Libc 2.3.2.
141 ** SASLprep stringprep profile added.
143 ** An online interface to libidn written in PHP added to contrib/web/.
145 ** API and ABI is backwards compatible with the previous version.
147 * Version 0.1.11 (released 2003-02-26)
149 ** Command line application "idn" is included.
150 A simple wrapper around the library that allows you to invoke punycode
151 encoding/decoding and IDNA ToASCII/ToUnicode on the command line.
153 ** Emacs Lisp interface for punycode and IDNA included.
154 See punycode.el and idna.el.
156 ** API and ABI is backwards compatible with the previous version.
158 * Version 0.1.10 (released 2003-02-21)
160 ** idna_*_to_ace() and idna_*ace_to_*() are deprecated in favor of
161 ** idna_to_ascii_from_*() and idna_to_unicode_*_from_*() respectively.
162 The reason was that the old interfaces did not accept the
163 AllowUnassigned and UseSTD3ASCIIRules flags.  Note that the old
164 functions are not removed, but will be in the future.
166 ** IPS iSCSI stringprep profile added.
168 ** A new contrib/ directory added.
169 Currently it contains a Python interface to Libidn, contributed by
170 Stephane Bortzmeyer.
172 ** idna.h and punycode.h are now installed by "make install".
174 ** API and ABI is backwards compatible with the previous version.
176 * Version 0.1.9 (released 2003-02-20)
178 ** SASL ANONYMOUS "plain" stringprep profile added.
180 ** XMPP nodeprep profile fixed.
182 ** API and ABI is backwards compatible with the previous version.
183 For future releases, the NEWS entry will specifically mention whether
184 the C header API or library ABI backwards compatibility is affected.
186 * Version 0.1.8 (released 2003-02-14)
188 ** Portability fixes.
189 This includes not building the API Reference Manual with GTK-DOC by
190 default, if you want it use configure parameter --enable-gtk-doc after
191 making sure your gtkdoc-mkdb accept the --tmpl-dir parameter.
193 ** The type for string length variables is now (s)size_t.
194 Unfortunately this means binary shared library binary backwards
195 compatible is lost.
197 ** New nameprep test vectors.
199 * Version 0.1.7 (released 2003-02-12)
201 ** Uses official IDNA ACE prefix.
203 * Version 0.1.6 (released 2003-02-11)
205 ** Uses tentative IDNA ACE prefix.
207 ** Added XMPP Node/Resource Identifiers stringprep profiles.
209 ** Fixed prohibited character checks for bidi.
211 * Version 0.1.5 (released 2003-01-28)
213 ** The library can now be built as part of GNU Libc.
214 This is experimental and only tested against GNU Libc version 2.3.1.
215 See the libc/ directory, and libc/README in particular.
217 ** Bug fixes.
219 * Version 0.1.4 (released 2003-01-15)
221 ** Documentation fixes.
223 ** Portability fixes.
225 ** Bug fixes.
227 * Version 0.1.3 (released 2003-01-15)
229 ** Added texinfo manual.
231 * Version 0.1.2 (released 2003-01-08)
233 ** Added high-level IDNA API.
235 ** Added example3.c and example4.c demonstrating the high-level IDNA API.
237 * Version 0.1.1 (released 2003-01-08)
239 ** Added documentation using GTK-DOC.
241 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
242 By accident it was never removed in 0.1.0.
244 * Version 0.1.0 (released 2003-01-05)
246 ** Official GNU project.
248 ** Renamed from libstringprep to libidn.
250 ** Supports punycode and IDNA.  Caveat emptor: I don't use it myself.
252 ** Uses "unsigned long" for Unicode code points instead of "long".
253 Long is guaranteed to be at least 32 bits by C standards so it is
254 always sufficiently large, no need to use uint32_t and the like.
256 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
258 * Version 0.0.8 (released 2002-12-13)
260 ** Portability fixes (now works under Cygwin on Windows 2000).
262 ** Bug fixes.
264 * Version 0.0.7 (released 2002-12-09)
266 ** Apply all tables to entire strings, not just first hit.
268 ** Fix bidi infloop.
270 * Version 0.0.5 (released 2002-12-07)
272 ** Fix prohibited characters handling.
274 ** Fix bidi.
276 ** Renamed type (struct) stringprep_table_element to Stringprep_table_element.
278 ** Renamed type stringprep_profile to Stringprep_profile.
280 ** Renamed type (struct) stringprep_table to Stringprep_table.
282 ** Added more self-tests.
284 * Version 0.0.4 (released 2002-12-06)
286 ** Add unassigned code point handling, including self test cases.
288 ** Portability fixes.
290 * Version 0.0.3 (released 2002-11-30)
292 ** Exported utility function `stringprep_utf8_to_unichar', complementary
293 to existing `stringprep_unichar_to_utf8'.
295 ** Renamed `stringprep_utf8_to_ucs4_fast' to `stringprep_utf8_to_ucs4' to
296 clean up API. The old entry point is maintained for binary backwards
297 compatibility though.
299 ** The distribution is from now on signed using GnuPG.
301 ** Bug fixes.
303 * Version 0.0.2 (released 2002-11-07)
305 ** NFKC self test.
307 ** Bug fixes.
309 * Version 0.0.1 (released 2002-11-06)
311 ** Add utility functions stringprep_locale_charset(), stringprep_convert() 
312 and stringprep_locale_to_utf8 () that can be used to convert text from
313 system's locale into UTF-8, which should be done before invoking
314 stringprep().  The functions requires iconv() in the operating system.
316 ** An example program (example.c) that illustrates how libstringprep can be
317 used is included.
319 ** The pkg-config --libs output should now include necessary -R options.
321 * Version 0.0.0 (released 2002-11-05)
323 ** Initial release
325 ----------------------------------------------------------------------
326 Copying and distribution of this file, with or without modification,
327 are permitted in any medium without royalty provided the copyright
328 notice and this notice are preserved.