[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 4/6] docs/tracing.txt: minor documentation fixes
From: |
Stefan Hajnoczi |
Subject: |
[Qemu-devel] [PATCH 4/6] docs/tracing.txt: minor documentation fixes |
Date: |
Tue, 26 Apr 2011 13:26:01 +0100 |
From: Lluís <address@hidden>
Signed-off-by: Lluís Vilanova <address@hidden>
Signed-off-by: Stefan Hajnoczi <address@hidden>
---
docs/tracing.txt | 18 +++++++++---------
1 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/tracing.txt b/docs/tracing.txt
index 905a083..c99a0f2 100644
--- a/docs/tracing.txt
+++ b/docs/tracing.txt
@@ -26,14 +26,14 @@ for debugging, profiling, and observing execution.
== Trace events ==
-There is a set of static trace events declared in the trace-events source
+There is a set of static trace events declared in the "trace-events" source
file. Each trace event declaration names the event, its arguments, and the
format string which can be used for pretty-printing:
qemu_malloc(size_t size, void *ptr) "size %zu ptr %p"
qemu_free(void *ptr) "ptr %p"
-The trace-events file is processed by the tracetool script during build to
+The "trace-events" file is processed by the "tracetool" script during build to
generate code for the trace events. Trace events are invoked directly from
source code like this:
@@ -52,10 +52,10 @@ source code like this:
=== Declaring trace events ===
-The tracetool script produces the trace.h header file which is included by
+The "tracetool" script produces the trace.h header file which is included by
every source file that uses trace events. Since many source files include
-trace.h, it uses a minimum of types and other header files included to keep
-the namespace clean and compile times and dependencies down.
+trace.h, it uses a minimum of types and other header files included to keep the
+namespace clean and compile times and dependencies down.
Trace events should use types as follows:
@@ -110,10 +110,10 @@ portability macros, ensure they are preceded and followed
by double quotes:
== Trace backends ==
-The tracetool script automates tedious trace event code generation and also
+The "tracetool" script automates tedious trace event code generation and also
keeps the trace event declarations independent of the trace backend. The trace
events are not tightly coupled to a specific trace backend, such as LTTng or
-SystemTap. Support for trace backends can be added by extending the tracetool
+SystemTap. Support for trace backends can be added by extending the
"tracetool"
script.
The trace backend is chosen at configure time and only one trace backend can
@@ -181,12 +181,12 @@ events at runtime inside QEMU:
==== Analyzing trace files ====
The "simple" backend produces binary trace files that can be formatted with the
-simpletrace.py script. The script takes the trace-events file and the binary
+simpletrace.py script. The script takes the "trace-events" file and the binary
trace:
./simpletrace.py trace-events trace-12345
-You must ensure that the same trace-events file was used to build QEMU,
+You must ensure that the same "trace-events" file was used to build QEMU,
otherwise trace event declarations may have changed and output will not be
consistent.
--
1.7.4.1
- [Qemu-devel] [PULL 0/6] Tracing patches, Stefan Hajnoczi, 2011/04/26
- [Qemu-devel] [PATCH 6/6] trace: [trace-events] fix print formats in some events, Stefan Hajnoczi, 2011/04/26
- [Qemu-devel] [PATCH 1/6] tracetool: allow ) in trace output string, Stefan Hajnoczi, 2011/04/26
- [Qemu-devel] [PATCH 4/6] docs/tracing.txt: minor documentation fixes,
Stefan Hajnoczi <=
- [Qemu-devel] [PATCH 5/6] trace: [ust] fix generation of 'trace.c' on events without args, Stefan Hajnoczi, 2011/04/26
- [Qemu-devel] [PATCH 2/6] trace: Remove %s in grlib trace events, Stefan Hajnoczi, 2011/04/26
- [Qemu-devel] [PATCH 3/6] docs: Trace events must not expect pointer dereferencing, Stefan Hajnoczi, 2011/04/26
- Re: [Qemu-devel] [PULL 0/6] Tracing patches, Anthony Liguori, 2011/04/26