Fix documentation for gnutls_dtls_set_mtu()

It *isn't* the interface MTU, it's the transport MTU.

Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>

diff --git a/lib/gnutls_dtls.c b/lib/gnutls_dtls.c
index e798b27cca3f5b33be7b4dc3ed052d605ba4d1b3..bd3c6371dd5d2dfda34441e5e4357c995e5a95f7 100644 (file)
--- a/lib/gnutls_dtls.c
+++ b/lib/gnutls_dtls.c
@@ -570,10 +570,13 @@ void gnutls_dtls_set_timeouts (gnutls_session_t session, unsigned int retrans_ti
 /**
  * gnutls_dtls_set_mtu:
  * @session: is a #gnutls_session_t structure.
- * @mtu: The maximum transfer unit of the interface
+ * @mtu: The maximum transfer unit of the transport
  *
- * This function will set the maximum transfer unit of the interface
- * that DTLS packets are expected to leave from.
+ * This function will set the maximum transfer unit of the transport
+ * that DTLS packets are sent over. Note that this should exclude
+ * the IP (or IPv6) and UDP headers. So for DTLS over IPv6 on an
+ * Ethenet device with MTU 1500, the DTLS MTU set with this function
+ * would be 1500 - 40 (IPV6 header) - 8 (UDP header) = 1452.
  *
  * Since: 3.0
  **/