summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/tracing.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/tracing.txt b/docs/tracing.txt
index ae01ff1378..5504850857 100644
--- a/docs/tracing.txt
+++ b/docs/tracing.txt
@@ -72,6 +72,10 @@ Trace events should use types as follows:
* For everything else, use primitive scalar types (char, int, long) with the
appropriate signedness.
+Format strings should reflect the types defined in the trace event. Take
+special care to use PRId64 and PRIu64 for int64_t and uint64_t types,
+respectively. This ensures portability between 32- and 64-bit platforms.
+
=== Hints for adding new trace events ===
1. Trace state changes in the code. Interesting points in the code usually