From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Tue, 23 Dec 2014 16:33:22 +0000 (+0200)
Subject: updated documentation of gnutls_memcmp()
X-Git-Tag: gnutls_3_4_0~437
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fd9bd5e3721664751f457b2f5e49dddcea74cdbb;p=thirdparty%2Fgnutls.git

updated documentation of gnutls_memcmp()
---

diff --git a/lib/safe-memfuncs.c b/lib/safe-memfuncs.c
index e18eff403c..f0a4975414 100644
--- a/lib/safe-memfuncs.c
+++ b/lib/safe-memfuncs.c
@@ -59,11 +59,11 @@ void gnutls_memset(void *data, int c, size_t size)
  * @s2: the second address to compare
  * @n: the size of memory to compare
  *
- * This function will operate similarly to memcmp(), but instead
- * of comparing it will return 0 on memory match and non-zero
- * on difference.
+ * This function will operate similarly to memcmp(), but will operate
+ * on time that depends only on the size of the string. That is will
+ * not return early if the strings don't match on the first byte.
  *
- * Returns: void.
+ * Returns: non zero on difference and zero if the buffers are identical.
  *
  * Since: 3.4.0
  **/