Document the alignment limitation of tor_free()

diff --git a/src/common/util.h b/src/common/util.h
index 8dc64ce9faae0b8781bbdc6aa0ed1f5d6a55d485..2ee0ea28cd9db51a84dc2c536c898a909484a2c8 100644 (file)
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -79,6 +79,11 @@ extern int dmalloc_free(const char *file, const int line, void *pnt,
  *
  * This is a macro.  If you need a function pointer to release memory from
  * tor_malloc(), use tor_free_().
+ *
+ * Note that this macro takes the address of the pointer it is going to
+ * free and clear.  If that pointer is stored with a nonstandard
+ * alignment (eg because of a "packed" pragma) it is not correct to use
+ * tor_free().
  */
 #ifdef __GNUC__
 #define tor_free(p) STMT_BEGIN                                 \