ftmemsim-valgrind/cachegrind/docs/cg_annotate-manpage.xml
Nicholas Nethercote c2e62127ad Rewrite Cachegrind docs.
For all the changes I've made recently. And also various other changes
that occurred over the past 20 years that didn't previously make it into
the docs.

Also, this change de-emphasises the cache and branch simulation aspect,
because they're no longer that useful. Instead it emphasises the
precision and reproducibility of instruction count profiling.
2023-04-21 22:18:10 +10:00

76 lines
1.6 KiB
XML

<?xml version="1.0"?> <!-- -*- sgml -*- -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
<refentry id="cg_annotate">
<refmeta>
<refentrytitle>cg_annotate</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="version">Release &rel-version;</refmiscinfo>
</refmeta>
<refnamediv>
<refname>cg_annotate</refname>
<refpurpose>post-processing tool for Cachegrind</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>cg_annotate</command>
<arg><replaceable>options</replaceable></arg>
<arg choice="plain"><replaceable>cachegrind-out-file</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>source-files</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="cg_annotate-description">
<title>Description</title>
<para>
<command>cg_annotate</command> takes one or more Cachegrind output files and
prints data about the profiled program in an easy-to-read form.
</para>
</refsect1>
<refsect1 id="cg_annotate-options">
<title>Options</title>
<xi:include href="cg-manual.xml" xpointer="cg_annotate.opts.list"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</refsect1>
<refsect1 id="cg_annotate-see_also">
<title>See Also</title>
<para>
valgrind(1),
<filename>&vg-docs-path;</filename> or
<filename>&vg-docs-url;</filename>.
</para>
</refsect1>
<refsect1 id="cg_annotate-author">
<title>Author</title>
<para>Nicholas Nethercote.</para>
</refsect1>
</refentry>