]> git.ipfire.org Git - thirdparty/valgrind.git/commitdiff
- Documented callgrind_{annotate,control} in the Callgrind manual chapter
authorNicholas Nethercote <njn@valgrind.org>
Fri, 7 Aug 2009 07:44:31 +0000 (07:44 +0000)
committerNicholas Nethercote <njn@valgrind.org>
Fri, 7 Aug 2009 07:44:31 +0000 (07:44 +0000)
  and created man pages for them.  Renamed the XML files in the process for
  consistency.

- Inlined cg-entities.xml into vg-entities.xml.

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

12 files changed:
callgrind/Makefile.am
callgrind/callgrind_annotate.in
callgrind/docs/callgrind_annotate-manpage.xml [new file with mode: 0644]
callgrind/docs/callgrind_control-manpage.xml [new file with mode: 0644]
callgrind/docs/cl-entities.xml [deleted file]
callgrind/docs/cl-format.xml
callgrind/docs/cl-manual.xml
callgrind/docs/man-annotate.xml [deleted file]
callgrind/docs/man-control.xml [deleted file]
docs/xml/manpages-index.xml
docs/xml/valgrind-manpage.xml
docs/xml/vg-entities.xml

index 12455820ee140272a529cdfa6b8845546a726aae..a580e520fe7cce814371a4a3dfaec193cb058a68 100644 (file)
@@ -1,11 +1,10 @@
 include $(top_srcdir)/Makefile.tool.am
 
 EXTRA_DIST =  \
-       docs/cl-entities.xml \
+       docs/callgrind_annotate-manpage.xml \
+       docs/callgrind_control-manpage.xml \
        docs/cl-manual.xml \
-       docs/cl-format.xml \
-       docs/man-annotate.xml \
-       docs/man-control.xml
+       docs/cl-format.xml
 
 #----------------------------------------------------------------------------
 # Headers, etc
index 5c762e24e787b18d948ee10c8d5d751469482803..60ecde0babd8020e3f73a7497b6fb779810c2dc0 100644 (file)
@@ -200,7 +200,7 @@ usage: callgrind_annotate [options] [data-file [source-files]]
 
   options for the user, with defaults in [ ], are:
     -h --help             show this message
-    -v --version          show version
+    --version             show version
     --show=A,B,C          only show figures for events A,B,C [all]
     --sort=A,B,C          sort columns by events A,B,C [event column order]
     --threshold=<0--100>  percentage of counts (of primary sort event) we
