From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Fri, 25 May 2001 11:56:03 +0000 (+0000)
Subject: updated documentation
X-Git-Tag: gnutls_0_1_4~70
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=192ea23ace6a8dbb2edada767d169d9b9cd7e505;p=thirdparty%2Fgnutls.git

updated documentation
---

diff --git a/doc/API b/doc/API
index 5f6b107ecc..0968412dbc 100644
--- a/doc/API
+++ b/doc/API
@@ -35,6 +35,10 @@ int gnutls_close(int cd, GNUTLS_STATE state);
 int gnutls_send_hello_request(int cd, GNUTLS_STATE state);
 	This function will renegotiate security parameters with the
 	client. This should only be called in case of a server.
+	If the client does not wish to renegotiate parameters he
+	will reply with an alert message, thus the return code will be
+	GNUTLS_E_WARNING_ALERT_RECEIVED and the alert will be
+	GNUTLS_NO_RENEGOTIATION.
 
 AlertDescription gnutls_get_last_alert( GNUTLS_STATE state);
 	Returns the last alert number received. This function