From: Simon Josefsson <simon@josefsson.org>
Date: Wed, 27 May 2009 05:38:04 +0000 (+0200)
Subject: Doc fix.
X-Git-Tag: gnutls_2_8_0~8
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8f4c475ce3e865a1352369a0f1344fbef422f036;p=thirdparty%2Fgnutls.git

Doc fix.
Reported by Peter Hendrickson <pdh@wiredyne.com>.
---

diff --git a/lib/gnutls_ui.c b/lib/gnutls_ui.c
index bd30a7e698..cedf1a0d47 100644
--- a/lib/gnutls_ui.c
+++ b/lib/gnutls_ui.c
@@ -295,10 +295,13 @@ gnutls_dh_get_secret_bits (gnutls_session_t session)
  *
  * This function will return the bits of the prime used in the last
  * Diffie-Hellman authentication with the peer.  Should be used for
- * both anonymous and ephemeral Diffie-Hellman.
+ * both anonymous and ephemeral Diffie-Hellman.  Note that some
+ * ciphers, like RSA and DSA without DHE, does not use a
+ * Diffie-Hellman exchange, and then this function will return 0.
  *
- * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
- *   an error code is returned.
+ * Returns: The Diffie-Hellman bit strength is returned, or 0 if no
+ *   Diffie-Hellman exchange was done, or a negative error code on
+ *   failure.
  **/
 int
 gnutls_dh_get_prime_bits (gnutls_session_t session)