updated documentation

6 files changed, 31 insertions, 7 deletions

diff --git a/configure.in b/configure.in
index d3af7f38b5..126d667f16 100644
--- a/configure.in
+++ b/configure.in
@@ -11,12 +11,9 @@ AC_DEFINE_UNQUOTED(T_VENDOR, "$target_vendor")
 AC_DEFINE_UNQUOTED(T_OS, "$target_os")
 
 GNUTLS_MAJOR_VERSION=0
-GNUTLS_MINOR_VERSION=2
-GNUTLS_MICRO_VERSION=92
-GNUTLS_VERSION=$GNUTLS_MAJOR_VERSION.$GNUTLS_MINOR_VERSION.$GNUTLS_MICRO_VERSION
-GNUTLS_MAJOR_VERSION=0
 GNUTLS_MINOR_VERSION=3
 GNUTLS_MICRO_VERSION=0
+GNUTLS_VERSION=$GNUTLS_MAJOR_VERSION.$GNUTLS_MINOR_VERSION.$GNUTLS_MICRO_VERSION
 
 AC_DEFINE_UNQUOTED(GNUTLS_VERSION, "$GNUTLS_VERSION")
 
diff --git a/doc/README.autoconf b/doc/README.autoconf
index 125cc79155..f55a6dbb0a 100644
--- a/doc/README.autoconf
+++ b/doc/README.autoconf
@@ -5,7 +5,7 @@ aclocal.m4:
  include(libgnutls.m4)
 
 configure.in:
- AM_PATH_LIBGNUTLS( 0.2.3,, AC_MSG_ERROR([[*** gnutls was not found]]))
+ AM_PATH_LIBGNUTLS( 0.3.0,, AC_MSG_ERROR([[*** gnutls was not found]]))
 
 
 these macros define LIBGNUTLS_LIBS and LIBGNUTLS_CFLAGS.
diff --git a/doc/tex/Makefile.am b/doc/tex/Makefile.am
index 4747e98ac3..19589ea02b 100644
--- a/doc/tex/Makefile.am
+++ b/doc/tex/Makefile.am
@@ -6,7 +6,7 @@ EXTRA_DIST = gnutls.tex gnutls.ps gnutls.html  \
 
 TEX_OBJECTS = gnutls.tex ../../lib/gnutls-api.tex serv1.tex ex1.tex ex2.tex ex3.tex fdl.tex \
 	macros.tex cover.tex ciphersuites.tex resumedb.tex translayer.tex asn1.tex ../../lib/asn1-api.tex \
-	auth.tex ciphers.tex
+	auth.tex ciphers.tex errors.tex
 
 gnutls.ps: $(TEX_OBJECTS)
 	-$(LN_S) ../../lib/gnutls-api.tex .
diff --git a/doc/tex/errors.tex b/doc/tex/errors.tex
new file mode 100644
index 0000000000..effeec380b
--- /dev/null
+++ b/doc/tex/errors.tex
@@ -0,0 +1,25 @@
+\section{Error Handling}
+\par
+In \gnutls most functions return an integer type as a result.
+In almost all cases a zero or a positive number means success, and
+a negative number indicates failure, or a situation that some
+action has to be taken. Thus negative error codes may be fatal
+or not. 
+\par 
+Fatal errors terminate the connection immediately and
+further sends ard receives will be disallowed. An example of
+a fatal error code is GNUTLS\_E\_MAC\_FAILED. Non-fatal errors
+may warn about something (ie a warning alert was received), or
+indicate the some action has to be taken. This is the case with
+the error code GNUTLS\_E\_REHANDSHAKE returned by 
+\hyperref{gnutls\_read()}{gnutls\_read() (see Section }{
+for more information)}{gnutls_read}.
+This error code requires a full handshake to be performed (again), or an alert to be sent.
+You can test if an error code is a fatal one by using the
+\hyperref{gnutls\_is\_fatal\_error()}{gnutls\_is\_fatal\_error() (see Section }{
+for more information)}{gnutls_is_fatal_error}.
+\par
+If any non fatal errors, that require reaction, are to be returned by a
+function, these error codes will be documented
+in the function's reference.
+
diff --git a/doc/tex/gnutls.tex b/doc/tex/gnutls.tex
index 2493ade030..9dc4b1686b 100644
--- a/doc/tex/gnutls.tex
+++ b/doc/tex/gnutls.tex
@@ -57,6 +57,8 @@ in order to be able to export encryption software from some countries.}
 
 \input{translayer}
 
+\input{errors}
+
 \section{Client Examples}
 This section contains examples of TLS and SSL clients, using \gnutls. 
 
diff --git a/lib/auth_x509.c b/lib/auth_x509.c
index cbe1b5f96d..e95152e15a 100644
--- a/lib/auth_x509.c
+++ b/lib/auth_x509.c
@@ -1209,7 +1209,7 @@ int gnutls_x509pki_extract_certificate_version(const gnutls_datum * cert)
   * @state: is a gnutls state
   *
   * This function will try to verify the peer's certificate and return it's status (TRUSTED, EXPIRED etc.). 
-  * Status should be one of the CertificateStatus enumerated elements.
+  * The return value (status) should be one of the CertificateStatus enumerated elements.
   * However you must also check the peer's name in order to check if the verified certificate belongs to the 
   * actual peer. Returns a negative error code in case of an error, or GNUTLS_CERT_NONE if no certificate was sent.
   *