mirror of
https://github.com/Zenithsiz/ftmemsim-valgrind.git
synced 2026-02-03 18:13:01 +00:00
Bug 321730 Add cg_merge and cg_diff man pages.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13442
This commit is contained in:
Mark Wielaard
parent
571f45ce1c
commit
7d4cc60c1f
@ -2,7 +2,9 @@ include $(top_srcdir)/Makefile.tool.am
|
||||
|
||||
EXTRA_DIST = \
|
||||
docs/cg-manual.xml \
|
||||
docs/cg_annotate-manpage.xml
|
||||
docs/cg_annotate-manpage.xml \
|
||||
docs/cg_diff-manpage.xml \
|
||||
docs/cg_merge-manpage.xml
|
||||
|
||||
#----------------------------------------------------------------------------
|
||||
# Headers, etc
|
||||
|
||||
@ -112,7 +112,7 @@ information, and then run cg_annotate to get a detailed presentation of that
|
||||
information. As an optional intermediate step, you can use cg_merge to sum
|
||||
together the outputs of multiple Cachegrind runs into a single file which
|
||||
you then use as the input for cg_annotate. Alternatively, you can use
|
||||
cg_diff to difference the outputs of two Cachegrind runs into a signel file
|
||||
cg_diff to difference the outputs of two Cachegrind runs into a single file
|
||||
which you then use as the input for cg_annotate.</para>
|
||||
|
||||
|
||||
@ -1001,6 +1001,29 @@ small differences like these; it works in the same way as
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="cg-manual.mergeopts" xreflabel="cg_merge Command-line Options">
|
||||
<title>cg_merge Command-line Options</title>
|
||||
|
||||
<!-- start of xi:include in the manpage -->
|
||||
<variablelist id="cg_merge.opts.list">
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option><![CDATA[-o outfile]]></option>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>Write the profile data to <computeroutput>outfile</computeroutput>
|
||||
rather than to standard output.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
<!-- end of xi:include in the manpage -->
|
||||
|
||||
</sect1>
|
||||
|
||||
|
||||
<sect1 id="cg-manual.diffopts" xreflabel="cg_diff Command-line Options">
|
||||
<title>cg_diff Command-line Options</title>
|
||||
|
||||
|
||||
75
cachegrind/docs/cg_diff-manpage.xml
Normal file
75
cachegrind/docs/cg_diff-manpage.xml
Normal file
@ -0,0 +1,75 @@
|
||||
<?xml version="1.0"?> <!-- -*- sgml -*- -->
|
||||
<!DOCTYPE refentry 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="cg_diff">
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>cg_diff</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo>Release &rel-version;</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>cg_diff</refname>
|
||||
<refpurpose>compares two Cachegrind output files</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>cg_diff</command>
|
||||
<arg><replaceable>options</replaceable></arg>
|
||||
<arg choice="plain"><replaceable>cachegrind-out-file1</replaceable></arg>
|
||||
<arg choice="plain"><replaceable>cachegrind-out-file2</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
|
||||
<para><command>cg_diff</command> takes two output files produced by the
|
||||
Valgrind tool Cachegrind, computes the difference and prints the result
|
||||
in the same format that Cachegrinds outputs.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
|
||||
<xi:include href="cg-manual.xml" xpointer="cg_diff.opts.list"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1 id="see_also">
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
cg_annotate(1), valgrind(1),
|
||||
<filename>&vg-docs-path;</filename> or
|
||||
<filename>&vg-docs-url;</filename>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 id="author">
|
||||
<title>Author</title>
|
||||
|
||||
<para>Nicholas Nethercote.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
</refentry>
|
||||
|
||||
|
||||
73
cachegrind/docs/cg_merge-manpage.xml
Normal file
73
cachegrind/docs/cg_merge-manpage.xml
Normal file
@ -0,0 +1,73 @@
|
||||
<?xml version="1.0"?> <!-- -*- sgml -*- -->
|
||||
<!DOCTYPE refentry 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="cg_merge">
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>cg_merge</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo>Release &rel-version;</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>cg_merge</refname>
|
||||
<refpurpose>merges multiple Cachegrind output files into one</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>cg_merge</command>
|
||||
<arg><replaceable>options</replaceable></arg>
|
||||
<arg choice="opt" rep="repeat"><replaceable>cachegrind-out-files</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
<refsect1 id="description">
|
||||
<title>Description</title>
|
||||
|
||||
<para><command>cg_merge</command> sums together the outputs of multiple
|
||||
Cachegrind runs into a single output file.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1 id="options">
|
||||
<title>Options</title>
|
||||
|
||||
<xi:include href="cg-manual.xml" xpointer="cg_merge.opts.list"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1 id="see_also">
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
cg_annotate(1), valgrind(1),
|
||||
<filename>&vg-docs-path;</filename> or
|
||||
<filename>&vg-docs-url;</filename>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 id="author">
|
||||
<title>Author</title>
|
||||
|
||||
<para>Nicholas Nethercote.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
</refentry>
|
||||
|
||||
|
||||
@ -15,6 +15,14 @@
|
||||
<xi:include href="../../cachegrind/docs/cg_annotate-manpage.xml" parse="xml"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
<!-- cg_diff -->
|
||||
<xi:include href="../../cachegrind/docs/cg_diff-manpage.xml" parse="xml"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
||||
|
||||
<!-- cg_merge -->
|
||||
<xi:include href="../../cachegrind/docs/cg_merge-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" />
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user