diff options
| author | Stefan Hajnoczi <stefanha@linux.vnet.ibm.com> | 2010-10-20 16:41:31 +0000 |
|---|---|---|
| committer | Blue Swirl <blauwirbel@gmail.com> | 2010-10-20 16:41:31 +0000 |
| commit | cf85cf8e972f3ad79f203be4edb7968d6e052293 (patch) | |
| tree | 1f19652104c3f1ec25923066ced22a496bcee92d | |
| parent | d8023f311499e06c02b4da7e74388d7ad906ea23 (diff) | |
trace: Format strings must begin/end with double quotes
Document the restriction that format strings must begin and end with
double quotes. This is for easy parsing since we don't run cpp over
trace-events.
Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
Signed-off-by: Blue Swirl <blauwirbel@gmail.com>
| -rw-r--r-- | docs/tracing.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/tracing.txt b/docs/tracing.txt index 5504850857..963c5047fe 100644 --- a/docs/tracing.txt +++ b/docs/tracing.txt @@ -74,7 +74,10 @@ Trace events should use types as follows: 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. +respectively. This ensures portability between 32- and 64-bit platforms. Note +that format strings must begin and end with double quotes. When using +portability macros, ensure they are preceded and followed by double quotes: +"value %"PRIx64"". === Hints for adding new trace events === |