CVS libidn/doc

[libidn-commit]

Update of /home/cvs/libidn/doc
In directory dopio:/tmp/cvs-serv1788/doc

Modified Files:
        Makefile.am libidn.texi 
Log Message:
Add idna_strerror, pr29_strerror, punycode_strerror, stringprep_strerror,
and tld_strerror, suggested by Daniel Stenberg <address@hidden>.
Make idn.c use them.
Rename TLD_NOTLD to TLD_NO_TLD.


--- /home/cvs/libidn/doc/Makefile.am    2004/06/26 11:14:34     1.30
+++ /home/cvs/libidn/doc/Makefile.am    2004/10/02 17:03:31     1.31
@@ -56,7 +56,11 @@
 GDOC_SRC = $(top_srcdir)/lib/idna.c $(top_srcdir)/lib/nfkc.c   \
        $(top_srcdir)/lib/pr29.c $(top_srcdir)/lib/punycode.c   \
        $(top_srcdir)/lib/stringprep.c $(top_srcdir)/lib/tld.c  \
-       $(top_srcdir)/lib/toutf8.c $(top_srcdir)/lib/version.c
+       $(top_srcdir)/lib/toutf8.c $(top_srcdir)/lib/version.c \
+       $(top_srcdir)/lib/strerror-idna.c $(top_srcdir)/lib/strerror-pr29.c \
+       $(top_srcdir)/lib/strerror-punycode.c \
+       $(top_srcdir)/lib/strerror-stringprep.c \
+       $(top_srcdir)/lib/strerror-tld.c
 GDOC_TEXI_PREFIX = texi/
 GDOC_MAN_PREFIX = man/
 GDOC_MAN_EXTRA_ARGS = -module $(PACKAGE) -sourceversion $(VERSION) \
--- /home/cvs/libidn/doc/libidn.texi    2004/09/02 15:55:30     1.93
+++ /home/cvs/libidn/doc/libidn.texi    2004/10/02 17:03:31     1.94
@@ -402,10 +402,13 @@
 @cindex Installation
 @cindex Download
 
-The package can be downloaded from several places, including
address@hidden://josefsson.org/libidn/releases/}.  The latest version is
-stored in a file, e.g., @address@hidden where the
address@hidden@value{VERSION}} indicate the highest version number.
+The package can be downloaded from several places, including:
+
address@hidden://josefsson.org/libidn/releases/}
+
+The latest version is stored in a file, e.g.,
address@hidden@value{VERSION}.tar.gz} where the @address@hidden
+value is the highest version number in the directory.
 
 The package is then extracted, configured and built like many other
 packages that use Autoconf.  For detailed information on configuring
@@ -439,6 +442,11 @@
 Build the Java port into a *.JAR file.  @xref{Java API}, for more
 information.
 
address@hidden --disable-tld
+Disable the TLD module.  This would typically only be useful if you
+are building on a memory restricted platforms.  @xref{TLD Functions},
+for more information.
+
 @end table
 
 For the complete list, refer to the output from @code{configure
@@ -847,67 +855,6 @@
 here.  Look into the @file{stringprep.h} header file, and the
 @file{profiles.c} source code for the details.
 
address@hidden Return Codes
-
-All functions return a code of the @code{Stringprep_rc}
-enumerated type:
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_OK = 0}
-Successful operation.  This value is guaranteed to always be zero, the
-remaining ones are only guaranteed to hold non-zero values, for
-logical comparison purposes.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_CONTAINS_UNASSIGNED}
-String contain unassigned Unicode code points, which is forbidden by
-the profile.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_CONTAINS_PROHIBITED}
-String contain code points prohibited by the profile.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_BIDI_BOTH_L_AND_RAL}
-String contain code points with conflicting bidirection category.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_BIDI_LEADTRAIL_NOT_RAL}
-Leading and trailing character in string not of proper bidirectional
-category.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} 
{STRINGPREP_BIDI_CONTAINS_PROHIBITED}
-Contains prohibited code points detected by bidirectional code.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_TOO_SMALL_BUFFER}
-Buffer handed to function was too small.  This usually indicate a
-problem in the calling application.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_PROFILE_ERROR}
-The stringprep profile was inconsistent.  This usually indicate an
-internal error in the library.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_FLAG_ERROR}
-The supplied flag conflicted with profile.  This usually indicate a
-problem in the calling application.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_UNKNOWN_PROFILE}
-The supplied profile name was not known to the library.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_NFKC_FAILED}
-The Unicode NFKC operation failed.  This usually indicate an internal
-error in the library.
address@hidden deftypevr
-
address@hidden {Return code} {Stringprep_rc} {STRINGPREP_MALLOC_ERROR}
-The @code{malloc} was out of memory.  This is usually a fatal error.
address@hidden deftypevr
-
 @section Control Flags
 
 @deftypevr {Stringprep flags} {Stringprep_profile_flags} {STRINGPREP_NO_NFKC}
@@ -934,6 +881,10 @@
 @include texi/stringprep.texi
 @include texi/stringprep_profile.texi
 
address@hidden Error Handling
+
address@hidden texi/stringprep_strerror.texi
+
 @section Stringprep Profile Macros
 
 @deftypefun {int} stringprep_nameprep_no_unassigned (char * @var{in}, int 
@var{maxlen})
@@ -1014,29 +965,6 @@
 #include <punycode.h>
 @end example
 
