|
From: Mark W. <ma...@so...> - 2020-05-14 15:57:27
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=de93a35139d8d2822cc37dfecfa40a99a80426e9 commit de93a35139d8d2822cc37dfecfa40a99a80426e9 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 17:50:40 2020 +0200 Make Execution Trees references available in both manual and man pages. Both the manual and the man pages reference xtrees. Create some shared entities so both can reference the section. Diff: --- docs/xml/manual-core-adv.xml | 2 +- docs/xml/manual-core.xml | 6 +++--- docs/xml/valgrind-manpage.xml | 3 +++ docs/xml/vg-entities.xml | 7 ++++++- helgrind/docs/hg-manual.xml | 4 ++-- massif/docs/ms-manual.xml | 4 ++-- memcheck/docs/mc-manual.xml | 15 ++++++++------- 7 files changed, 25 insertions(+), 16 deletions(-) diff --git a/docs/xml/manual-core-adv.xml b/docs/xml/manual-core-adv.xml index fe05c8ef28..8d2e905e42 100644 --- a/docs/xml/manual-core-adv.xml +++ b/docs/xml/manual-core-adv.xml @@ -1435,7 +1435,7 @@ client request. <listitem> <para><varname>xtmemory [<filename> default xtmemory.kcg.%p.%n]</varname> requests the tool (Memcheck, Massif, Helgrind) to produce an xtree heap memory report. - See <xref linkend="manual-core.xtree"/> for + See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees. </para> </listitem> diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml index a5168acf62..4480f59280 100644 --- a/docs/xml/manual-core.xml +++ b/docs/xml/manual-core.xml @@ -1783,7 +1783,7 @@ Massif, Helgrind, DRD), the following options apply.</para> <para> Tools replacing Valgrind's <function>malloc, realloc,</function> etc, can optionally produce an execution tree detailing which piece of code is responsible for heap - memory usage. See <xref linkend="manual-core.xtree"/> + memory usage. See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees. </para> <para> When set to <varname>none</varname>, no memory execution @@ -1838,7 +1838,7 @@ Massif, Helgrind, DRD), the following options apply.</para> If the filename contains the extension <option>.kcg</option> or no extension is provided or recognised, then the produced file format will be a callgrind output format.</para> - <para>See <xref linkend="manual-core.xtree"/> + <para>See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees formats. </para> </listitem> </varlistentry> @@ -2986,7 +2986,7 @@ will create a core dump in the usual way.</para> </sect1> -<sect1 id="manual-core.xtree" xreflabel="Execution Trees"> +<sect1 id="&vg-xtree-id;" xreflabel="&vg-xtree-label;"> <title>Execution Trees</title> <para>An execution tree (xtree) is made of a set of stack traces, each diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index e1867c6ad6..d81382dca4 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -250,6 +250,9 @@ ms_print(1), <ulink id="&vg-cg-manual-id;" xreflabel="&vg-cg-manual-label;" url="&vg-cg-manual-url;">&vg-cg-manual-label;</ulink>. +<ulink id="&vg-xtree-id;" + xreflabel="&vg-xtree-label;" + url="&vg-xtree-url;">&vg-xtree-label;</ulink> </para> </refsect1> diff --git a/docs/xml/vg-entities.xml b/docs/xml/vg-entities.xml index fc5629db4a..721fa51029 100644 --- a/docs/xml/vg-entities.xml +++ b/docs/xml/vg-entities.xml @@ -58,7 +58,12 @@ <!ENTITY vg-pthreads-perf-sched-id "&vg-pthreads-perf-sched-manual;.&vg-pthreads-perf-sched-ref;"> <!ENTITY vg-pthreads-perf-sched-url "&vg-manual-url;&vg-pthreads-perf-sched-manual;.html#&vg-pthreads-perf-sched-id;"> - <!ENTITY vg-cg-manual-id "cg-manual"> <!ENTITY vg-cg-manual-label "Cachegrind: a cache and branch-prediction profiler"> <!ENTITY vg-cg-manual-url "&vg-manual-url;&vg-cg-manual-id;.html"> + +<!ENTITY vg-xtree-manual "manual-core"> +<!ENTITY vg-xtree-ref "xtree"> +<!ENTITY vg-xtree-label "Execution Trees"> +<!ENTITY vg-xtree-id "&vg-xtree-manual;.&vg-xtree-ref;"> +<!ENTITY vg-xtree-url "&vg-manual-url;&vg-xtree-manual;.html#&vg-xtree-id;"> diff --git a/helgrind/docs/hg-manual.xml b/helgrind/docs/hg-manual.xml index 44cb74603c..c00be7bd0c 100644 --- a/helgrind/docs/hg-manual.xml +++ b/helgrind/docs/hg-manual.xml @@ -64,7 +64,7 @@ primitives, you can describe their behaviour to Helgrind using the <varname>ANNOTATE_*</varname> macros defined in <varname>helgrind.h</varname>.</para> -<para>Helgrind also provides <xref linkend="manual-core.xtree"/> memory +<para>Helgrind also provides <xref linkend="&vg-xtree-id;"/> memory profiling using the command line option <computeroutput>--xtree-memory</computeroutput> and the monitor command <computeroutput>xtmemory</computeroutput>.</para> @@ -1460,7 +1460,7 @@ write of size 4 at 0x8049D88 by thread #9 tid 2 <listitem> <para><varname>xtmemory [<filename> default xtmemory.kcg.%p.%n]</varname> requests Helgrind tool to produce an xtree heap memory report. - See <xref linkend="manual-core.xtree"/> for + See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees. </para> </listitem> diff --git a/massif/docs/ms-manual.xml b/massif/docs/ms-manual.xml index b590536889..2a49781a34 100644 --- a/massif/docs/ms-manual.xml +++ b/massif/docs/ms-manual.xml @@ -46,7 +46,7 @@ program is using, it also gives very detailed information that indicates which parts of your program are responsible for allocating the heap memory. </para> -<para>Massif also provides <xref linkend="manual-core.xtree"/> memory +<para>Massif also provides <xref linkend="&vg-xtree-id;"/> memory profiling using the command line option <computeroutput>--xtree-memory</computeroutput> and the monitor command <computeroutput>xtmemory</computeroutput>.</para> @@ -904,7 +904,7 @@ gdbserver (see <xref linkend="manual-core-adv.gdbserver-commandhandling"/>). <listitem> <para><varname>xtmemory [<filename> default xtmemory.kcg.%p.%n]</varname> requests Massif tool to produce an xtree heap memory report. - See <xref linkend="manual-core.xtree"/> for + See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees. </para> </listitem> </itemizedlist> diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml index 2acf6fd4f7..b706800149 100644 --- a/memcheck/docs/mc-manual.xml +++ b/memcheck/docs/mc-manual.xml @@ -1,6 +1,7 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" +[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]> <chapter id="mc-manual" xreflabel="Memcheck: a memory error detector"> @@ -59,7 +60,7 @@ problems that are common in C and C++ programs.</para> often remaining undetected for long periods, then causing occasional, difficult-to-diagnose crashes.</para> -<para>Memcheck also provides <xref linkend="manual-core.xtree"/> memory +<para>Memcheck also provides <xref linkend="&vg-xtree-id;"/> memory profiling using the command line option <computeroutput>--xtree-memory</computeroutput> and the monitor command <computeroutput>xtmemory</computeroutput>.</para> @@ -918,7 +919,7 @@ is <option>--errors-for-leak-kinds=definite,possible</option> decrease of <option>PBk</option> event. The values for the increase and decrease events will be zero for the first leak search done.</para> - <para>See <xref linkend="manual-core.xtree"/> for a detailed explanation + <para>See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees.</para> </listitem> </varlistentry> @@ -936,7 +937,7 @@ is <option>--errors-for-leak-kinds=definite,possible</option> in exactly the same way as they are for <option>--log-file</option>. See the description of <xref linkend="opt.log-file"/> for details. </para> - <para>See <xref linkend="manual-core.xtree"/> + <para>See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees formats. </para> </listitem> </varlistentry> @@ -1122,7 +1123,7 @@ is <option>--errors-for-leak-kinds=definite,possible</option> <para>If you want to use <computeroutput>--xtree-memory=full</computeroutput> memory profiling - (see <xref linkend="manual-core.xtree"/> ), then you cannot + (see <xref linkend="&vg-xtree-id;"/>), then you cannot specify <varname>--keep-stacktraces=free</varname> or <varname>--keep-stacktraces=none</varname>.</para> @@ -1951,7 +1952,7 @@ Address 0x8049E28 len 1 defined </para> <para>The value <varname>xtleak</varname> also produces a full leak report, but output it as an xtree in a file xtleak.kcg.%p.%n (see <xref linkend="opt.log-file"/>). - See <xref linkend="manual-core.xtree"/> + See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees formats. See <xref linkend="opt.xtree-leak"/> for the description of the events in a xtree leak file. @@ -2218,7 +2219,7 @@ Address 0x8049E28 len 1 defined <listitem> <para><varname>xtmemory [<filename> default xtmemory.kcg.%p.%n]</varname> requests Memcheck tool to produce an xtree heap memory report. - See <xref linkend="manual-core.xtree"/> for + See <xref linkend="&vg-xtree-id;"/> for a detailed explanation about execution trees. </para> </listitem> |