Menu
▾
▴
[Valgrind-developers] valgrind: r10665 - in trunk: cachegrind/docs massif/docs
|
From: <sv...@va...> - 2009-07-30 04:48:18
|
Author: njn Date: 2009-07-30 05:48:05 +0100 (Thu, 30 Jul 2009) New Revision: 10665 Log: Use <variablelist> for ms_print's and cg_annotate's options list. Modified: trunk/cachegrind/docs/cg-manual.xml trunk/massif/docs/ms-manual.xml Modified: trunk/cachegrind/docs/cg-manual.xml =================================================================== --- trunk/cachegrind/docs/cg-manual.xml 2009-07-30 04:27:26 UTC (rev 10664) +++ trunk/cachegrind/docs/cg-manual.xml 2009-07-30 04:48:05 UTC (rev 10665) @@ -836,78 +836,109 @@ <sect1 id="cg-manual.annopts" xreflabel="cg_annotate options"> <title>cg_annotate options</title> -<itemizedlist> +<variablelist> - <listitem> - <para><option>-h --help</option></para> - <para><option>-v --version</option></para> - <para>Help and version, as usual.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[-h --help ]]></option> + </term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> - <listitem id="sort"> - <para><option>--sort=A,B,C</option> [default: - order in - <computeroutput>cachegrind.out.<pid></computeroutput>]</para> - <para>Specifies the events upon which the sorting of the - function-by-function entries will be based. Useful if you - want to concentrate on eg. I cache misses - (<option>--sort=I1mr,I2mr</option>), or D cache misses - (<option>--sort=D1mr,D2mr</option>), or L2 misses - (<option>--sort=D2mr,I2mr</option>).</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[-v --version ]]></option> + </term> + <listitem> + <para>Show the version number.</para> + </listitem> + </varlistentry> - <listitem id="show"> - <para><option>--show=A,B,C</option> [default: - all, using order in - <computeroutput>cachegrind.out.<pid></computeroutput>]</para> - <para>Specifies which events to show (and the column - order). Default is to use all present in the - <computeroutput>cachegrind.out.<pid></computeroutput> file (and - use the order in the file).</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--sort=A,B,C [default: order in + cachegrind.out.<pid>] ]]></option> + </term> + <listitem> + <para>Specifies the events upon which the sorting of the + function-by-function entries will be based. Useful if you + want to concentrate on eg. I cache misses + (<option>--sort=I1mr,I2mr</option>), or D cache misses + (<option>--sort=D1mr,D2mr</option>), or L2 misses + (<option>--sort=D2mr,I2mr</option>).</para> + </listitem> + </varlistentry> - <listitem id="threshold"> - <para><option>--threshold=X</option> - [default: 99%]</para> - <para>Sets the threshold for the function-by-function - summary. Functions are shown that account for more than X% - of the primary sort event. If auto-annotating, also affects - which files are annotated.</para> - - <para>Note: thresholds can be set for more than one of the - events by appending any events for the - <option>--sort</option> option with a colon - and a number (no spaces, though). E.g. if you want to see - the functions that cover 99% of L2 read misses and 99% of L2 - write misses, use this option:</para> - <para><option>--sort=D2mr:99,D2mw:99</option></para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--show=A,B,C [default: all, using order in + cachegrind.out.<pid>] ]]></option> + </term> + <listitem> + <para>Specifies which events to show (and the column + order). Default is to use all present in the + <computeroutput>cachegrind.out.<pid></computeroutput> file (and + use the order in the file).</para> + </listitem> + </varlistentry> - <listitem id="auto"> - <para><option>--auto=no</option> [default]</para> - <para><option>--auto=yes</option></para> - <para>When enabled, automatically annotates every file that - is mentioned in the function-by-function summary that can be - found. Also gives a list of those that couldn't be found.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--threshold=X [default: 99%] ]]></option> + </term> + <listitem> + <para>Sets the threshold for the function-by-function + summary. Functions are shown that account for more than X% + of the primary sort event. If auto-annotating, also affects + which files are annotated.</para> + + <para>Note: thresholds can be set for more than one of the + events by appending any events for the + <option>--sort</option> option with a colon + and a number (no spaces, though). E.g. if you want to see + the functions that cover 99% of L2 read misses and 99% of L2 + write misses, use this option:</para> + <para><option>--sort=D2mr:99,D2mw:99</option></para> + </listitem> + </varlistentry> - <listitem id="context"> - <para><option>--context=N</option> [default: 8]</para> - <para>Print N lines of context before and after each - annotated line. Avoids printing large sections of source - files that were not executed. Use a large number - (eg. 10,000) to show all source lines.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--auto=<no|yes> [default: no] ]]></option> + </term> + <listitem> + <para>When enabled, automatically annotates every file that + is mentioned in the function-by-function summary that can be + found. Also gives a list of those that couldn't be found.</para> + </listitem> + </varlistentry> - <listitem id="include"> - <para><option>-I<dir>, --include=<dir></option> - [default: empty string]</para> - <para>Adds a directory to the list in which to search for - files. Multiple -I/--include options can be given to add - multiple directories.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--context=N [default: 8] ]]></option> + </term> + <listitem> + <para>Print N lines of context before and after each + annotated line. Avoids printing large sections of source + files that were not executed. Use a large number + (eg. 10,000) to show all source lines.</para> + </listitem> + </varlistentry> -</itemizedlist> + <varlistentry> + <term> + <option><![CDATA[-I<dir> --include=<dir> [default: none] ]]></option> + </term> + <listitem> + <para>Adds a directory to the list in which to search for + files. Multiple -I/--include options can be given to add + multiple directories.</para> + </listitem> + </varlistentry> + +</variablelist> Modified: trunk/massif/docs/ms-manual.xml =================================================================== --- trunk/massif/docs/ms-manual.xml 2009-07-30 04:27:26 UTC (rev 10664) +++ trunk/massif/docs/ms-manual.xml 2009-07-30 04:48:05 UTC (rev 10665) @@ -718,32 +718,56 @@ <para>ms_print's options are:</para> -<itemizedlist> +<variablelist> - <listitem> - <para><option>-h --help</option></para> - <para><option>-v --version</option></para> - <para>Help and version, as usual.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[-h --help ]]></option> + </term> + <listitem> + <para>Show the help message.</para> + </listitem> + </varlistentry> - <listitem> - <para><option><![CDATA[--threshold=<m.n>]]></option> [default: 1.0]</para> - <para>Same as Massif's <option>--threshold</option>, but - applied after profiling rather than during.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[-v --version ]]></option> + </term> + <listitem> + <para>Show the version number.</para> + </listitem> + </varlistentry> - <listitem> - <para><option><![CDATA[--x=<m.n>]]></option> [default: 72]</para> - <para>Width of the graph, in columns.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--threshold=<m.n> [default: 1.0] ]]></option> + </term> + <listitem> + <para>Same as Massif's <option>--threshold</option> option, but + applied after profiling rather than during.</para> + </listitem> + </varlistentry> - <listitem> - <para><option><![CDATA[--y=<n>]]></option> [default: 20]</para> - <para>Height of the graph, in rows.</para> - </listitem> + <varlistentry> + <term> + <option><![CDATA[--x=<n> [default: 72]]]></option> + </term> + <listitem> + <para>Width of the graph, in columns.</para> + </listitem> + </varlistentry> -</itemizedlist> + <varlistentry> + <term> + <option><![CDATA[--y=<n> [default: 20] ]]></option> + </term> + <listitem> + <para>Height of the graph, in rows.</para> + </listitem> + </varlistentry> +</variablelist> + </sect1> <sect1 id="ms-manual.fileformat" xreflabel="fileformat"> |