address@hidden Return Codes
-
-All functions return a code of the @code{Punycode_status} enumerated
-type:
-
address@hidden {Return code} {Punycode_status} {PUNYCODE_SUCCESS = 0}
-Successful operation.  This value is guaranteed to always be zero, the
-remaining ones are only guaranteed to hold non-zero values, for
-logical comparison purposes.
address@hidden deftypevr
-
address@hidden {Return code} {Punycode_status} {PUNYCODE_BAD_INPUT}
-Input is invalid.
address@hidden deftypevr
-
address@hidden {Return code} {Punycode_status} {PUNYCODE_BIG_OUTPUT}
-Output would exceed the space provided.
address@hidden deftypevr
-
address@hidden {Return code} {Punycode_status} {PUNYCODE_OVERFLOW}
-Input needs wider integers to process.
address@hidden deftypevr
-
 @section Unicode Code Point Data Type
 
 The punycode function uses a special type to denote Unicode code
@@ -1060,6 +988,10 @@
 @include texi/punycode_encode.texi
 @include texi/punycode_decode.texi
 
address@hidden Error Handling
+
address@hidden texi/punycode_strerror.texi
+
 @c **********************************************************
 @c ********************* IDNA Functions *********************
 @c **********************************************************
@@ -1087,63 +1019,6 @@
 #include <idna.h>
 @end example
 
address@hidden Return Codes
-
-All functions return a exit code:
-
address@hidden {Return code} {Idna_rc} {IDNA_SUCCESS = 0}
-Successful operation.  This value is guaranteed to always be zero, the
-remaining ones are only guaranteed to hold non-zero values, for
-logical comparison purposes.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_STRINGPREP_ERROR
-Error during string preparation.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_PUNYCODE_ERROR
-Error during punycode operation.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_CONTAINS_NON_LDH
-For IDNA_USE_STD3_ASCII_RULES, indicate that the string contains
-non-LDH ASCII characters.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_CONTAINS_MINUS
-For IDNA_USE_STD3_ASCII_RULES, indicate that the string contains a
-leading or trailing hyphen-minus (U+002D).
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_INVALID_LENGTH
-The final output string is not within the (inclusive) range 1 to 63
-characters.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_NO_ACE_PREFIX
-The string does not contain the ACE prefix (for ToUnicode).
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_ROUNDTRIP_VERIFY_ERROR
-The ToASCII operation on output string does not equal the input.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_CONTAINS_ACE_PREFIX
-The input contains the ACE prefix (for ToASCII).
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_ICONV_ERROR
-Could not convert string in locale encoding.
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_MALLOC_ERROR
-Could not allocate buffer (this is typically a fatal error).
address@hidden deftypevr
-
address@hidden {Return code} {Idna_rc} IDNA_DLOPEN_ERROR
-Could not dlopen libcidn DSO (only used internally in libc).
address@hidden deftypevr
-
 @section Control Flags
 
 The IDNA @code{flags} parameter can take on the following values, or a
@@ -1200,6 +1075,9 @@
 @include texi/idna_to_unicode_8zlz.texi
 @include texi/idna_to_unicode_lzlz.texi
 
address@hidden Error Handling
+
address@hidden texi/idna_strerror.texi
 
 @c **********************************************************
 @c ********************** TLD Functions *********************
@@ -1240,36 +1118,6 @@
 #include <tld.h>
 @end example
 
address@hidden Return Codes
-
-Most functions return a exit code:
-
address@hidden {Return code} {Tld_rc} {TLD_SUCCESS = 0}
-Successful operation.  This value is guaranteed to always be zero, the
-remaining ones are only guaranteed to hold non-zero values, for
-logical comparison purposes.
address@hidden deftypevr
-
address@hidden {Return code} {Tld_rc} TLD_INVALID
-Invalid character found.
address@hidden deftypevr
-
address@hidden {Return code} {Tld_rc} TLD_NODATA
-No input data was provided.
address@hidden deftypevr
-
address@hidden {Return code} {Tld_rc} TLD_MALLOC_ERROR
-Error during memory allocation.
address@hidden deftypevr
-
address@hidden {Return code} {Tld_rc} TLD_ICONV_ERROR
-Error during iconv string conversion.
address@hidden deftypevr
-
address@hidden {Return code} {Tld_rc} TLD_NOTLD
-No top-level domain found in domain string.
address@hidden deftypevr
-
 @c @section Data Types
 @c
 @c @deftp {Data type} {Tld_table_element} @var{start} @var{end}
@@ -1330,6 +1178,10 @@
 @include texi/tld_check_8z.texi
 @include texi/tld_check_lz.texi
 
address@hidden Error Handling
+
address@hidden texi/tld_strerror.texi
+
 @c **********************************************************
 @c ********************** PR29 Functions ********************
 @c **********************************************************
@@ -1377,25 +1229,6 @@
 #include <pr29.h>
 @end example
 
address@hidden Return Codes
-
-Most functions return a exit code:
-
address@hidden {Return code} {Pr29_rc} {PR29_SUCCESS = 0}
-Successful operation.  This value is guaranteed to always be zero, the
-remaining ones are only guaranteed to hold non-zero values, for
-logical comparison purposes.
address@hidden deftypevr
-
address@hidden {Return code} {Pr29_rc} PR29_PROBLEM
-A problem sequence was encountered.
address@hidden deftypevr
-
address@hidden {Return code} {Pr29_rc} PR29_STRINGPREP_ERROR
-The character set conversion failed (only for @code{pr29_8} and
address@hidden).
address@hidden deftypevr
-
 @section Core Functions
 
 @include texi/pr29_4.texi
@@ -1405,6 +1238,10 @@
 @include texi/pr29_4z.texi
 @include texi/pr29_8z.texi
 
address@hidden Error Handling
+
address@hidden texi/pr29_strerror.texi
+
 @c **********************************************************
 @c ***********************  Examples  ***********************
 @c **********************************************************