aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPhilippe Mathieu-Daudé <philmd@redhat.com>2019-09-16 11:51:21 +0200
committerStefan Hajnoczi <stefanha@redhat.com>2019-09-18 10:20:15 +0100
commit9f7ad79c16ede0da01902b18fb32929cfbd20f87 (patch)
tree7df1d72d711643a8e441e8a4200f5a4a5b9bcf25 /docs
parent794dcb54b3fc3cb91d1eeb34216be3177400d6a2 (diff)
downloadqemu-9f7ad79c16ede0da01902b18fb32929cfbd20f87.zip
qemu-9f7ad79c16ede0da01902b18fb32929cfbd20f87.tar.gz
qemu-9f7ad79c16ede0da01902b18fb32929cfbd20f87.tar.bz2
trace: Forbid event format ending with newline character
Event format ending with newlines confuse the trace reports. Forbid them. Add a check to refuse new format added with trailing newline: $ make [...] GEN hw/misc/trace.h Traceback (most recent call last): File "scripts/tracetool.py", line 152, in <module> main(sys.argv) File "scripts/tracetool.py", line 143, in main events.extend(tracetool.read_events(fh, arg)) File "scripts/tracetool/__init__.py", line 367, in read_events event = Event.build(line) File "scripts/tracetool/__init__.py", line 281, in build raise ValueError("Event format can not end with a newline character") ValueError: Error at hw/misc/trace-events:121: Event format can not end with a newline character Reviewed-by: John Snow <jsnow@redhat.com> Reviewed-by: Kevin Wolf <kwolf@redhat.com> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com> Message-id: 20190916095121.29506-3-philmd@redhat.com Message-Id: <20190916095121.29506-3-philmd@redhat.com> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/devel/tracing.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/devel/tracing.txt b/docs/devel/tracing.txt
index 76e492a..8231bbf 100644
--- a/docs/devel/tracing.txt
+++ b/docs/devel/tracing.txt
@@ -112,6 +112,8 @@ 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.
+Format strings must not end with a newline character. It is the responsibility
+of backends to adapt line ending for proper logging.
Each event declaration will start with the event name, then its arguments,
finally a format string for pretty-printing. For example: