From: Nikos Mavrogiannopoulos <nmav@redhat.com>
Date: Thu, 30 Apr 2015 12:53:17 +0000 (+0200)
Subject: document the need for gnutls_transport_set_pull_timeout_function
X-Git-Tag: gnutls_3_4_1~7
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f7296f52a18acdd016304546a0f7cc2be413aa8f;p=thirdparty%2Fgnutls.git

document the need for gnutls_transport_set_pull_timeout_function
---

diff --git a/lib/gnutls_handshake.c b/lib/gnutls_handshake.c
index c6857b9373..c3e14641ab 100644
--- a/lib/gnutls_handshake.c
+++ b/lib/gnutls_handshake.c
@@ -2608,6 +2608,9 @@ int gnutls_handshake(gnutls_session_t session)
  * default value. For the DTLS protocol, the more detailed
  * gnutls_dtls_set_timeouts() is provided.
  *
+ * This function requires to set a pull timeout callback. See
+ * gnutls_transport_set_pull_timeout_function().
+ *
  * Since: 3.1.0
  **/
 void
diff --git a/lib/gnutls_record.c b/lib/gnutls_record.c
index d1c22c9dd6..d83bf098c4 100644
--- a/lib/gnutls_record.c
+++ b/lib/gnutls_record.c
@@ -1741,6 +1741,9 @@ gnutls_record_recv_seq(gnutls_session_t session, void *data,
  * to the provided value. Use an @ms value of zero to disable
  * timeout (the default).
  *
+ * This function requires to set a pull timeout callback. See
+ * gnutls_transport_set_pull_timeout_function().
+ *
  * Since: 3.1.7
  **/
 void gnutls_record_set_timeout(gnutls_session_t session, unsigned int ms)