changeset 51:2debfd8f9736

common: further document the semantics of nvclock_cmp_total Signed-off-by: Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
author Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
date Wed, 01 Jul 2015 20:29:50 -0400
parents 89b2b8ae97c3
children 1c6dc4723f72
files src/common/vclock.c
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/common/vclock.c	Wed Jul 01 20:27:33 2015 -0400
+++ b/src/common/vclock.c	Wed Jul 01 20:29:50 2015 -0400
@@ -316,6 +316,9 @@
 	 * should return -1 or +1.  (We cannot return 0 since that'd imply
 	 * that the two clocks are equivalent - and they definitely aren't.)
 	 *
+	 * Note that (c1, c2) must return the opposite value of (c2, c1)
+	 * otherwise this comparator can't be used to sort deterministically.
+	 *
 	 * XXX: describe algo
 	 */