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 6777551d106214a8133ce8c4f2c6a872e99a4f71..41b2d236bdc8460583a8874514d2918777930de5 100644 (file)
--- 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>