[tor-commits] [torsocks/master] Fix: better document connection registry mutex

[dgoulet at torproject.org]

commit 151f49cd7ddd0ab54cdb0f033a34340289600fe4
Author: David Goulet <dgoulet at ev0ke.net>
Date:   Thu Feb 20 11:10:14 2014 +0000

    Fix: better document connection registry mutex
    
    Signed-off-by: David Goulet <dgoulet at ev0ke.net>
---
 src/common/connection.c |    9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/src/common/connection.c b/src/common/connection.c
index ab065b1..89f991b 100644
--- a/src/common/connection.c
+++ b/src/common/connection.c
@@ -22,7 +22,14 @@
 #include "connection.h"
 #include "macros.h"
 
-/* Connection registry mutex. */
+/*
+ * Connection registry mutex.
+ *
+ * MUST be acquired for each read/write operation on the connection registry
+ * declared below.
+ *
+ * This mutex is NOT nested anywhere.
+ */
 static TSOCKS_INIT_MUTEX(connection_registry_mutex);
 
 /*