From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Sun, 28 Oct 2012 22:47:58 +0000 (+0100)
Subject: doc update
X-Git-Tag: gnutls_3_1_4~89
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=37f9f77dfe2a1f54f489f980341e76078a3f39aa;p=thirdparty%2Fgnutls.git

doc update
---

diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi
index 0e942eb9e7..7b5150b3bf 100644
--- a/doc/cha-gtls-app.texi
+++ b/doc/cha-gtls-app.texi
@@ -1093,7 +1093,7 @@ the session parameters. Before establishing a new session to the same
 server the parameters must be re-associated with the GnuTLS session
 using @funcref{gnutls_session_set_data}.
 
-@showfuncC{gnutls_session_get_data,gnutls_session_get_id2,gnutls_session_set_data}
+@showfuncC{gnutls_session_get_data2,gnutls_session_get_id2,gnutls_session_set_data}
 
 Keep in mind that sessions will be expired after some time, depending
 on the server, and a server may choose not to resume a session
diff --git a/lib/gnutls_session.c b/lib/gnutls_session.c
index 80d984cbeb..eea332c865 100644
--- a/lib/gnutls_session.c
+++ b/lib/gnutls_session.c
@@ -31,14 +31,10 @@
  * @session_data: is a pointer to space to hold the session.
  * @session_data_size: is the session_data's size, or it will be set by the function.
  *
- * Returns all session parameters, in order to support resuming.  The
- * client should call this, and keep the returned session, if he
- * wants to resume that current version later by calling
- * gnutls_session_set_data() This function must be called after a
- * successful handshake.
- *
- * Resuming sessions is really useful and speedups connections after
- * a successful one.
+ * Returns all session parameters needed to be stored to support resumption.
+ * The client should call this, and store the returned session data. A session
+ * may be resumed later by calling gnutls_session_set_data().  
+ * This function must be called after a successful handshake. 
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
@@ -86,15 +82,11 @@ error:
  * @session: is a #gnutls_session_t structure.
  * @data: is a pointer to a datum that will hold the session.
  *
- * Returns all session parameters, in order to support resuming.  The
- * client should call this, and keep the returned session, if he wants
- * to resume that current version later by calling
- * gnutls_session_set_data().  This function must be called after a
- * successful handshake.  The returned datum must be freed with
- * gnutls_free().
- *
- * Resuming sessions is really useful and speedups connections after
- * a successful one.
+ * Returns all session parameters needed to be stored to support resumption.
+ * The client should call this, and store the returned session data. A session
+ * may be resumed later by calling gnutls_session_set_data().  
+ * This function must be called after a successful handshake. 
+ * The returned @data are allocated and must be released using gnutls_free().
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.