doc: mention that stringprep is not included and obsolete

Provide an advice on what applications requiring stringprep should do, and what new applications which require similar processing should do. Resolves #28Signed-off-by: Nikos Mavrogiannopoulos's avatarNikos Mavrogiannopoulos <nmav@gnutls.org>
parent 04c4b5ae
Pipeline #19277458 passed with stages
in 7 minutes 40 seconds
......@@ -374,6 +374,17 @@ libraries (e.g., both IDNA2003 and IDNA2008), you must define
@code{IDN2_SKIP_LIBIDN_COMPAT} prior to including @code{idn2.h}
in order to be able to use both libraries' functions.
@section Stringprep and libidn2
The original libidn library includes functionality for the stringprep protocol in
@code{stringprep.h}. That functionality was an integral part of an IDNA2003
implementation, but it does not apply to IDNA2008. Furthermore stringprep
processing has been replaced by the PRECIS framework (RFC8264).
For the reasons above, libidn2 does not implement stringprep or
any other string processing protocols unrelated to IDNA2008. Applications
requiring the stringprep processing should continue using the original
libidn, and new applications should consider using the PRECIS framework.
@node Examples
@chapter Examples
@cindex Examples
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment