From: Mark Wielaard Date: Thu, 14 May 2020 15:50:40 +0000 (+0200) Subject: Make Execution Trees references available in both manual and man pages. X-Git-Tag: VALGRIND_3_16_0~10 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=de93a35139d8d2822cc37dfecfa40a99a80426e9;p=thirdparty%2Fvalgrind.git 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 --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. xtmemory [<filename> default xtmemory.kcg.%p.%n] requests the tool (Memcheck, Massif, Helgrind) to produce an xtree heap memory report. - See for + See for a detailed explanation about execution trees. 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. Tools replacing Valgrind's malloc, realloc, etc, can optionally produce an execution tree detailing which piece of code is responsible for heap - memory usage. See + memory usage. See for a detailed explanation about execution trees. When set to none, no memory execution @@ -1838,7 +1838,7 @@ Massif, Helgrind, DRD), the following options apply. If the filename contains the extension or no extension is provided or recognised, then the produced file format will be a callgrind output format. - See + See for a detailed explanation about execution trees formats. @@ -2986,7 +2986,7 @@ will create a core dump in the usual way. - + Execution Trees 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), &vg-cg-manual-label;. +&vg-xtree-label; 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 @@ - + + + + + + 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 ANNOTATE_* macros defined in helgrind.h. -Helgrind also provides memory +Helgrind also provides memory profiling using the command line option --xtree-memory and the monitor command xtmemory. @@ -1460,7 +1460,7 @@ write of size 4 at 0x8049D88 by thread #9 tid 2 xtmemory [<filename> default xtmemory.kcg.%p.%n] requests Helgrind tool to produce an xtree heap memory report. - See for + See for a detailed explanation about execution trees. 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. -Massif also provides memory +Massif also provides memory profiling using the command line option --xtree-memory and the monitor command xtmemory. @@ -904,7 +904,7 @@ gdbserver (see ). xtmemory [<filename> default xtmemory.kcg.%p.%n] requests Massif tool to produce an xtree heap memory report. - See for + See for a detailed explanation about execution trees. 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 @@ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" +[ %vg-entities; ]> @@ -59,7 +60,7 @@ problems that are common in C and C++ programs. often remaining undetected for long periods, then causing occasional, difficult-to-diagnose crashes. -Memcheck also provides memory +Memcheck also provides memory profiling using the command line option --xtree-memory and the monitor command xtmemory. @@ -918,7 +919,7 @@ is decrease of event. The values for the increase and decrease events will be zero for the first leak search done. - See for a detailed explanation + See for a detailed explanation about execution trees. @@ -936,7 +937,7 @@ is in exactly the same way as they are for . See the description of for details. - See + See for a detailed explanation about execution trees formats. @@ -1122,7 +1123,7 @@ is If you want to use --xtree-memory=full memory profiling - (see ), then you cannot + (see ), then you cannot specify --keep-stacktraces=free or --keep-stacktraces=none. @@ -1951,7 +1952,7 @@ Address 0x8049E28 len 1 defined The value xtleak also produces a full leak report, but output it as an xtree in a file xtleak.kcg.%p.%n (see ). - See + See for a detailed explanation about execution trees formats. See for the description of the events in a xtree leak file. @@ -2218,7 +2219,7 @@ Address 0x8049E28 len 1 defined xtmemory [<filename> default xtmemory.kcg.%p.%n] requests Memcheck tool to produce an xtree heap memory report. - See for + See for a detailed explanation about execution trees.