From: Lluís <xscript@gmx.net>
To: qemu-devel@nongnu.org
Cc: stefanha@gmail.com, chouteau@adacore.com
Subject: [Qemu-devel] [PATCH v2 02/11] docs/tracing.txt: minor documentation fixes
Date: Wed, 06 Apr 2011 20:33:56 +0200 [thread overview]
Message-ID: <20110406183356.22854.35011.stgit@ginnungagap.bsc.es> (raw)
In-Reply-To: <20110406183341.22854.93929.stgit@ginnungagap.bsc.es>
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
docs/tracing.txt | 18 +++++++++---------
1 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/docs/tracing.txt b/docs/tracing.txt
index f15069c..34b0901 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:
@@ -105,10 +105,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
@@ -176,12 +176,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.
next prev parent reply other threads:[~2011-04-06 18:42 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-04-06 18:33 [Qemu-devel] [RFC][PATCH v2 00/11] trace-state: make the behaviour of "disable" consistent across all backends Lluís
2011-04-06 18:33 ` [Qemu-devel] [PATCH v2 01/11] minor whitespace/indentation fixes Lluís
2011-04-23 14:19 ` Stefan Hajnoczi
2011-04-26 10:00 ` Markus Armbruster
2011-04-06 18:33 ` Lluís [this message]
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 03/11] trace: [ust] fix generation of 'trace.c' on events without args Lluís
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 04/11] trace: [trace-events] fix print formats in some events Lluís
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 05/11] trace: [simple] minor code fixes on conditional compilation Lluís
2011-04-23 14:20 ` Stefan Hajnoczi
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 06/11] trace: generalize the "property" concept in the trace-events file Lluís
2011-04-23 14:22 ` Stefan Hajnoczi
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 07/11] trace-state: always use the "nop" backend on events with the "disable" keyword Lluís
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 08/11] trace-state: [simple] disable all trace points by default Lluís
2011-04-06 18:34 ` [Qemu-devel] [PATCH v2 09/11] trace-state: [simple] add "-trace events" argument to control initial state Lluís
2011-04-06 18:35 ` [Qemu-devel] [PATCH v2 10/11] trace-state: [stderr] add support for dynamically enabling/disabling events Lluís
2011-04-23 14:31 ` Stefan Hajnoczi
2011-04-24 6:24 ` Paolo Bonzini
2011-04-24 9:33 ` Stefan Hajnoczi
2011-04-25 10:27 ` Lluís
2011-04-25 18:10 ` Paolo Bonzini
2011-04-26 12:30 ` Fabien Chouteau
2011-04-26 12:38 ` Stefan Hajnoczi
2011-04-26 12:59 ` Paolo Bonzini
2011-04-26 14:01 ` Lluís
2011-04-06 18:35 ` [Qemu-devel] [PATCH v2 11/11] trace: enable all events Lluís
2011-04-23 14:45 ` [Qemu-devel] [RFC][PATCH v2 00/11] trace-state: make the behaviour of "disable" consistent across all backends Stefan Hajnoczi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20110406183356.22854.35011.stgit@ginnungagap.bsc.es \
--to=xscript@gmx.net \
--cc=chouteau@adacore.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).