include/stap-probe.h: Add comment about SystemTap argument format

Add a comment pointing to the SystemTap wiki page that documents the
format of the arguments. Also add a pointer to the SystemTap and
gdb sources which seem to be the best place to get the architecture
specific details.

ChangeLog:

2014-02-11  Will Newton  <will.newton@linaro.org>

	* include/stap-probe.h: Add comment about probe argument
	format.

diff --git a/ChangeLog b/ChangeLog
index dc2932eb19fca16cef1a3953597ed957f623a9e3..cfd48c02cb5dc498932ba288c9779377d34f48cf 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+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

diff --git a/include/stap-probe.h b/include/stap-probe.h
index 73b88e67ee1931a47225a2b77c2730607a15c72f..688646c9e9d1097d9780949f8e68ba2761803056 100644 (file)
--- 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