@@ -232,7 +232,7 @@ sub process_cmd_line()
         if ($arg =~ /^-/) {
 
             # --version
-            if ($arg =~ /^-v$|^--version$/) {
+            if ($arg =~ /^--version$/) {
                 die("callgrind_annotate-$version\n");
 
             # --show=A,B,C
diff --git a/callgrind/docs/callgrind_annotate-manpage.xml b/callgrind/docs/callgrind_annotate-manpage.xml
new file mode 100644 (file)
index 0000000..4232316
--- /dev/null
@@ -0,0 +1,71 @@
+<?xml version="1.0"?> <!-- -*- sgml -*- -->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+          "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
+
+
+<refentry id="callgrind-annotate">
+
+<refmeta>
+  <refentrytitle>Callgrind Annotate</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo>Release &rel-version;</refmiscinfo>
+</refmeta>
+
+<refnamediv id="a-name">
+  <refname>callgrind_annotate</refname>
+  <refpurpose>post-processing tool for the Valgrind tool Callgrind</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv id="a-synopsis">
+  <cmdsynopsis>
+    <command>callgrind_annotate</command>    
+    <arg choice="opt"><replaceable>options</replaceable></arg>
+    <arg choice="opt"><replaceable>source-files</replaceable></arg>
+  </cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id="a-description">
+<title>Description</title>
+
+<para><command>callgrind_annotate</command> takes an output file produced by
+the Valgrind tool Callgrind and prints the information in an easy-to-read form.
+</para>
+
+</refsect1>
+
+
+<refsect1 id="a-options">
+<title>Options</title>
+
+<xi:include href="cl-manual.xml" xpointer="callgrind_annotate.opts.list"
+            xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</refsect1>
+
+
+<refsect1 id="a-see_also">
+<title>See Also</title>
+
+<para>
+valgrind(1),
+<filename>&vg-docs-path;</filename> or
+<filename>&vg-docs-url;</filename>.
+</para>
+
+
+</refsect1>
+
+
+<refsect1 id="a-author">
+<title>Author</title>
+
+<para>Josef Weidendorfer &lt;&cl-email;&gt;.</para>
+
+<para>This manual page was written by 
+Philipp Frauenfelder &lt;pfrauenf@debian.org&gt;.</para>
+</refsect1>
+
+
+</refentry>
diff --git a/callgrind/docs/callgrind_control-manpage.xml b/callgrind/docs/callgrind_control-manpage.xml
new file mode 100644 (file)
index 0000000..2b5a2bd
--- /dev/null
@@ -0,0 +1,72 @@
+<?xml version="1.0"?> <!-- -*- sgml -*- -->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+          "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
+
+
+<refentry id="callgrind-control">
+<refmeta>
+  <refentrytitle>Callgrind Control</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo>Release &rel-version;</refmiscinfo>
+</refmeta>
+
+<refnamediv id="c-name">
+  <refname>callgrind_control</refname>
+  <refpurpose>observe and control programs being run by the Valgrind tool
+  Callgrind</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv id="c-synopsis">
+  <cmdsynopsis>
+    <command>callgrind_control</command>    
+    <arg choice="opt"><replaceable>options</replaceable></arg>
+    <arg choice="opt" rep="repeat"><replaceable>pid/program-name</replaceable></arg>
+  </cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id="c-description">
+<title>Description</title>
+
+<para>
+<command>callgrind_control</command> controls programs being run by the
+Valgrind tool Callgrind.  When a <command>pid/program name</command>
+argument is not specified, all applications currently being run by Callgrind
+on this system will be used for actions given by the specified option(s).
+The default action is to give some brief information about the applications
+being run by Callgrind.</para>
+
+</refsect1>
+
+
+<refsect1 id="c-options">
+<title>Options</title>
+
+
+</refsect1>
+
+
+<refsect1 id="c-see_also">
+<title>See Also</title>
+
+<para>
+valgrind(1),
+<filename>&vg-docs-path;</filename> or
+<filename>&vg-docs-url;</filename>.
+</para>
+
+</refsect1>
+
+
+<refsect1 id="c-author">
+<title>Author</title>
+
+<para>Josef Weidendorfer &lt;&cl-email;&gt;.</para>
+
+
+</refsect1>
+
+
+</refentry>
+
diff --git a/callgrind/docs/cl-entities.xml b/callgrind/docs/cl-entities.xml
deleted file mode 100644 (file)
index f5c98b5..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-<!-- website + email -->
-<!ENTITY cl-email    "Josef.Weidendorfer@gmx.de">
-
-<!-- external urls used in the docs.  kept in here because when  -->
-<!-- they change it's a real pain tracking them down in the docs -->
-<!ENTITY cl-gui      "http://kcachegrind.sourceforge.net/cgi-bin/show.cgi/KcacheGrindIndex">
-
-<!-- path/to/callgrind/docs in valgrind install tree -->
-<!-- only used in the manpages -->
-<!ENTITY cl-doc-path  "/usr/share/doc/valgrind/html/callgrind.html">
index fd86b33378d184d5ef0c3c1f286d320c34aabbfa..97b3543cb1ce6d26ac8690ccaa61f92f566dc5fe 100644 (file)
@@ -1,7 +1,7 @@
 <?xml version="1.0"?> <!-- -*- sgml -*- -->
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
-[ <!ENTITY % cl-entities SYSTEM "cl-entities.xml"> %cl-entities; ]>
+[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
 
 <chapter id="cl-format" xreflabel="Callgrind Format Specification">
 <title>Callgrind Format Specification</title>
index 21ebc2736584f6e146daab5249b2c49ec9485599..d4180b38782a6c82ff0bbd760bf3eda9d0299609 100644 (file)
@@ -1,7 +1,7 @@
 <?xml version="1.0"?> <!-- -*- sgml -*- -->
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
-[ <!ENTITY % cl-entities SYSTEM "cl-entities.xml"> %cl-entities; ]>
+[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
 
 <chapter id="cl-manual" xreflabel="Callgrind Manual">
 <title>Callgrind: a call-graph generating cache profiler</title>
@@ -33,12 +33,9 @@ of the profiling, two command line tools are provided:</para>
   <listitem>
     <para>This command reads in the profile data, and prints a
     sorted lists of functions, optionally with source annotation.</para>
-<!--
-    <para>You can read the manpage here: <xref
-             linkend="callgrind-annotate"/>.</para>
--->
+
     <para>For graphical visualization of the data, try
-    <ulink url="&cl-gui;">KCachegrind</ulink>, which is a KDE/Qt based
+    <ulink url="&cl-gui-url;">KCachegrind</ulink>, which is a KDE/Qt based
     GUI that makes it easy to navigate the large amount of data that
     Callgrind produces.</para>
 
@@ -53,9 +50,6 @@ of the profiling, two command line tools are provided:</para>
     the application.  You can 
     get statistics information as well as the current stack trace, and
     you can request zeroing of counters or dumping of profile data.</para>
-<!--
-    <para>You can read the manpage here: <xref linkend="callgrind-control"/>.</para>
--->
   </listitem>
   </varlistentry>
 </variablelist>
@@ -172,7 +166,7 @@ on heuristics to detect calls and returns.</para>
   </para>
 
   <para>For better call graph browsing experience, it is highly recommended
-  to use <ulink url="&cl-gui;">KCachegrind</ulink>.
+  to use <ulink url="&cl-gui-url;">KCachegrind</ulink>.
   If your code
   has a significant fraction of its cost in <emphasis>cycles</emphasis> (sets
   of functions calling each other in a recursive manner), you have to
@@ -262,7 +256,7 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa
       must be actively running for detection of the dump command. So,
       for a GUI application, resize the window, or for a server, send a
       request.</para>
-      <para>If you are using <ulink url="&cl-gui;">KCachegrind</ulink>
+      <para>If you are using <ulink url="&cl-gui-url;">KCachegrind</ulink>
       for browsing of profile information, you can use the toolbar
       button <command>Force dump</command>. This will request a dump
       and trigger a reload after the dump is written.</para>
@@ -489,8 +483,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa
 </sect1>
 
 
-<sect1 id="cl-manual.options" xreflabel="Command line option reference">
-<title>Command line option reference</title>
+<sect1 id="cl-manual.options" xreflabel="Callgrind Options">
+<title>Callgrind Options</title>
 
 <para>
 In the following, options are grouped into classes.
@@ -515,6 +509,7 @@ parameter signature. </para>
 These options influence the name and format of the profile data files.
 </para>
 
+<!-- start of xi:include in the manpage -->
 <variablelist id="cl.opts.list.creation">
 
   <varlistentry id="opt.callgrind-out-file" xreflabel="--callgrind-out-file">
@@ -609,6 +604,7 @@ be executed. For interactive control use
 <computeroutput>callgrind_control</computeroutput>.
 </para>
 
+<!-- start of xi:include in the manpage -->
 <variablelist id="cl.opts.list.activity">
 
   <varlistentry id="opt.dump-every-bb" xreflabel="--dump-every-bb">
@@ -652,6 +648,7 @@ be executed. For interactive control use
   </varlistentry>
 
 </variablelist>
+<!-- end of xi:include in the manpage -->
 </sect2>
 
 <sect2 id="cl-manual.options.collection"
@@ -662,6 +659,7 @@ be executed. For interactive control use
 These options specify when events are to be aggregated into event counts.
 Also see <xref linkend="cl-manual.limits"/>.</para>
 
+<!-- start of xi:include in the manpage -->
 <variablelist id="cl.opts.list.collection">
 
   <varlistentry id="opt.instr-atstart" xreflabel="--instr-atstart">
@@ -761,6 +759,7 @@ Also see <xref linkend="cl-manual.limits"/>.</para>
   </varlistentry>
 
 </variablelist>
+<!-- end of xi:include in the manpage -->
 </sect2>
 
 <sect2 id="cl-manual.options.separation"
@@ -775,6 +774,7 @@ call chain leading to a function should be taken into account,
 and whether the thread ID should be considered.
 Also see <xref linkend="cl-manual.cycles"/>.</para>
 
+<!-- start of xi:include in the manpage -->
 <variablelist id="cmd-options.separation">
 
   <varlistentry id="opt.separate-threads" xreflabel="--separate-threads">
@@ -883,12 +883,14 @@ Also see <xref linkend="cl-manual.cycles"/>.</para>
 --> 
 
 </variablelist>
+<!-- end of xi:include in the manpage -->
 </sect2>
 
 <sect2 id="cl-manual.options.simulation"
        xreflabel="Cache simulation options">
 <title>Cache simulation options</title>
 
+<!-- start of xi:include in the manpage -->
 <variablelist id="cl.opts.list.simulation">
   
   <varlistentry id="opt.simulate-cache" xreflabel="--simulate-cache">
@@ -1004,6 +1006,7 @@ Also see <xref linkend="cl-manual.cycles"/>.</para>
     </listitem>
   </varlistentry>
 </variablelist>
+<!-- end of xi:include in the manpage -->
 
 </sect2>
 
@@ -1094,4 +1097,181 @@ their arguments.</para>
 
 </sect1>
 
+
+
+<sect1 id="cl-manual.callgrind_annotate-options" xreflabel="callgrind_annotate Options">
+<title>callgrind_annotate Options</title>
+
+<!-- start of xi:include in the manpage -->
+<variablelist id="callgrind_annotate.opts.list">
+
+  <varlistentry>
+    <term><option>-h --help</option></term>
+    <listitem>
+      <para>Show summary of options.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>--version</option></term>
+    <listitem>
+      <para>Show version of callgrind_annotate.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option>--show=A,B,C [default: all]</option>
+    </term>
+    <listitem>
+      <para>Only show figures for events A,B,C.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option>--sort=A,B,C</option>
+    </term>
+    <listitem>
+      <para>Sort columns by events A,B,C [event column order].</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option><![CDATA[--threshold=<0--100> [default: 99%] ]]></option>
+    </term>
+    <listitem>
+      <para>Percentage of counts (of primary sort event) we are 
+      interested in.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option><![CDATA[--auto=<yes|no> [default: no] ]]></option>
+    </term>
+    <listitem>
+      <para>Annotate all source files containing functions that helped 
+      reach the event count threshold.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option>--context=N [default: 8] </option>
+    </term>
+    <listitem>
+      <para>Print N lines of context before and after annotated 
+      lines.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option><![CDATA[--inclusive=<yes|no> [default: no] ]]></option>
+    </term>
+    <listitem>
+      <para>Add subroutine costs to functions calls.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option><![CDATA[--tree=<none|caller|calling|both> [default: none] ]]></option>
+    </term>
+    <listitem>
+      <para>Print for each function their callers, the called functions 
+      or both.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term>
+      <option><![CDATA[-I, --include=<dir> ]]></option>
+    </term>
+    <listitem>
+      <para>Add <option>dir</option> to the list of directories to search
+      for source files.</para>
+  </listitem>
+  </varlistentry>
+
+</variablelist>
+<!-- end of xi:include in the manpage -->
+
+
+</sect1>
+
+
+
+
+<sect1 id="cl-manual.callgrind_control-options" xreflabel="callgrind_control Options">
+<title>callgrind_control Options</title>
+
+<!-- start of xi:include in the manpage -->
+<variablelist id="callgrind_control.opts.list">
+
+  <varlistentry>
+    <term><option>-h --help</option></term>
+    <listitem>
+      <para>Show summary of options.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>--version</option></term>
+    <listitem>
+      <para>Show version of callgrind_control.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-s</option></term>
+    <listitem>
+      <para>Show statistics.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-b</option></term>
+    <listitem>
+      <para>Show stack trace.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-e [A,B,C] [default: all] </option></term>
+    <listitem>
+      <para>Only show figures for events A,B,C.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-z</option></term>
+    <listitem>
+      <para>Zero cost counters.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-d, --dump [hint]</option></term>
+    <listitem>
+      <para>Request the dumping of profile information. Optionally, a 
+      string can be specified which is written into the dump as part of 
+      the Trigger reason. This can be used to distinguish multiple dumps.</para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-k</option></term>
+    <listitem>
+      <para>Kill.</para>
+    </listitem>
+  </varlistentry>
+
+</variablelist>
+<!-- end of xi:include in the manpage -->
+
+</sect1>
+
 </chapter>
diff --git a/callgrind/docs/man-annotate.xml b/callgrind/docs/man-annotate.xml
deleted file mode 100644 (file)
index ddb9a60..0000000
+++ /dev/null
@@ -1,163 +0,0 @@
-<?xml version="1.0"?> <!-- -*- sgml -*- -->
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-          "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
-[ <!ENTITY % cl-entities SYSTEM "cl-entities.xml"> %cl-entities; ]>
-
-
-<refentry id="callgrind-annotate">
-
-<refmeta>
-  <refentrytitle>Callgrind Annotate</refentrytitle>
-  <manvolnum>1</manvolnum>
-  <refmiscinfo class="a-source">May 13, 2003</refmiscinfo>
-</refmeta>
-
-<refnamediv id="a-name">
-  <refname>callgrind_annotate</refname>
-  <refpurpose>produces human readable ASCII output from profile 
-  information in <command>callgrind.out.&lt;pid&gt;</command> files</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv id="a-synopsis">
-  <cmdsynopsis>
-    <command>callgrind_annotate</command>    
-    <arg choice="opt"><replaceable>options</replaceable></arg>
-    <arg choice="opt"><replaceable>source-files</replaceable></arg>
-  </cmdsynopsis>
-</refsynopsisdiv>
-
-
-<refsect1 id="a-description">
-<title>Description</title>
-
-<para>This manual page documents briefly the 
-<command>callgrind_annotate</command> command.  This manual page was 
-written for the Debian distribution because the original program does 
-not have a manual page.</para>
-
-</refsect1>
-
-
-<refsect1 id="a-options">
-<title>Options</title>
-
-<para>This program follows the usual GNU command line syntax, with long
-options starting with two dashes ('--').  A summary of options is 
-included below.</para>
-
-<variablelist remap="TP">
-
-  <varlistentry>
-    <term><option>-h --help</option></term>
-    <listitem>
-      <para>Show summary of options.</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--version</option></term>
-    <listitem>
-      <para>Show version of callgrind_annotate.</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option>--show=A,B,C [default: all]</option>
-    </term>
-    <listitem>
-      <para>only show figures for events A,B,C</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option>--sort=A,B,C</option>
-    </term>
-    <listitem>
-      <para>sort columns by events A,B,C [event column order]</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option><![CDATA[--threshold=<0--100> [default: 99%] ]]></option>
-    </term>
-    <listitem>
-      <para>percentage of counts (of primary sort event) we are 
-      interested in</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option><![CDATA[--auto=<yes|no> [default: no] ]]></option>
-    </term>
-    <listitem>
-      <para>annotate all source files containing functions that helped 
-      reach the event count threshold</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option>--context=N [default: 8] </option>
-    </term>
-    <listitem>
-      <para>print N lines of context before and after annotated 
-      lines</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option><![CDATA[--cumulative=<yes|no> [default: no] ]]></option>
-    </term>
-    <listitem>
-      <para>add subroutine costs to functions calls</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option><![CDATA[--tree=<none|caller|calling|both> [default: none] ]]></option>
-    </term>
-    <listitem>
-      <para>print for each function their callers, the called functions 
-      or both</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term>
-      <option><![CDATA[-I, --include=<dir> ]]></option>
-    </term>
-    <listitem>
-      <para>add &lt;dir&gt; to the list of directories to search for source 
-      files</para>
-  </listitem>
-  </varlistentry>
-
-</variablelist>
-
-</refsect1>
-
-
-<refsect1 id="a-see_also">
-<title>See Also</title>
-
-<para><filename>&cl-doc-path;</filename></para>
-
-</refsect1>
-
-
-<refsect1 id="a-author">
-<title>Author</title>
-
-<para>This manual page was written by 
-Philipp Frauenfelder &lt;pfrauenf@debian.org&gt;, for the Debian 
-GNU/Linux system (but may be used by others).</para>
-</refsect1>
-
-
-</refentry>
diff --git a/callgrind/docs/man-control.xml b/callgrind/docs/man-control.xml
deleted file mode 100644 (file)
index 119e177..0000000
+++ /dev/null
@@ -1,132 +0,0 @@
-<?xml version="1.0"?> <!-- -*- sgml -*- -->
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-          "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
-[ <!ENTITY % cl-entities SYSTEM "cl-entities.xml"> %cl-entities; ]>
-
-
-<refentry id="callgrind-control">
-<refmeta>
-  <refentrytitle>Callgrind Control</refentrytitle>
-  <manvolnum>1</manvolnum>
-  <refmiscinfo class="c-source">October, 2005</refmiscinfo>
-</refmeta>
-
-<refnamediv id="c-name">
-  <refname>callgrind_control</refname>
-  <refpurpose>observe and control applications currently running under 
-  supervision of <command>callgrind</command></refpurpose>
-</refnamediv>
-
-<refsynopsisdiv id="c-synopsis">
-  <cmdsynopsis>
-    <command>callgrind_control</command>    
-    <arg choice="opt"><replaceable>options</replaceable></arg>
-    <arg choice="opt" rep="repeat"><replaceable>pid/program-name</replaceable></arg>
-  </cmdsynopsis>
-</refsynopsisdiv>
-
-
-<refsect1 id="c-description">
-<title>Description</title>
-
-<para>This manual page documents briefly the 
-<command>callgrind_control</command> command. When not specifying a
-<command>pid/program name</command> argument, all applications run 
-by callgrind on this system will be used for actions given by the 
-specified option(s). The default action is to give short information 
-for the applications run by callgrind.</para>
-
-</refsect1>
-
-
-<refsect1 id="c-options">
-<title>Options</title>
-
-<para>This program follows the usual GNU command line syntax, with long
-options starting with two dashes ("--").  A summary of options is 
-included below.</para>
-
-<variablelist remap="TP">
-
-  <varlistentry>
-    <term><option>-h --help</option></term>
-    <listitem>
-      <para>Show summary of options.</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--version</option></term>
-    <listitem>
-      <para>Show version of callgrind_control.</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-s</option></term>
-    <listitem>
-      <para>Show statistics</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-b</option></term>
-    <listitem>
-      <para>Show stack trace</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-e [A,B,C] [default: all] </option></term>
-    <listitem>
-      <para>Only show figures for events A,B,C</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-z</option></term>
-    <listitem>
-      <para>Zero cost counters</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-d, --dump [hint]</option></term>
-    <listitem>
-      <para>Request the dumping of profile information. Optionally, a 
-      string can be specified which is written into the dump as part of 
-      the Trigger reason. This can be used to distinguish multiple dumps.</para>
-    </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-k</option></term>
-    <listitem>
-      <para>Kill</para>
-    </listitem>
-  </varlistentry>
-
-</variablelist>
-
-</refsect1>
-
-
-<refsect1 id="c-see_also">
-<title>See Also</title>
-
-<para><filename>&cl-doc-path;</filename></para>
-
-</refsect1>
-
-
-<refsect1 id="c-author">
-<title>Author</title>
-
-<para>This manual page was written by Josef Weidendorfer &lt;&cl-email;&gt;.</para>
-
-
-</refsect1>
-
-
-</refentry>
-
index 60aacf3ca7cdbe491c0129ee2671708d658d1a15..889bb8fa6274466a7183f66c1a2ae8d1d359db9f 100644 (file)
 <xi:include href="valgrind-manpage.xml" parse="xml"  
     xmlns:xi="http://www.w3.org/2001/XInclude" />
 
+<!-- callgrind_annotate -->
+<xi:include href="../../callgrind/docs/callgrind_annotate-manpage.xml" parse="xml"  
+    xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+<!-- callgrind_control -->
+<xi:include href="../../callgrind/docs/callgrind_control-manpage.xml" parse="xml"  
+    xmlns:xi="http://www.w3.org/2001/XInclude" />
+
 <!-- ms_print -->
 <xi:include href="../../massif/docs/ms_print-manpage.xml" parse="xml"  
     xmlns:xi="http://www.w3.org/2001/XInclude" />
index d1988db421b6c539b6beae5247da45e32825043a..1bd56818560a2aceb7e2cf2a522a832e41e5e951 100644 (file)
@@ -222,6 +222,8 @@ system: <filename>&vg-docs-path;</filename>, or online:
 <title>See Also</title>
 
 <para>
+callgrind_annotate(1),
+callgrind_control(1),
 ms_print(1),
 <filename>&vg-docs-path;</filename> or
 <filename>&vg-docs-url;</filename>.
@@ -233,9 +235,10 @@ ms_print(1),
 <refsect1 id="author">
 <title>Author</title>
 
-<para>This manpage written by Andres Roldan &lt;aroldan@debian.org&gt;,
-Robert Walsh &lt;rjwalsh@durables.org&gt;, and the Valgrind
-developers.</para>
+<para>The Valgrind developers.</para>
+
+<para>This manpage was written by Andres Roldan &lt;aroldan@debian.org&gt;
+and the Valgrind developers.</para>
 
 </refsect1>
 
index 5da7c013a43a6e94e994599ccb067af9e15d63c9..e713bfb4ac8d84c1e52a71835f834c478e81574a 100644 (file)
@@ -1,6 +1,7 @@
 <!-- misc. strings -->
 <!ENTITY vg-jemail     "julian@valgrind.org">
 <!ENTITY vg-vemail     "valgrind@valgrind.org">
+<!ENTITY cl-email      "Josef.Weidendorfer@gmx.de">
 <!ENTITY vg-lifespan   "2000-2009">
 
 <!-- valgrind release + version stuff -->
@@ -20,3 +21,6 @@
 <!ENTITY vg-repo-url   "http://www.valgrind.org/downloads/repository.html">
 <!ENTITY vg-pubs-url   "http://www.valgrind.org/docs/pubs.html">
 <!ENTITY vg-docs-url   "http://www.valgrind.org/docs/manual/index.html">
+<!ENTITY cl-gui-url    "http://kcachegrind.sourceforge.net/cgi-bin/show.cgi/KcacheGrindIndex">
+
+