From: VMware, Inc <>
Date: Mon, 26 Jul 2010 18:27:45 +0000 (-0700)
Subject: lib/misc: improve HashTable_Free comments
X-Git-Tag: 2010.07.25-280253~81
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=89588b779bbf2840104940435168c28ca6dbe653;p=thirdparty%2Fopen-vm-tools.git

lib/misc: improve HashTable_Free comments

Clearly spell out the difference between free and unsafe free.

Signed-off-by: Marcelo Vanzin <mvanzin@vmware.com>
---

diff --git a/open-vm-tools/lib/misc/hashTable.c b/open-vm-tools/lib/misc/hashTable.c
index 4b80ec40f..5d11264e7 100644
--- a/open-vm-tools/lib/misc/hashTable.c
+++ b/open-vm-tools/lib/misc/hashTable.c
@@ -375,7 +375,8 @@ HashTable_Clear(HashTable *ht)  // IN/OUT:
  *
  * HashTable_Free --
  *
- *      Free the hash table skeleton.
+ *      Free the hash table skeleton. Do not call this if the hashTable is
+ *      atomic; use HashTable_FreeUnsafe and HEED THE RESTRICTIONS!
  *
  * Results:
  *      None.