From: Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
Date: Thu, 24 May 2007 18:04:42 +0000 (+0000)
Subject: Callgrind format: Note about event names in the example
X-Git-Tag: svn/VALGRIND_3_3_0~267
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6575e93f462efaef82f4c63fae868747f5f7a87d;p=thirdparty%2Fvalgrind.git

Callgrind format: Note about event names in the example

The added paragraph was triggered by a question on the mailing list.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6746
---

diff --git a/callgrind/docs/cl-format.xml b/callgrind/docs/cl-format.xml
index 6777551d10..41b2d236bd 100644
--- a/callgrind/docs/cl-format.xml
+++ b/callgrind/docs/cl-format.xml
@@ -49,6 +49,12 @@ the function/file specifications given directly before.</para>
 <sect2 id="cl-format.overview.example1" xreflabel="Simple Example">
 <title>Simple Example</title>
 
+<para>The event names in the following example are quite arbitrary, and are not
+related to event names used by Callgrind. Especially, cycle counts matching
+real processors probably will never be generated by any Valgrind tools, as these
+are bound to simulations of simple machine models for acceptable slowdown.
+However, any profiling tool could use the format described in this chapter.</para>
+
 <para>
 <screen>events: Cycles Instructions Flops
 fl=file.f
@@ -548,4 +554,4 @@ optional.</para>
 
 </sect1>
 
-</chapter>
\ No newline at end of file
+</chapter>