From: Brian Norris <banorris@uci.edu>
Date: Thu, 6 Jun 2013 00:13:55 +0000 (-0700)
Subject: execution: document promises list; it is assumed to be sorted
X-Git-Tag: oopsla2013-final~9
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=commitdiff_plain;h=c3240e7376fc80855529257647bd010a2cce7d6f;ds=sidebyside

execution: document promises list; it is assumed to be sorted

Document the assumptions made about the 'promises' list.
---

diff --git a/execution.h b/execution.h
index ab4df36..9c9c1ca 100644
--- a/execution.h
+++ b/execution.h
@@ -202,6 +202,13 @@ private:
 	HashTable<const void *, action_list_t *, uintptr_t, 4> condvar_waiters_map;
 
 	HashTable<void *, SnapVector<action_list_t> *, uintptr_t, 4> obj_thrd_map;
+
+	/**
+	 * @brief List of currently-pending promises
+	 *
+	 * Promises are sorted by the execution order of the read(s) which
+	 * created them
+	 */
 	SnapVector<Promise *> promises;
 	SnapVector<struct PendingFutureValue> futurevalues;