From c3240e7376fc80855529257647bd010a2cce7d6f Mon Sep 17 00:00:00 2001
From: Brian Norris <banorris@uci.edu>
Date: Wed, 5 Jun 2013 17:13:55 -0700
Subject: [PATCH] execution: document promises list; it is assumed to be sorted

Document the assumptions made about the 'promises' list.
---
 execution.h | 7 +++++++
 1 file changed, 7 insertions(+)

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;
 
-- 
2.34.1