aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStefan Hajnoczi <stefanha@linux.vnet.ibm.com>2011-04-14 18:24:50 +0100
committerStefan Hajnoczi <stefanha@linux.vnet.ibm.com>2011-04-26 13:14:49 +0100
commite6a750aab57e4dccefd6291dba4fee6b9b3bf9ee (patch)
tree65ae95365c50e66cf0c9a3ffde215c198bfea035 /docs
parentb4548fcc0314f5e118ed45b5774e9cd99f9a97d3 (diff)
docs: Trace events must not expect pointer dereferencing
Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/tracing.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/tracing.txt b/docs/tracing.txt
index f15069c96b..905a0837db 100644
--- a/docs/tracing.txt
+++ b/docs/tracing.txt
@@ -69,6 +69,11 @@ Trace events should use types as follows:
cannot include all user-defined struct declarations and it is therefore
necessary to use void * for pointers to structs.
+ Pointers (including char *) cannot be dereferenced easily (or at all) in
+ some trace backends. If pointers are used, ensure they are meaningful by
+ themselves and do not assume the data they point to will be traced. Do
+ not pass in string arguments.
+
* For everything else, use primitive scalar types (char, int, long) with the
appropriate signedness.