1 Libidn NEWS -- History of user-visible changes. -*- outline -*-
2 Copyright (C) 2002, 2003, 2004 Simon Josefsson
3 See the end for copying conditions.
5 * Version 0.5.7 (unreleased)
7 ** Shared library version incremented, because new APIs were added.
8 This was forgotten in the last release.
10 ** French translation updated.
14 ** API and ABI is backwards compatible with the previous version.
16 * Version 0.5.6 (released 2004-10-02)
18 ** Added functions to convert return codes to human readable text.
20 ** Now using GNULib in command line front end (src/) for portability code.
21 See <http://www.gnu.org/software/gnulib/> for more information on
22 GNULib. This should make the code easier to read and maintain.
24 ** API and ABI is backwards compatible with the previous version.
27 punycode_strerror: ADD.
28 stringprep_strerror: ADD.
30 TLD_NO_TLD: ADD. Replaces TLD_NOTLD.
31 TLD_NOTLD: DEPRECATED. Use TLD_NO_TLD instead.
33 * Version 0.5.5 (released 2004-09-13)
35 ** Hide accidentally exported variable g_utf8_skip, by marking it as static.
39 ** API and ABI is backwards compatible with the previous version.
40 g_utf8_skip: REMOVED. (But never meant to be used.)
42 * Version 0.5.4 (released 2004-08-08)
44 ** Translation updates.
46 ** API and ABI is backwards compatible with the previous version.
48 * Version 0.5.3 (released 2004-08-05)
50 ** Fix crash in `idn --tld' command line tool.
52 ** API and ABI is backwards compatible with the previous version.
54 * Version 0.5.2 (released 2004-07-14)
56 ** Java "make install" rules are now DESTDIR compatible.
58 ** API and ABI is backwards compatible with the previous version.
60 * Version 0.5.1 (released 2004-07-09)
62 ** Cross compile builds should work.
63 It should work for any sane cross compile target, but the only tested
64 platform is uClibc/uClinux on Motorola Coldfire.
66 ** The example programs now correctly invoke `setlocale (LC_ALL, "")'.
68 ** API and ABI is backwards compatible with the previous version.
70 * Version 0.5.0 (released 2004-06-26)
72 ** Functions to detect "normalization problem sequences" as per PR-29 added.
73 See the new chapter "PR29 Functions" in the manual
74 (doc/libidn.{ps,pdf,html}) for more information and the background
75 story. An external link that discuss the problem is
76 <http://www.unicode.org/review/pr-29.html>.
79 Added Esperanto (by Edmund GRIMLEY EVANS).
81 ** API and ABI is backwards compatible with the previous version.
82 pr29.h: ADD. Prototypes for PR29 types and functions.
83 pr29_4, pr29_4z, pr29_8z: ADD. New API entry points for PR29 functions.
84 Pr29_rc: ADD. New error code enum type for PR29 functions.
86 * Version 0.4.9 (released 2004-06-11)
88 ** The Java library (java/libidn-*.jar) is included in the distribution.
90 ** JavaDoc manuals (doc/javadoc/) are included.
92 ** API and ABI is backwards compatible with the previous version.
94 * Version 0.4.8 (released 2004-06-01)
96 ** The Java source code is actually included in the distribution.
98 ** API and ABI is backwards compatible with the previous version.
100 * Version 0.4.7 (released 2004-05-31)
102 ** The Java port should now be functional, contributed by Oliver Hitz.
103 See the new section "Java API" in the manual for more information.
105 ** API and ABI is backwards compatible with the previous version.
107 * Version 0.4.6 (released 2004-05-24)
109 ** The header file idn-free.h is actually installed by 'make install'.
111 ** API and ABI is backwards compatible with the previous version.
113 * Version 0.4.5 (released 2004-05-21)
115 ** In IDNA ToUnicode, a `free' on a stale pointer fixed by Ulrich Drepper.
117 ** Several memory leaks fixed by Ulrich Drepper.
119 ** Added more SASLPrep and NFKC test vectors.
121 ** Automake 1.8.4 is used.
123 ** API and ABI is backwards compatible with the previous version.
124 idn_free: ADD. Wrapper around system `free'.
125 idn-free.h: ADD. Prototype for `idn_free'.
126 See idn-free.h for discussion. The interface is
127 currently not documented. Comments and feedback is
130 * Version 0.4.4 (released 2004-04-29)
132 ** Fixed two bugs in iSCSI definition, syncing with newly published RFC 3722.
133 The first bug was an omission of prohibiting the characters in C.1.1,
134 C.1.2 and C.7 (space characters and characters that are inappropriate
135 for canonical representation). The second was a bug in the definition
136 of the table, causing the entire table to be skipped, of the special
137 prohibited output character table defined in RFC 3722 (see section 6,
138 the characters in the table are various ASCII characters and U+3002).
140 ** A few test vectors for iSCSI were added.
142 ** The self tests are linked with libtool -no-install to avoid wrapper script.
144 ** Separated self test utilities into a separate library, shared by all tests.
146 ** More translations.
147 Added Romanian (by Laurentiu Buzdugan).
149 ** API and ABI is backwards compatible with the previous version.
151 * Version 0.4.3 (released 2004-04-22)
153 ** Fixed a bug in table processing code to prohibit control characters.
154 The problem was that the code used a code point of 0 to indicate end
155 of table, but if (as for table C.2.1) a range starts with 0, this
156 logic would fail. The end-of-table test is now that both the start
157 and end code points of the range is 0. Table C.2.1 is responsible for
158 prohibiting non-ASCII control characters, i.e. ASCII 0-31 and 127.
159 Before, libidn silently accepted such strings without complaining.
161 ** A few test vectors for SASLprep were added.
163 ** The pkg-config script no longer include a -R parameter.
165 ** More translations.
166 Added Dutch (by Elros Cyriatan), and German (by Roland Illig).
168 ** API and ABI is backwards compatible with the previous version.
170 * Version 0.4.2 (released 2004-03-20)
172 ** A Punycode implementation in Java was added, by Oliver Hitz.
173 Eventually hopefully a StringPrep, Nameprep and IDNA implementation
174 will be added as well. Currently you need to specify --enable-java to
175 enable the Java interface. The Java sources (below java/) are
176 compiled into byte-code (not native code) into a JAR library.
178 ** More translations.
179 Added Danish (by Morten Bo Johansen), French (by Michel Robitaille),
180 Polish (by Jakub Bogusz), and Serbian (by Aleksandar Jelenak).
182 ** Norwegian TLD table added, by Thomas Jacob.
184 ** API and ABI is backwards compatible with the previous version.
186 * Version 0.4.1 (released 2004-03-08)
188 ** The user messages from the command line utility are now translated.
189 Currently English and Swedish is supported.
191 ** Logic of stringprep_locale_charset modified.
192 Future versions will use, in order, $CHARSET iff defined, nl_langinfo
193 (CODESET) iff working, or fall back to returning "ASCII". Earlier it
194 attempted to guess the system locale, in contrast with the current
195 application's locale, via some setlocale save/set/reset magic. This
196 change may require you to invoke setlocale() in your application,
197 which is (should be) required for non-ASCII to work anyway. Based on
198 discussion with Ulrich Drepper.
200 ** The command-line utility now invoke setlocale (LC_ALL, "") at startup.
202 ** Fixed SASLprep tables to prohibit non-ASCII space in output.
203 Non-ASCII space has always been mapped to ASCII space, so it is not
204 clear this really have any effect, but the specification require it.
206 ** Building Libidn as part of GLIBC has been updated.
207 Refer to libc/README for more information. Incidentally, GLIBC in CVS
208 now include a copy of Libidn.
210 ** API and ABI is backwards compatible with the previous version.
211 IDNA_DLOPEN_ERROR: ADD. Only used internally by Libidn in libc.
213 * Version 0.4.0 (released 2004-02-28)
215 ** Support for TLD restrictions on IDN strings, contributed by Thomas Jacob.
216 Many TLDs restrict the set of characters that can be used, from the
217 full Unicode 3.2 range that is normally available. This contribution
218 make it possible for you to test strings for TLD conformance locally.
219 The code can be disabled by --disable-tld. If enabled (the default),
220 the new API "tld.h" is installed which can be used to check a string
221 for conformance to TLD specific rules. This add a new self test, and
222 a new chapter in the manual. People responsible for maintaining TLD
223 tables are hereby encouraged to contribute them (under reasonable
224 licensing terms) for inclusion in future versions of Libidn. Be
225 warned that the API for TLD checking may change throughout the 0.4.x
226 series as we get feedback on it.
228 ** Kerberos 5 stringprep profile macro is no longer documented.
229 The macro itself will probably be removed in the future, if the
230 specification is dropped from the Kerberos WG agenda.
232 ** API and ABI is backwards compatible with the previous version.
233 stringprep_kerberos5: DEPRECATED.
236 Tld_rc: ADD. New data types.
239 tld_get_z: ADD. New functions to extract TLD from string.
241 tld_default_table: ADD. New functions to get TLD table from TLD name.
243 tld_check_4tz: ADD. New function to provide core TLD operations.
247 tld_check_lz: ADD. New functions that combine all TLD operations in one call.
249 * Version 0.3.7 (released 2004-01-22)
251 ** The command line parameter '--' idiom is documented.
253 ** The iSCSI stringprep profile now recognized as "iSCSI".
254 The earlier name "ISCSIprep" is still recognized, for backwards
257 ** DocBook manuals no longer included (the tools are too unstable).
259 ** API and ABI is backwards compatible with the previous version.
261 * Version 0.3.6 (released 2004-01-06)
263 ** The manual now contain a troubleshooting section for the command line tool.
265 ** The PHP interface pass the string directly on the command line.
267 ** The macro that create 'idn-int.h' has been updated to latest version.
269 ** API and ABI is backwards compatible with the previous version.
271 * Version 0.3.5 (released 2003-12-15)
273 ** The program 'idn' accepts input strings directly on the command line.
275 ** The program 'idn' defaults to --idna-to-ascii if no parameter is given.
277 ** The program 'idn' now print user instructions before waiting for input.
279 ** DocBook HTML output not included any longer.
280 The reason is that the filenames generated by docbook2html appear to
281 be rather random, so it is difficult to maintain the Makefile.am rules
284 ** Autoconf 2.59, automake 1.8 and libtool from CVS is used.
286 ** API and ABI is backwards compatible with the previous version.
287 IDNA_CONTAINS_NON_LDH: ADD. Same integer value as IDNA_CONTAINS_LDH.
288 IDNA_CONTAINS_LDH: DEPRECATED. LDH (letter-digits-hyphens) characters
289 are not an error, but non-LDH characters are, when
290 IDNA_USE_STD3_ASCII_RULES is used. The logic of the
291 mnemonic name of this error constant was reversed.
293 * Version 0.3.4 (released 2003-11-09)
295 ** DocBook manuals in XML, PDF, PostScript, ASCII and HTML formats included.
297 * Version 0.3.3 (released 2003-10-18)
299 ** Fixed list of Stringprep profiles in 'idn --help' and 'idn.php'.
301 ** Fixed debug information in 'idn'.
303 ** Internal improvements.
304 Leads to reduced heap memory usage. Simplified inter-dependency among
305 files in lib/* to make it easier to copy them into your project.
307 ** Debugging stringprep profile 'generic' removed.
309 ** Punycode implementation updated to rfc3492bis-00.
311 ** API and ABI is backwards compatible with the previous version.
314 stringprep: CHANGED. 'profile' is marked as 'const'.
315 stringprep_profile: CHANGED. 'profile' is marked as 'const'.
316 stringprep_generic: REMOVED. Never meant for public use.
318 * Version 0.3.2 (released 2003-10-07)
320 ** SASL ANONYMOUS stringprep profile "trace" added.
321 It is equivalent to the already supported "plain" SASL ANONYMOUS
322 stringprep profile, except for the name.
324 ** API and ABI is backwards compatible with the previous version.
325 The 'in' parameter to stringprep_profile was changed from 'char*' to
328 * Version 0.3.1 (released 2003-10-02)
330 ** Fixed handling of implicit and explicit zero-length root labels in ToASCII.
332 ** Fixed support for Hangul Syllables during Unicode NFKC normalization.
334 ** Fixed Unicode NFKC normalization of (some) BMP code points.
335 This was done by syncing the NFKC code with latest GLIB, and may have
336 fixed other bugs in the earlier versions of the updated functions.
338 ** Added more IDNA test vectors.
340 ** Emacs Lisp IDNA implementation now set the UseSTD3ASCIIRules flag.
341 This is the appropriate setting for mail-related uses of IDNA.
343 ** API and ABI is backwards compatible with the previous version.
345 * Version 0.3.0 (released 2003-09-23)
347 ** Ported to Mac OS X.
349 ** Gnulib code removed, we now assume a C89 compatible environment.
351 ** Building libidn as a libc add-on now works again.
353 ** Man pages for all public API functions are included.
355 ** Fixed bug in SASLprep profile.
357 ** API and ABI is NOT backwards compatible with the previous version.
358 All previously labeled (since 0.1.x) obsolete functions have been dropped.
359 The use of 'enum' types instead of 'int' added in 0.2.3 reverted, it
360 confused documentation generators and wasn't all that common practice.
362 * Version 0.2.3 (released 2003-08-26)
364 ** Example 4 was the same as example 3, now changed to demo ToUnicode.
366 ** Documentation improvements.
368 ** Prototype cleanups.
369 The proper enum types (Stringprep_rc, Idna_rc, etc) are now used in
370 several places where plain int where used before. String lengths are
371 handled by (s)size_t instead of int.
373 ** API and ABI is backwards compatible with the previous version.
375 * Version 0.2.2 (released 2003-08-13)
377 ** Fixed problem with strings longer than 4GB in punycode functions.
378 The punycode code cannot handle strings longer than 4GB. The code now
379 return PUNYCODE_BAD_INPUT on too long input, instead of failing in an
382 ** The "idn --idna-to-unicode" command now output locale encoded strings.
384 ** Build fixes, bug fixes.
386 ** API and ABI is backwards compatible with the previous version.
388 * Version 0.2.1 (released 2003-07-04)
390 ** Don't reject zero-length trailing labels as in, e.g., "www.example.org.".
391 The IDNA RFC is not clear on this topic, zero-length labels in general
392 are forbidden by the ToASCII algorithm in section 4.1 step 8, but the
393 terminology section define, inside a parenthesis, that the zero-length
394 root label is in fact not considered a label at all in IDNA.
398 ** API and ABI is backwards compatible with the previous version.
400 * Version 0.2.0 (released 2003-06-19)
402 ** Unicode code point data is now uint32_t, defined in "idn-int.h".
403 A header file "idn-int.h" is generated and installed to make sure the
404 "uint32_t" data type is available on all platforms. The reason for
405 this change is that on 64-bit platforms, the application was required
406 to convert 32 bit integers (which is how Unicode code points are
407 typically represented) into 64 bit integers before calling libidn
410 ** New idna_*() functions have improved flags handling.
411 The allowunassigned and usestd3asciirules parameters were collapsed
412 into a flags parameter, that can take on the IDNA_ALLOW_UNASSIGNED and
413 IDNA_USE_STD3_ASCII_RULES values. This allows for easier extensions
414 to support, e.g., Unicode 4.0 or RFC 952 ASCII rules checking. Note
415 that the old entry points are unmodified (in this regard), and new
416 entry points with this modification were added.
418 ** The manual was moved into a separate directory doc/.
422 ** API and ABI is not backwards compatible.
423 In punycode.h and stringprep.h the "unsigned long" data type was
424 changed into "uint32_t", which cause a API and ABI missmatch. For
425 idna.h, the old entry points that used "unsigned long" still exist,
426 and new entry points that uses "uint32_t" was added. To update your
427 application, you probably only need to change "unsigned long" to
428 "uint32_t". As a result of these changes, the shared object version
431 * Version 0.1.15 (released 2003-06-07)
435 ** API and ABI is backwards compatible with the previous version.
437 * Version 0.1.14 (released 2003-05-10)
439 ** Experimental documentation generation in contrib/doxygen/.
440 Simply invoke "doxygen" in that directory and it should build the
443 ** Lisp API bug fixes.
445 ** API and ABI is backwards compatible with the previous version.
447 * Version 0.1.13 (released 2003-03-13)
449 ** Unfinished Java *.class files implementing the libidn API.
450 See the contrib/java/ directory. It is implemented using the Java
451 Native Interface, and light initial testing indicate interoperability
452 between GCJ, IBM's JDK and Sun's JDK.
454 ** Building is now silent when gengetopt is not present.
458 ** API and ABI is backwards compatible with the previous version.
460 * Version 0.1.12 (released 2003-03-06)
462 ** Building libidn doesn't require gengetopt.
463 Warnings are still printed though. Gengetopt will be replaced by argp
466 ** Command line tool "idn" supports stringprep too.
468 ** New stringprep API entry point: stringprep_profile().
469 It takes a name of the stringprep profile as an argument instead of
470 the stringprep table structure.
472 ** stringprep_*.h are deprecated and will be removed in the future.
473 All symbols have been moved to stringprep.h. The reasons are that (1)
474 the files typically only defined one CPP macro and exported one symbol
475 definition, which is wasteful as it generates too much work in the
476 manual, and (2) using one header file for all profiles allows easier
477 access to all stringprep profiles during runtime. Note that the files
478 are still installed, but they only #include stringprep.h now, for
479 backwards compatibility.
481 ** GNU Libc add-on build instructions updated to GNU Libc 2.3.2.
483 ** SASLprep stringprep profile added.
485 ** An online interface to libidn written in PHP added to contrib/web/.
487 ** API and ABI is backwards compatible with the previous version.
489 * Version 0.1.11 (released 2003-02-26)
491 ** Command line application "idn" is included.
492 A simple wrapper around the library that allows you to invoke punycode
493 encoding/decoding and IDNA ToASCII/ToUnicode on the command line.
495 ** Emacs Lisp interface for punycode and IDNA included.
496 See punycode.el and idna.el.
498 ** API and ABI is backwards compatible with the previous version.
500 * Version 0.1.10 (released 2003-02-21)
502 ** idna_*_to_ace() and idna_*ace_to_*() are deprecated in favor of
503 ** idna_to_ascii_from_*() and idna_to_unicode_*_from_*() respectively.
504 The reason was that the old interfaces did not accept the
505 AllowUnassigned and UseSTD3ASCIIRules flags. Note that the old
506 functions are not removed, but will be in the future.
508 ** IPS iSCSI stringprep profile added.
510 ** A new contrib/ directory added.
511 Currently it contains a Python interface to Libidn, contributed by
514 ** idna.h and punycode.h are now installed by "make install".
516 ** API and ABI is backwards compatible with the previous version.
518 * Version 0.1.9 (released 2003-02-20)
520 ** SASL ANONYMOUS "plain" stringprep profile added.
522 ** XMPP nodeprep profile fixed.
524 ** API and ABI is backwards compatible with the previous version.
525 For future releases, the NEWS entry will specifically mention whether
526 the C header API or library ABI backwards compatibility is affected.
528 * Version 0.1.8 (released 2003-02-14)
530 ** Portability fixes.
531 This includes not building the API Reference Manual with GTK-DOC by
532 default, if you want it use configure parameter --enable-gtk-doc after
533 making sure your gtkdoc-mkdb accept the --tmpl-dir parameter.
535 ** The type for string length variables is now (s)size_t.
536 Unfortunately this means binary shared library binary backwards
539 ** New nameprep test vectors.
541 * Version 0.1.7 (released 2003-02-12)
543 ** Uses official IDNA ACE prefix.
545 * Version 0.1.6 (released 2003-02-11)
547 ** Uses tentative IDNA ACE prefix.
549 ** Added XMPP Node/Resource Identifiers stringprep profiles.
551 ** Fixed prohibited character checks for bidi.
553 * Version 0.1.5 (released 2003-01-28)
555 ** The library can now be built as part of GNU Libc.
556 This is experimental and only tested against GNU Libc version 2.3.1.
557 See the libc/ directory, and libc/README in particular.
561 * Version 0.1.4 (released 2003-01-15)
563 ** Documentation fixes.
565 ** Portability fixes.
569 * Version 0.1.3 (released 2003-01-15)
571 ** Added texinfo manual.
573 * Version 0.1.2 (released 2003-01-08)
575 ** Added high-level IDNA API.
577 ** Added example3.c and example4.c demonstrating the high-level IDNA API.
579 * Version 0.1.1 (released 2003-01-08)
581 ** Added documentation using GTK-DOC.
583 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
584 By accident it was never removed in 0.1.0.
586 * Version 0.1.0 (released 2003-01-05)
588 ** Official GNU project.
590 ** Renamed from libstringprep to libidn.
592 ** Supports punycode and IDNA. Caveat emptor: I don't use it myself.
594 ** Uses "unsigned long" for Unicode code points instead of "long".
595 Long is guaranteed to be at least 32 bits by C standards so it is
596 always sufficiently large, no need to use uint32_t and the like.
598 ** The obsolete stringprep_utf8_to_ucs4_fast API entry point was removed.
600 * Version 0.0.8 (released 2002-12-13)
602 ** Portability fixes (now works under Cygwin on Windows 2000).
606 * Version 0.0.7 (released 2002-12-09)
608 ** Apply all tables to entire strings, not just first hit.
612 * Version 0.0.5 (released 2002-12-07)
614 ** Fix prohibited characters handling.
618 ** Renamed type (struct) stringprep_table_element to Stringprep_table_element.
620 ** Renamed type stringprep_profile to Stringprep_profile.
622 ** Renamed type (struct) stringprep_table to Stringprep_table.
624 ** Added more self-tests.
626 * Version 0.0.4 (released 2002-12-06)
628 ** Add unassigned code point handling, including self test cases.
630 ** Portability fixes.
632 * Version 0.0.3 (released 2002-11-30)
634 ** Exported utility function `stringprep_utf8_to_unichar', complementary
635 to existing `stringprep_unichar_to_utf8'.
637 ** Renamed `stringprep_utf8_to_ucs4_fast' to `stringprep_utf8_to_ucs4' to
638 clean up API. The old entry point is maintained for binary backwards
639 compatibility though.
641 ** The distribution is from now on signed using GnuPG.
645 * Version 0.0.2 (released 2002-11-07)
651 * Version 0.0.1 (released 2002-11-06)
653 ** Add utility functions stringprep_locale_charset(), stringprep_convert()
654 and stringprep_locale_to_utf8 () that can be used to convert text from
655 system's locale into UTF-8, which should be done before invoking
656 stringprep(). The functions requires iconv() in the operating system.
658 ** An example program (example.c) that illustrates how libstringprep can be
661 ** The pkg-config --libs output should now include necessary -R options.
663 * Version 0.0.0 (released 2002-11-05)
667 ----------------------------------------------------------------------
668 Copying and distribution of this file, with or without modification,
669 are permitted in any medium without royalty provided the copyright
670 notice and this notice are preserved.