Clarify documentation for AOP_INT_CST.
authorJustin Seyster <jseyster@cs.sunysb.edu>
Wed, 20 Oct 2010 18:48:16 +0000 (14:48 -0400)
committerJustin Seyster <jseyster@cs.sunysb.edu>
Wed, 20 Oct 2010 18:48:16 +0000 (14:48 -0400)
src/aop.h

index fb850f1b722e9566d59a47ea334ee52b3e0c365a..ced0d8787af6c84404b88ce1b723368cf3fa36c1 100644 (file)
--- a/src/aop.h
+++ b/src/aop.h
@@ -231,8 +231,11 @@ enum aop_argkind {
 /**
  * \brief Mark an advice argument as an integer constant (int).
  *
- * Use this macro when passing an integer constant (int)
- * argument to aop_insert_advice().
+ * Use this macro when passing an integer constant (int) argument to
+ * aop_insert_advice().  Make sure the argument actually has type int,
+ * and not a different-sized type (like long on a 64-bit system).  The
+ * preprocessor cannot type check this input, and an input with the
+ * wrong type can cause a memory error.
  */
 #define AOP_INT_CST(VAL) ATA_INT_CST, VAL