From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([140.186.70.92]:44089) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QEhLM-0002Z0-DV for qemu-devel@nongnu.org; Tue, 26 Apr 2011 08:26:20 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QEhLL-00036m-AU for qemu-devel@nongnu.org; Tue, 26 Apr 2011 08:26:16 -0400 Received: from mtagate2.uk.ibm.com ([194.196.100.162]:45056) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QEhLK-00036J-S2 for qemu-devel@nongnu.org; Tue, 26 Apr 2011 08:26:15 -0400 Received: from d06nrmr1307.portsmouth.uk.ibm.com (d06nrmr1307.portsmouth.uk.ibm.com [9.149.38.129]) by mtagate2.uk.ibm.com (8.13.1/8.13.1) with ESMTP id p3QCQC0r018463 for ; Tue, 26 Apr 2011 12:26:12 GMT Received: from d06av09.portsmouth.uk.ibm.com (d06av09.portsmouth.uk.ibm.com [9.149.37.250]) by d06nrmr1307.portsmouth.uk.ibm.com (8.13.8/8.13.8/NCO v10.0) with ESMTP id p3QCREdn1839188 for ; Tue, 26 Apr 2011 13:27:15 +0100 Received: from d06av09.portsmouth.uk.ibm.com (loopback [127.0.0.1]) by d06av09.portsmouth.uk.ibm.com (8.14.4/8.13.1/NCO v10.0 AVout) with ESMTP id p3QCQBCw031771 for ; Tue, 26 Apr 2011 06:26:11 -0600 From: Stefan Hajnoczi Date: Tue, 26 Apr 2011 13:26:01 +0100 Message-Id: <1303820763-6720-5-git-send-email-stefanha@linux.vnet.ibm.com> In-Reply-To: <1303820763-6720-1-git-send-email-stefanha@linux.vnet.ibm.com> References: <1303820763-6720-1-git-send-email-stefanha@linux.vnet.ibm.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PATCH 4/6] docs/tracing.txt: minor documentation fixes List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Anthony Liguori Cc: =?UTF-8?q?Llu=C3=ADs=20Vilanova?= , qemu-devel@nongnu.org, Stefan Hajnoczi , =?UTF-8?q?Llu=C3=ADs?= From: Llu=C3=ADs Signed-off-by: Llu=C3=ADs Vilanova Signed-off-by: Stefan Hajnoczi --- 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. =20 =3D=3D Trace events =3D=3D =20 -There is a set of static trace events declared in the trace-events sourc= e +There is a set of static trace events declared in the "trace-events" sou= rce file. Each trace event declaration names the event, its arguments, and = the format string which can be used for pretty-printing: =20 qemu_malloc(size_t size, void *ptr) "size %zu ptr %p" qemu_free(void *ptr) "ptr %p" =20 -The trace-events file is processed by the tracetool script during build = to +The "trace-events" file is processed by the "tracetool" script during bu= ild to generate code for the trace events. Trace events are invoked directly f= rom source code like this: =20 @@ -52,10 +52,10 @@ source code like this: =20 =3D=3D=3D Declaring trace events =3D=3D=3D =20 -The tracetool script produces the trace.h header file which is included = by +The "tracetool" script produces the trace.h header file which is include= d by every source file that uses trace events. Since many source files inclu= de -trace.h, it uses a minimum of types and other header files included to k= eep -the namespace clean and compile times and dependencies down. +trace.h, it uses a minimum of types and other header files included to k= eep the +namespace clean and compile times and dependencies down. =20 Trace events should use types as follows: =20 @@ -110,10 +110,10 @@ portability macros, ensure they are preceded and fo= llowed by double quotes: =20 =3D=3D Trace backends =3D=3D =20 -The tracetool script automates tedious trace event code generation and a= lso +The "tracetool" script automates tedious trace event code generation and= also keeps the trace event declarations independent of the trace backend. Th= e trace events are not tightly coupled to a specific trace backend, such as LTTn= g or -SystemTap. Support for trace backends can be added by extending the tra= cetool +SystemTap. Support for trace backends can be added by extending the "tr= acetool" script. =20 The trace backend is chosen at configure time and only one trace backend= can @@ -181,12 +181,12 @@ events at runtime inside QEMU: =3D=3D=3D=3D Analyzing trace files =3D=3D=3D=3D =20 The "simple" backend produces binary trace files that can be formatted w= ith the -simpletrace.py script. The script takes the trace-events file and the b= inary +simpletrace.py script. The script takes the "trace-events" file and the= binary trace: =20 ./simpletrace.py trace-events trace-12345 =20 -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. =20 --=20 1.7.4.1