]> git.ipfire.org Git - thirdparty/gnutls.git/commitdiff
updated documentation of gnutls_memcmp()
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Tue, 23 Dec 2014 16:33:22 +0000 (18:33 +0200)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Tue, 23 Dec 2014 16:35:30 +0000 (18:35 +0200)
lib/safe-memfuncs.c

index e18eff403cf66fff34c1b46f56929a32144032ee..f0a497541407f83b4d6d7ddf830914ea8b42af63 100644 (file)
@@ -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
  **/