From 861d4eef63233c5d9caf011d54f457b7f309c59e Mon Sep 17 00:00:00 2001 From: Justin Seyster Date: Thu, 21 Oct 2010 14:52:09 -0400 Subject: [PATCH] Added documentation for noinstrument. --- src/aop-doxy-main.c | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/aop-doxy-main.c b/src/aop-doxy-main.c index eafdde8..5a81972 100644 --- a/src/aop-doxy-main.c +++ b/src/aop-doxy-main.c @@ -122,6 +122,25 @@ * - struct aop_joinpoint * - struct aop_dynval * - struct aop_type + * + * \section noinstrument Noinstrument + * + * InterAspect adds a noinstrument attribute that you can + * use to disable instrumentation for a specific function in the + * target program. Any pass that you register with + * aop_register_pass() will skip over functions marked + * noinstrument. + * + * You can mark a function with this attribute using GCC's attribute + * syntax: + * \code + * __attribute__((noinstrument)) void foo() { + * \endcode + * + * The noinstrument attribute is especially useful for + * ensuring that advice functions and the functions they call do not + * themselves get instrumented (which can cause unbounded recursion + * and other problems). */ /** -- 2.34.1