about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog5
-rw-r--r--include/stap-probe.h10
2 files changed, 14 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index dc2932eb19..cfd48c02cb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2014-02-11  Will Newton  <will.newton@linaro.org>
 
+	* include/stap-probe.h: Add comment about probe argument
+	format.
+
+2014-02-11  Will Newton  <will.newton@linaro.org>
+
 	* malloc/mtrace.c (attribute_hidden): Remove unused macro
 	definition.  (tr_where, tr_freehook, tr_mallochook,
 	tr_reallochook, tr_memalignhook): Use ANSI protoype.
diff --git a/include/stap-probe.h b/include/stap-probe.h
index 73b88e67ee..688646c9e9 100644
--- a/include/stap-probe.h
+++ b/include/stap-probe.h
@@ -30,7 +30,15 @@
 
    Systemtap's header defines the macros STAP_PROBE (provider, name) and
    STAP_PROBEn (provider, name, arg1, ..., argn).  For "provider" we paste
-   in the IN_LIB name (libc, libpthread, etc.) automagically.  */
+   in the IN_LIB name (libc, libpthread, etc.) automagically.
+
+   The format of the arg parameters is discussed here:
+
+   https://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation
+
+   The precise details of how register names are specified is
+   architecture specific and can be found in the gdb and SystemTap
+   source code.  */
 
 # ifndef NOT_IN_libc
 #  define IN_LIB	libc