You can subscribe to this list here.
| 2002 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
(1) |
Oct
(122) |
Nov
(152) |
Dec
(69) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2003 |
Jan
(6) |
Feb
(25) |
Mar
(73) |
Apr
(82) |
May
(24) |
Jun
(25) |
Jul
(10) |
Aug
(11) |
Sep
(10) |
Oct
(54) |
Nov
(203) |
Dec
(182) |
| 2004 |
Jan
(307) |
Feb
(305) |
Mar
(430) |
Apr
(312) |
May
(187) |
Jun
(342) |
Jul
(487) |
Aug
(637) |
Sep
(336) |
Oct
(373) |
Nov
(441) |
Dec
(210) |
| 2005 |
Jan
(385) |
Feb
(480) |
Mar
(636) |
Apr
(544) |
May
(679) |
Jun
(625) |
Jul
(810) |
Aug
(838) |
Sep
(634) |
Oct
(521) |
Nov
(965) |
Dec
(543) |
| 2006 |
Jan
(494) |
Feb
(431) |
Mar
(546) |
Apr
(411) |
May
(406) |
Jun
(322) |
Jul
(256) |
Aug
(401) |
Sep
(345) |
Oct
(542) |
Nov
(308) |
Dec
(481) |
| 2007 |
Jan
(427) |
Feb
(326) |
Mar
(367) |
Apr
(255) |
May
(244) |
Jun
(204) |
Jul
(223) |
Aug
(231) |
Sep
(354) |
Oct
(374) |
Nov
(497) |
Dec
(362) |
| 2008 |
Jan
(322) |
Feb
(482) |
Mar
(658) |
Apr
(422) |
May
(476) |
Jun
(396) |
Jul
(455) |
Aug
(267) |
Sep
(280) |
Oct
(253) |
Nov
(232) |
Dec
(304) |
| 2009 |
Jan
(486) |
Feb
(470) |
Mar
(458) |
Apr
(423) |
May
(696) |
Jun
(461) |
Jul
(551) |
Aug
(575) |
Sep
(134) |
Oct
(110) |
Nov
(157) |
Dec
(102) |
| 2010 |
Jan
(226) |
Feb
(86) |
Mar
(147) |
Apr
(117) |
May
(107) |
Jun
(203) |
Jul
(193) |
Aug
(238) |
Sep
(300) |
Oct
(246) |
Nov
(23) |
Dec
(75) |
| 2011 |
Jan
(133) |
Feb
(195) |
Mar
(315) |
Apr
(200) |
May
(267) |
Jun
(293) |
Jul
(353) |
Aug
(237) |
Sep
(278) |
Oct
(611) |
Nov
(274) |
Dec
(260) |
| 2012 |
Jan
(303) |
Feb
(391) |
Mar
(417) |
Apr
(441) |
May
(488) |
Jun
(655) |
Jul
(590) |
Aug
(610) |
Sep
(526) |
Oct
(478) |
Nov
(359) |
Dec
(372) |
| 2013 |
Jan
(467) |
Feb
(226) |
Mar
(391) |
Apr
(281) |
May
(299) |
Jun
(252) |
Jul
(311) |
Aug
(352) |
Sep
(481) |
Oct
(571) |
Nov
(222) |
Dec
(231) |
| 2014 |
Jan
(185) |
Feb
(329) |
Mar
(245) |
Apr
(238) |
May
(281) |
Jun
(399) |
Jul
(382) |
Aug
(500) |
Sep
(579) |
Oct
(435) |
Nov
(487) |
Dec
(256) |
| 2015 |
Jan
(338) |
Feb
(357) |
Mar
(330) |
Apr
(294) |
May
(191) |
Jun
(108) |
Jul
(142) |
Aug
(261) |
Sep
(190) |
Oct
(54) |
Nov
(83) |
Dec
(22) |
| 2016 |
Jan
(49) |
Feb
(89) |
Mar
(33) |
Apr
(50) |
May
(27) |
Jun
(34) |
Jul
(53) |
Aug
(53) |
Sep
(98) |
Oct
(206) |
Nov
(93) |
Dec
(53) |
| 2017 |
Jan
(65) |
Feb
(82) |
Mar
(102) |
Apr
(86) |
May
(187) |
Jun
(67) |
Jul
(23) |
Aug
(93) |
Sep
(65) |
Oct
(45) |
Nov
(35) |
Dec
(17) |
| 2018 |
Jan
(26) |
Feb
(35) |
Mar
(38) |
Apr
(32) |
May
(8) |
Jun
(43) |
Jul
(27) |
Aug
(30) |
Sep
(43) |
Oct
(42) |
Nov
(38) |
Dec
(67) |
| 2019 |
Jan
(32) |
Feb
(37) |
Mar
(53) |
Apr
(64) |
May
(49) |
Jun
(18) |
Jul
(14) |
Aug
(53) |
Sep
(25) |
Oct
(30) |
Nov
(49) |
Dec
(31) |
| 2020 |
Jan
(87) |
Feb
(45) |
Mar
(37) |
Apr
(51) |
May
(99) |
Jun
(36) |
Jul
(11) |
Aug
(14) |
Sep
(20) |
Oct
(24) |
Nov
(40) |
Dec
(23) |
| 2021 |
Jan
(14) |
Feb
(53) |
Mar
(85) |
Apr
(15) |
May
(19) |
Jun
(3) |
Jul
(14) |
Aug
(1) |
Sep
(57) |
Oct
(73) |
Nov
(56) |
Dec
(22) |
| 2022 |
Jan
(3) |
Feb
(22) |
Mar
(6) |
Apr
(55) |
May
(46) |
Jun
(39) |
Jul
(15) |
Aug
(9) |
Sep
(11) |
Oct
(34) |
Nov
(20) |
Dec
(36) |
| 2023 |
Jan
(79) |
Feb
(41) |
Mar
(99) |
Apr
(169) |
May
(48) |
Jun
(16) |
Jul
(16) |
Aug
(57) |
Sep
(19) |
Oct
|
Nov
|
Dec
|
| S | M | T | W | T | F | S |
|---|---|---|---|---|---|---|
|
|
|
|
|
|
1
(2) |
2
(9) |
|
3
(1) |
4
|
5
(1) |
6
(3) |
7
(1) |
8
|
9
(3) |
|
10
|
11
(4) |
12
|
13
(24) |
14
(14) |
15
(22) |
16
|
|
17
|
18
(4) |
19
(4) |
20
(3) |
21
|
22
|
23
|
|
24
|
25
(2) |
26
|
27
(2) |
28
|
29
|
30
|
|
31
|
|
|
|
|
|
|
|
From: Mark W. <ma...@so...> - 2020-05-15 12:57:50
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=e35c8a096a19ed370c4d83c069180dbd6bed838b commit e35c8a096a19ed370c4d83c069180dbd6bed838b Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 18:47:57 2020 +0200 Resolve id conflicts in See Also sections in valgrind and vgdb manpages. Because the manpages are processed together they cannot contain the same ids. Both the valgrind and vgdb manpage reference the vgdb main manual URL. That conflicts even though the valgrind.1 and vgdb.1 manual page are separate. Prefixing the vgdb ids (with "vgdb-") works around the conflict. It still works fine, since in vgdb the references are only directly used in the "See Also" refsect. The labels and urls still come out as intended. With this fix make valid validates both the manual index.xml and manpages-index.xml without errors. Diff: --- coregrind/docs/vgdb-manpage.xml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index 2eeedbd490..090ff56682 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -57,13 +57,18 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes: valgrind(1), <filename>&vg-docs-path;</filename> or <filename>&vg-docs-url;</filename>, -<ulink id="&vg-gdbserver-id;" +<!-- Note that the ids used have vgdb- prefixed. This is because the same + ids are used in the valgrind.1 man page. That conflict even though + the valgrind.1 and vgdb.1 manual page are generated separately. It + still works fine, since in vgdb the references are only direct in this + "See Also" refsect. The labels and urls still come out as intended. --> +<ulink id="vgdb-&vg-gdbserver-id;" xreflabel="&vg-gdbserver-label;" url="&vg-gdbserver-url;">&vg-gdbserver-label;</ulink> -<ulink id="&vg-vgdb-id;" +<ulink id="vgdb-&vg-vgdb-id;" xreflabel="&vg-vgdb-label;" url="&vg-vgdb-url;">&vg-vgdb-label;</ulink>, -<ulink id="&vg-monitor-id;" +<ulink id="vgdb-&vg-monitor-id;" xreflabel="&vg-monitor-label;" url="&vg-monitor-url;">&vg-monitor-label;</ulink>. </para> |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:57:40
|
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> |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:57:33
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=28b8d8b5a1e3d620621bdb5f00ccd931840bb331 commit 28b8d8b5a1e3d620621bdb5f00ccd931840bb331 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 16:07:04 2020 +0200 Turn manpages-index.xml into a "real" book, so it can be validated. manpages-index.xml is just to easily get at each individual man page with xsltproc. It wasn't a complete docbookx xml file. Now that it is we can validate it with xmllint. It doesn't fully validate, but we are close. Diff: --- auxprogs/docs/valgrind-di-server-manpage.xml | 8 +++---- auxprogs/docs/valgrind-listener-manpage.xml | 8 +++---- cachegrind/docs/cg_annotate-manpage.xml | 8 +++---- cachegrind/docs/cg_diff-manpage.xml | 8 +++---- cachegrind/docs/cg_merge-manpage.xml | 8 +++---- coregrind/docs/vgdb-manpage.xml | 8 +++---- docs/Makefile.am | 1 + docs/xml/manpages-index.xml | 32 ++++++++++++++++++++++++++++ massif/docs/ms_print-manpage.xml | 8 +++---- 9 files changed, 61 insertions(+), 28 deletions(-) diff --git a/auxprogs/docs/valgrind-di-server-manpage.xml b/auxprogs/docs/valgrind-di-server-manpage.xml index a1244600be..e42a744bc3 100644 --- a/auxprogs/docs/valgrind-di-server-manpage.xml +++ b/auxprogs/docs/valgrind-di-server-manpage.xml @@ -25,7 +25,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="di-server-description"> <title>Description</title> <para><command>valgrind-di-server</command> accepts (multiple) connections @@ -38,7 +38,7 @@ from <command>valgrind</command> processes that use the -<refsect1 id="options"> +<refsect1 id="di-server-options"> <title>Options</title> <variablelist> <varlistentry> @@ -74,7 +74,7 @@ from <command>valgrind</command> processes that use the -<refsect1 id="see_also"> +<refsect1 id="di-server-see_also"> <title>See Also</title> <para> @@ -86,7 +86,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="di-server-author"> <title>Author</title> <para>Julian Seward.</para> diff --git a/auxprogs/docs/valgrind-listener-manpage.xml b/auxprogs/docs/valgrind-listener-manpage.xml index b94e2a5f62..705f9001da 100644 --- a/auxprogs/docs/valgrind-listener-manpage.xml +++ b/auxprogs/docs/valgrind-listener-manpage.xml @@ -25,7 +25,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="listener-description"> <title>Description</title> <para><command>valgrind-listener</command> accepts (multiple) connections @@ -38,7 +38,7 @@ commentary it is sent to stdout. -<refsect1 id="options"> +<refsect1 id="listener-options"> <title>Options</title> <xi:include href="../../docs/xml/manual-core.xml" xpointer="listener.opts.list" @@ -49,7 +49,7 @@ commentary it is sent to stdout. -<refsect1 id="see_also"> +<refsect1 id="listener-see_also"> <title>See Also</title> <para> @@ -61,7 +61,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="listener-author"> <title>Author</title> <para>Julian Seward.</para> diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml index 112f1607d4..61854cf08f 100644 --- a/cachegrind/docs/cg_annotate-manpage.xml +++ b/cachegrind/docs/cg_annotate-manpage.xml @@ -27,7 +27,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="cg_annotate-description"> <title>Description</title> <para><command>cg_annotate</command> takes an output file produced by the @@ -38,7 +38,7 @@ Valgrind tool Cachegrind and prints the information in an easy-to-read form. -<refsect1 id="options"> +<refsect1 id="cg_annotate-options"> <title>Options</title> <xi:include href="cg-manual.xml" xpointer="cg_annotate.opts.list" @@ -49,7 +49,7 @@ Valgrind tool Cachegrind and prints the information in an easy-to-read form. -<refsect1 id="see_also"> +<refsect1 id="cg_annotate-see_also"> <title>See Also</title> <para> @@ -61,7 +61,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="cg_annotate-author"> <title>Author</title> <para>Nicholas Nethercote.</para> diff --git a/cachegrind/docs/cg_diff-manpage.xml b/cachegrind/docs/cg_diff-manpage.xml index c37a55acb6..1af0c15427 100644 --- a/cachegrind/docs/cg_diff-manpage.xml +++ b/cachegrind/docs/cg_diff-manpage.xml @@ -27,7 +27,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="cg_diff-description"> <title>Description</title> <para><command>cg_diff</command> takes two output files produced by the @@ -39,7 +39,7 @@ in the same format that Cachegrinds outputs. -<refsect1 id="options"> +<refsect1 id="cg_diff-options"> <title>Options</title> <xi:include href="cg-manual.xml" xpointer="cg_diff.opts.list" @@ -50,7 +50,7 @@ in the same format that Cachegrinds outputs. -<refsect1 id="see_also"> +<refsect1 id="cg_diff-see_also"> <title>See Also</title> <para> @@ -62,7 +62,7 @@ cg_annotate(1), valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="cg_diff-author"> <title>Author</title> <para>Nicholas Nethercote.</para> diff --git a/cachegrind/docs/cg_merge-manpage.xml b/cachegrind/docs/cg_merge-manpage.xml index 72227b8b1c..228f9d159f 100644 --- a/cachegrind/docs/cg_merge-manpage.xml +++ b/cachegrind/docs/cg_merge-manpage.xml @@ -26,7 +26,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="cg_merge-description"> <title>Description</title> <para><command>cg_merge</command> sums together the outputs of multiple @@ -37,7 +37,7 @@ Cachegrind runs into a single output file. -<refsect1 id="options"> +<refsect1 id="cg_merge-options"> <title>Options</title> <xi:include href="cg-manual.xml" xpointer="cg_merge.opts.list" @@ -48,7 +48,7 @@ Cachegrind runs into a single output file. -<refsect1 id="see_also"> +<refsect1 id="cg_merge-see_also"> <title>See Also</title> <para> @@ -60,7 +60,7 @@ cg_annotate(1), valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="cg_merge-author"> <title>Author</title> <para>Nicholas Nethercote.</para> diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index d5aa305358..2eeedbd490 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -25,7 +25,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="vgdb-description"> <title>Description</title> <para><command>vgdb</command> ("Valgrind to GDB") is used as an @@ -38,7 +38,7 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes: </refsect1> -<refsect1 id="options"> +<refsect1 id="vgdb-options"> <title>Options</title> <xi:include href="../../docs/xml/manual-core-adv.xml" @@ -50,7 +50,7 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes: -<refsect1 id="see_also"> +<refsect1 id="vgdb-see_also"> <title>See Also</title> <para> @@ -71,7 +71,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="vgdb-author"> <title>Author</title> <para>Philippe Waroquiers.</para> diff --git a/docs/Makefile.am b/docs/Makefile.am index f875d6dcc3..f63116b5fe 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -134,6 +134,7 @@ all-docs: FAQ.txt man-pages html-docs print-docs valid: $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/index.xml + $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/manpages-index.xml # The text version of the FAQ. FAQ.txt: diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml index 3e422c1431..17a81c99f0 100644 --- a/docs/xml/manpages-index.xml +++ b/docs/xml/manpages-index.xml @@ -6,46 +6,78 @@ point $(XSTLPROC) at a single file and get all the man pages. --> <set> +<book> <!-- valgrind --> +<chapter> +<title>valgrind</title> <xi:include href="valgrind-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- cg_annotate --> +<chapter> +<title>cg_annotate</title> <xi:include href="../../cachegrind/docs/cg_annotate-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- cg_diff --> +<chapter> +<title>cg_diff</title> <xi:include href="../../cachegrind/docs/cg_diff-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- cg_merge --> +<chapter> +<title>cg_merge</title> <xi:include href="../../cachegrind/docs/cg_merge-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- callgrind_annotate --> +<chapter> +<title>callgrind_annotate</title> <xi:include href="../../callgrind/docs/callgrind_annotate-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- callgrind_control --> +<chapter> +<title>callgrind_control</title> <xi:include href="../../callgrind/docs/callgrind_control-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- ms_print --> +<chapter> +<title>ms_print</title> <xi:include href="../../massif/docs/ms_print-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- valgrind-listener --> +<chapter> +<title>valgrind-listener</title> <xi:include href="../../auxprogs/docs/valgrind-listener-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- valgrind-di-server --> +<chapter> +<title>valgrind-di-server</title> <xi:include href="../../auxprogs/docs/valgrind-di-server-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- vgdb --> +<chapter> +<title>vgdb</title> <xi:include href="../../coregrind/docs/vgdb-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> +</book> </set> diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index 47a74c8764..3ac62739b5 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -26,7 +26,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="ms_print-description"> <title>Description</title> <para><command>ms_print</command> takes an output file produced by the @@ -37,7 +37,7 @@ Valgrind tool Massif and prints the information in an easy-to-read form. -<refsect1 id="options"> +<refsect1 id="ms_print-options"> <title>Options</title> <xi:include href="ms-manual.xml" xpointer="ms_print.opts.list" @@ -48,7 +48,7 @@ Valgrind tool Massif and prints the information in an easy-to-read form. -<refsect1 id="see_also"> +<refsect1 id="ms_print-see_also"> <title>See Also</title> <para> @@ -60,7 +60,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="ms_print-author"> <title>Author</title> <para>Nicholas Nethercote.</para> |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:57:26
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=555ddc4753e9014b809683c840867ed424dd7d99 commit 555ddc4753e9014b809683c840867ed424dd7d99 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 15:11:56 2020 +0200 Use DTD DocBook XML V4.5 everywhere. This makes the rule for xmllint easier since it doesn't need to override the DTD to validate against. It also helps with other tools tryinf to process the docbookx xml files. Diff: --- auxprogs/docs/valgrind-di-server-manpage.xml | 4 ++-- auxprogs/docs/valgrind-listener-manpage.xml | 4 ++-- cachegrind/docs/cg-manual.xml | 4 ++-- cachegrind/docs/cg_annotate-manpage.xml | 4 ++-- cachegrind/docs/cg_diff-manpage.xml | 4 ++-- cachegrind/docs/cg_merge-manpage.xml | 4 ++-- callgrind/docs/callgrind_annotate-manpage.xml | 4 ++-- callgrind/docs/callgrind_control-manpage.xml | 4 ++-- callgrind/docs/cl-format.xml | 4 ++-- callgrind/docs/cl-manual.xml | 4 ++-- coregrind/docs/vgdb-manpage.xml | 4 ++-- dhat/docs/dh-manual.xml | 4 ++-- docs/Makefile.am | 5 +---- docs/xml/FAQ.xml | 4 ++-- docs/xml/design-impl.xml | 4 ++-- docs/xml/dist-docs.xml | 4 ++-- docs/xml/index.xml | 4 ++-- docs/xml/licenses.xml | 4 ++-- docs/xml/manpages-index.xml | 4 ++-- docs/xml/manual-core-adv.xml | 4 ++-- docs/xml/manual-core.xml | 4 ++-- docs/xml/manual-intro.xml | 4 ++-- docs/xml/manual-writing-tools.xml | 4 ++-- docs/xml/manual.xml | 4 ++-- docs/xml/quick-start-guide.xml | 4 ++-- docs/xml/tech-docs.xml | 4 ++-- docs/xml/valgrind-manpage.xml | 4 ++-- drd/docs/drd-manual.xml | 4 ++-- exp-bbv/docs/bbv-manual.xml | 4 ++-- helgrind/docs/hg-manual.xml | 4 ++-- lackey/docs/lk-manual.xml | 4 ++-- massif/docs/ms-manual.xml | 4 ++-- massif/docs/ms_print-manpage.xml | 4 ++-- memcheck/docs/mc-manual.xml | 4 ++-- memcheck/docs/mc-tech-docs.xml | 4 ++-- none/docs/nl-manual.xml | 4 ++-- 36 files changed, 71 insertions(+), 74 deletions(-) diff --git a/auxprogs/docs/valgrind-di-server-manpage.xml b/auxprogs/docs/valgrind-di-server-manpage.xml index deca81d0a4..a1244600be 100644 --- a/auxprogs/docs/valgrind-di-server-manpage.xml +++ b/auxprogs/docs/valgrind-di-server-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/auxprogs/docs/valgrind-listener-manpage.xml b/auxprogs/docs/valgrind-listener-manpage.xml index da761b1015..b94e2a5f62 100644 --- a/auxprogs/docs/valgrind-listener-manpage.xml +++ b/auxprogs/docs/valgrind-listener-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index adff8aa730..7fabfa7fee 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> <!-- Referenced from both the manual and manpage --> diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml index 095207182f..112f1607d4 100644 --- a/cachegrind/docs/cg_annotate-manpage.xml +++ b/cachegrind/docs/cg_annotate-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/cachegrind/docs/cg_diff-manpage.xml b/cachegrind/docs/cg_diff-manpage.xml index 4823db0718..c37a55acb6 100644 --- a/cachegrind/docs/cg_diff-manpage.xml +++ b/cachegrind/docs/cg_diff-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/cachegrind/docs/cg_merge-manpage.xml b/cachegrind/docs/cg_merge-manpage.xml index 5e733d2ffc..72227b8b1c 100644 --- a/cachegrind/docs/cg_merge-manpage.xml +++ b/cachegrind/docs/cg_merge-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/callgrind/docs/callgrind_annotate-manpage.xml b/callgrind/docs/callgrind_annotate-manpage.xml index 2d0482b1ab..21fe922227 100644 --- a/callgrind/docs/callgrind_annotate-manpage.xml +++ b/callgrind/docs/callgrind_annotate-manpage.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/callgrind/docs/callgrind_control-manpage.xml b/callgrind/docs/callgrind_control-manpage.xml index 952a1c0c13..d6f7e654a3 100644 --- a/callgrind/docs/callgrind_control-manpage.xml +++ b/callgrind/docs/callgrind_control-manpage.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/callgrind/docs/cl-format.xml b/callgrind/docs/cl-format.xml index 77fe5dfdf6..06a0449ad9 100644 --- a/callgrind/docs/cl-format.xml +++ b/callgrind/docs/cl-format.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> <chapter id="cl-format" xreflabel="Callgrind Format Specification"> diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index d8b65f8021..7b7172ed4b 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> <chapter id="cl-manual" xreflabel="Callgrind Manual"> diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index 85a62aadc7..d5aa305358 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/dhat/docs/dh-manual.xml b/dhat/docs/dh-manual.xml index eeb6080551..f52cca204d 100644 --- a/dhat/docs/dh-manual.xml +++ b/dhat/docs/dh-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/docs/Makefile.am b/docs/Makefile.am index ac9110e63e..f875d6dcc3 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -114,10 +114,7 @@ LOGFILE = print.log # validation stuff XMLLINT = xmllint -LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent -# validate with docbook 4.3 'cos it supports xml:base natively -VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd -XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS) +XMLLINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent # stylesheet processor XSLTPROC = xsltproc diff --git a/docs/xml/FAQ.xml b/docs/xml/FAQ.xml index 9919c8d40c..845f5bb96c 100644 --- a/docs/xml/FAQ.xml +++ b/docs/xml/FAQ.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/design-impl.xml b/docs/xml/design-impl.xml index f891f3ba8b..a7b0ab3678 100644 --- a/docs/xml/design-impl.xml +++ b/docs/xml/design-impl.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/docs/xml/dist-docs.xml b/docs/xml/dist-docs.xml index e4021ed923..9bf4d100ae 100644 --- a/docs/xml/dist-docs.xml +++ b/docs/xml/dist-docs.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/index.xml b/docs/xml/index.xml index 758c669132..3bdb38aa12 100644 --- a/docs/xml/index.xml +++ b/docs/xml/index.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/licenses.xml b/docs/xml/licenses.xml index e9c4ef65ad..e93bd6a367 100644 --- a/docs/xml/licenses.xml +++ b/docs/xml/licenses.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <book id="licenses" xreflabel="GNU Licenses"> diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml index a038ee416f..3e422c1431 100644 --- a/docs/xml/manpages-index.xml +++ b/docs/xml/manpages-index.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- This file is not part of the distributed docs, it's just here so we can point $(XSTLPROC) at a single file and get all the man pages. --> diff --git a/docs/xml/manual-core-adv.xml b/docs/xml/manual-core-adv.xml index fd05ecf2ec..fe05c8ef28 100644 --- a/docs/xml/manual-core-adv.xml +++ b/docs/xml/manual-core-adv.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml index b36009ed90..a5168acf62 100644 --- a/docs/xml/manual-core.xml +++ b/docs/xml/manual-core.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/manual-intro.xml b/docs/xml/manual-intro.xml index 6f730d1ac0..5f84671fd6 100644 --- a/docs/xml/manual-intro.xml +++ b/docs/xml/manual-intro.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> <chapter id="manual-intro" xreflabel="Introduction"> diff --git a/docs/xml/manual-writing-tools.xml b/docs/xml/manual-writing-tools.xml index a36d775544..272d54ccf8 100644 --- a/docs/xml/manual-writing-tools.xml +++ b/docs/xml/manual-writing-tools.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/manual.xml b/docs/xml/manual.xml index da37102d00..e71a9cf750 100644 --- a/docs/xml/manual.xml +++ b/docs/xml/manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/quick-start-guide.xml b/docs/xml/quick-start-guide.xml index f7bbf68741..a61f5f095a 100644 --- a/docs/xml/quick-start-guide.xml +++ b/docs/xml/quick-start-guide.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> <book id="QuickStart" xreflabel="Valgrind Quick Start Guide"> diff --git a/docs/xml/tech-docs.xml b/docs/xml/tech-docs.xml index 918e8e37eb..28070f970c 100644 --- a/docs/xml/tech-docs.xml +++ b/docs/xml/tech-docs.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> <book id="tech-docs" xreflabel="Valgrind Technical Documentation"> diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index 10decc258a..e1867c6ad6 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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 "vg-entities.xml"> %vg-entities; ]> diff --git a/drd/docs/drd-manual.xml b/drd/docs/drd-manual.xml index 897a1bbe53..8fe1903e6c 100644 --- a/drd/docs/drd-manual.xml +++ b/drd/docs/drd-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml index 7195e9151c..6be1ffeeee 100644 --- a/exp-bbv/docs/bbv-manual.xml +++ b/exp-bbv/docs/bbv-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="bbv-manual" xreflabel="BBV"> <title>BBV: an experimental basic block vector generation tool</title> diff --git a/helgrind/docs/hg-manual.xml b/helgrind/docs/hg-manual.xml index 887a4be519..44cb74603c 100644 --- a/helgrind/docs/hg-manual.xml +++ b/helgrind/docs/hg-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/lackey/docs/lk-manual.xml b/lackey/docs/lk-manual.xml index a5c7bbd327..4170a8c3dc 100644 --- a/lackey/docs/lk-manual.xml +++ b/lackey/docs/lk-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="lk-manual" xreflabel="Lackey"> diff --git a/massif/docs/ms-manual.xml b/massif/docs/ms-manual.xml index 8d41286cff..b590536889 100644 --- a/massif/docs/ms-manual.xml +++ b/massif/docs/ms-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index 856728ec8a..47a74c8764 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml index 9d7d217221..2acf6fd4f7 100644 --- a/memcheck/docs/mc-manual.xml +++ b/memcheck/docs/mc-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="mc-manual" xreflabel="Memcheck: a memory error detector"> diff --git a/memcheck/docs/mc-tech-docs.xml b/memcheck/docs/mc-tech-docs.xml index 94911d0890..44bbb8c6ee 100644 --- a/memcheck/docs/mc-tech-docs.xml +++ b/memcheck/docs/mc-tech-docs.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="mc-tech-docs" diff --git a/none/docs/nl-manual.xml b/none/docs/nl-manual.xml index eae9a52cd9..6d1e89c5c4 100644 --- a/none/docs/nl-manual.xml +++ b/none/docs/nl-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="nl-manual" xreflabel="Nulgrind"> |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:57:18
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=51c85defe0a4fcfa7b6e8ff64443b5498ae60ad5 commit 51c85defe0a4fcfa7b6e8ff64443b5498ae60ad5 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 12:54:23 2020 +0200 Update README_DEVELOPERS and references to --vex-guest-chase-thresh. Add a hint about using lldb in README_DEVELOPERS and fix any old references to --vex-guest-chase-thresh=0 to --vex-guest-chase=no (mirroring the change in commit 56e04256a "Rationalise --vex-guest* flags in the new IRSB construction framework". Reported-by: Paul FLOYD <pj...@wa...> Diff: --- README_DEVELOPERS | 6 +++++- exp-bbv/docs/bbv-manual.xml | 2 +- lackey/lk_main.c | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README_DEVELOPERS b/README_DEVELOPERS index 97f2329059..86f539bb6f 100644 --- a/README_DEVELOPERS +++ b/README_DEVELOPERS @@ -110,6 +110,10 @@ without too much problem by following these steps: (gdb) handle SIGILL SIGSEGV nostop noprint + If you are using lldb, then the equivalent command is + + (lldb) pro hand -p true -s false -n false SIGILL SIGSEGV + (4) Set any breakpoints you want and proceed as normal for gdb. The macro VG_(FUNC) is expanded to vgPlain_FUNC, so If you want to set a breakpoint VG_(do_exec), you could do like this in GDB: @@ -327,7 +331,7 @@ Printing out problematic blocks If you want to print out a disassembly of a particular block that causes a crash, do the following. -Try running with "--vex-guest-chase-thresh=0 --trace-flags=10000000 +Try running with "--vex-guest-chase=no --trace-flags=10000000 --trace-notbelow=999999". This should print one line for each block translated, and that includes the address. diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml index 7141e07c2f..7195e9151c 100644 --- a/exp-bbv/docs/bbv-manual.xml +++ b/exp-bbv/docs/bbv-manual.xml @@ -263,7 +263,7 @@ T:18:45 :12:135353 :56:78 314:4324263]]></programlisting> BBV vectors will be different than those generated by other tools. In practice this does not seem to affect the accuracy of the SimPoint results. We do internally force the - <option>--vex-guest-chase-thresh=0</option> + <option>--vex-guest-chase=no</option> option to Valgrind which forces a more basic-block-like behavior. </para> diff --git a/lackey/lk_main.c b/lackey/lk_main.c index d4393b4890..e19b39f16f 100644 --- a/lackey/lk_main.c +++ b/lackey/lk_main.c @@ -739,7 +739,7 @@ IRSB* lk_instrument ( VgCallbackClosure* closure, * instrument, by the VEX statements that are the * translation of that known destination. This feature is * called 'SB chasing' and can be influenced by command - * line option --vex-guest-chase-thresh. + * line option --vex-guest-chase=[yes|no]. * * To get an accurate count of the calls to a specific * function, taking SB chasing into account, we need to |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:57:04
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=c0916494f651a33822be64bf264459bb2c452097 commit c0916494f651a33822be64bf264459bb2c452097 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 12:43:39 2020 +0200 docbook xml doesn't allow xref inside option, use link instead Diff: --- cachegrind/docs/cg-manual.xml | 2 +- callgrind/docs/cl-manual.xml | 89 +++++++++++++++++++++++++------------------ dhat/docs/dh-manual.xml | 2 +- exp-bbv/docs/bbv-manual.xml | 4 +- massif/docs/ms-manual.xml | 4 +- memcheck/docs/mc-manual.xml | 5 ++- 6 files changed, 60 insertions(+), 46 deletions(-) diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index 7a44e489f2..adff8aa730 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -860,7 +860,7 @@ small differences like these; it works in the same way as <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core - option <option><xref linkend="opt.log-file"/></option>. + option <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 10da8d973a..d8b65f8021 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -176,8 +176,9 @@ has to rely on heuristics to detect calls and returns.</para> <para>If you are additionally interested in measuring the cache behavior of your program, use Callgrind with the option - <option><xref linkend="clopt.cache-sim"/>=yes</option>. For - branch prediction simulation, use <option><xref linkend="clopt.branch-sim"/>=yes</option>. + <option><link linkend="clopt.cache-sim">--cache-sim=yes</link></option>. + For branch prediction simulation, use + <option><link linkend="clopt.branch-sim">--branch-sim=yes</link></option>. Expect a further slow down approximately by a factor of 2.</para> <para>If the program section you want to profile is somewhere in the @@ -185,7 +186,7 @@ has to rely on heuristics to detect calls and returns.</para> <emphasis>fast forward</emphasis> to this section without any profiling, and then enable profiling. This is achieved by using the command line option - <option><xref linkend="opt.instr-atstart"/>=no</option> + <option><link linkend="opt.instr-atstart">--instr-atstart=no</link></option> and running, in a shell: <computeroutput>callgrind_control -i on</computeroutput> just before the interesting code section is executed. To exactly specify @@ -193,13 +194,14 @@ has to rely on heuristics to detect calls and returns.</para> <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput>.</para> <para>If you want to be able to see assembly code level annotation, specify - <option><xref linkend="opt.dump-instr"/>=yes</option>. This will produce - profile data at instruction granularity. Note that the resulting profile - data + <option><link linkend="opt.dump-instr">--dump-instr=yes</link></option>. + This will produce profile data at instruction granularity. + Note that the resulting profile data can only be viewed with KCachegrind. For assembly annotation, it also is interesting to see more details of the control flow inside of functions, i.e. (conditional) jumps. This will be collected by further specifying - <option><xref linkend="opt.collect-jumps"/>=yes</option>.</para> + <option><link linkend="opt.collect-jumps">--collect-jumps=yes</link></option>. + </para> </sect2> @@ -228,7 +230,9 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa dump (".part" is skipped for the dump at program termination), and <emphasis>threadID</emphasis> is a thread identification ("-threadID" is only used if you request dumps of individual - threads with <option><xref linkend="opt.separate-threads"/>=yes</option>).</para> + threads with + <option><link linkend="opt.separate-threads">--separate-threads=yes</link></option>). + </para> <para>There are different ways to generate multiple profile dumps while a program is running under Callgrind's supervision. Nevertheless, @@ -265,20 +269,20 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa <listitem> <para><command>Periodic dumping after execution of a specified number of basic blocks</command>. For this, use the command line - option <option><xref linkend="opt.dump-every-bb"/>=count</option>. + option <option><link linkend="opt.dump-every-bb">--dump-every-bb=count</link></option>. </para> </listitem> <listitem> <para><command>Dumping at enter/leave of specified functions.</command> Use the - option <option><xref linkend="opt.dump-before"/>=function</option> - and <option><xref linkend="opt.dump-after"/>=function</option>. + option <option><link linkend="opt.dump-before">--dump-before=function</link></option> + and <option><link linkend="opt.dump-after">--dump-after=function</link></option>. To zero cost counters before entering a function, use - <option><xref linkend="opt.zero-before"/>=function</option>.</para> + <option><link linkend="opt.zero-before">--zero-before=function</link></option>.</para> <para>You can specify these options multiple times for different functions. Function specifications support wildcards: e.g. use - <option><xref linkend="opt.dump-before"/>='foo*'</option> to + <option><link linkend="opt.dump-before">--dump-before='foo*'</link></option> to generate dumps before entering any function starting with <emphasis>foo</emphasis>.</para> </listitem> @@ -297,7 +301,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa </itemizedlist> <para>If you are running a multi-threaded application and specify the - command line option <option><xref linkend="opt.separate-threads"/>=yes</option>, + command line option + <option><link linkend="opt.separate-threads">--separate-threads=yes</link></option>, every thread will be profiled on its own and will create its own profile dump. Thus, the last two methods will only generate one dump of the currently running thread. With the other methods, you will get @@ -359,8 +364,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa </para> <para>Callgrind can start with instrumentation mode switched off by - specifying - option <option><xref linkend="opt.instr-atstart"/>=no</option>. + specifying option + <option><link linkend="opt.instr-atstart">--instr-atstart=no</link></option>. Afterwards, instrumentation can be controlled in two ways: first, interactively with: <screen>callgrind_control -i on</screen> (and switching off again by specifying "off" instead of "on"). Second, @@ -370,12 +375,12 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa </para> <para>Similarly, the collection state at program start can be - switched off - by <option><xref linkend="opt.instr-atstart"/>=no</option>. During - execution, it can be controlled programmatically with the + switched off by + <option><link linkend="opt.instr-atstart">--instr-atstart=no</link></option>. + During execution, it can be controlled programmatically with the macro <computeroutput>CALLGRIND_TOGGLE_COLLECT;</computeroutput>. Further, you can limit event collection to a specific function by - using <option><xref linkend="opt.toggle-collect"/>=function</option>. + using <option><link linkend="opt.toggle-collect">--toggle-collect=function</link></option>. This will toggle the collection state on entering and leaving the specified function. When this option is in effect, the default collection state at program start is "off". Only events happening @@ -401,7 +406,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa "global bus events" is used.</para> <para>The short name of the event type used for global bus events is "Ge". - To count global bus events, use <option><xref linkend="clopt.collect-bus"/>=yes</option>. + To count global bus events, use + <option><link linkend="clopt.collect-bus">--collect-bus=yes</link></option>. </para> </sect2> @@ -475,32 +481,34 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa also skips any call information from and to an ignored function, and thus can break a cycle. Candidates for this typically are dispatcher functions in event driven code. The option to ignore calls to a function is - <option><xref linkend="opt.fn-skip"/>=function</option>. Aside from - possibly breaking cycles, this is used in Callgrind to skip + <option><link linkend="opt.fn-skip">--fn-skip=function</link></option>. + Aside from possibly breaking cycles, this is used in Callgrind to skip trampoline functions in the PLT sections for calls to functions in shared libraries. You can see the difference - if you profile with <option><xref linkend="opt.skip-plt"/>=no</option>. + if you profile with + <option><link linkend="opt.skip-plt">--skip-plt=no</link></option>. If a call is ignored, its cost events will be propagated to the enclosing function.</para> <para>If you have a recursive function, you can distinguish the first 10 recursion levels by specifying - <option><xref linkend="opt.separate-recs-num"/>=function</option>. + <option><link linkend="opt.separate-recs-num">--separate-recs10=function</link></option>. Or for all functions with - <option><xref linkend="opt.separate-recs"/>=10</option>, but this will + <option><link linkend="opt.separate-recs">--separate-recs=10</link></option>, + but this will give you much bigger profile data files. In the profile data, you will see the recursion levels of "func" as the different functions with names "func", "func'2", "func'3" and so on.</para> <para>If you have call chains "A > B > C" and "A > C > B" in your program, you usually get a "false" cycle "B <> C". Use - <option><xref linkend="opt.separate-callers-num"/>=B</option> - <option><xref linkend="opt.separate-callers-num"/>=C</option>, + <option><link linkend="opt.separate-callers-num">--separate-callers2=B</link></option> + <option><link linkend="opt.separate-callers-num">--separate-callers2=C</link></option>, and functions "B" and "C" will be treated as different functions depending on the direct caller. Using the apostrophe for appending this "context" to the function name, you get "A > B'A > C'B" and "A > C'A > B'C", and there will be no cycle. Use - <option><xref linkend="opt.separate-callers"/>=2</option> to get a 2-caller + <option><link linkend="opt.separate-callers">--separate-callers=2</link></option> to get a 2-caller dependency for all functions. Note that doing this will increase the size of profile data files.</para> @@ -539,9 +547,9 @@ In the following, options are grouped into classes. </para> <para> Some options allow the specification of a function/symbol name, such as -<option><xref linkend="opt.dump-before"/>=function</option>, or -<option><xref linkend="opt.fn-skip"/>=function</option>. All these options -can be specified multiple times for different functions. +<option><link linkend="opt.dump-before">--dump-before=function</link></option>, or +<option><link linkend="opt.fn-skip">--fn-skip=function</link></option>. +All these options can be specified multiple times for different functions. In addition, the function specifications actually are patterns by supporting the use of wildcards '*' (zero or more arbitrary characters) and '?' (exactly one arbitrary character), similar to file name globbing in the @@ -572,7 +580,8 @@ These options influence the name and format of the profile data files. <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core - option <option><xref linkend="opt.log-file"/></option>. + option + <option><link linkend="opt.log-file">--log-file</link></option>. When multiple dumps are made, the file name is modified further; see below.</para> </listitem> @@ -762,7 +771,7 @@ Also see <xref linkend="cl-manual.limits"/>.</para> dumps is not practical here.</para> <para>Collection state can be toggled at entry and exit of a given function with the - option <option><xref linkend="opt.toggle-collect"/></option>. If you + option <option><link linkend="opt.toggle-collect">--toggle-collect</link></option>. If you use this option, collection state should be disabled at the beginning. Note that the specification of <option>--toggle-collect</option> @@ -1198,8 +1207,9 @@ their arguments.</para> <listitem> <para>Toggle the collection state. This allows to ignore events with regard to profile counters. See also options - <option><xref linkend="opt.collect-atstart"/></option> and - <option><xref linkend="opt.toggle-collect"/></option>.</para> + <option><link linkend="opt.collect-atstart">--collect-atstart</link></option> + and + <option><link linkend="opt.toggle-collect">--toggle-collect</link></option>.</para> </listitem> </varlistentry> @@ -1212,7 +1222,9 @@ their arguments.</para> When cache simulation is done, this will flush the simulated cache and lead to an artificial cache warmup phase afterwards with cache misses which would not have happened in reality. See also - option <option><xref linkend="opt.instr-atstart"/></option>.</para> + option + <option><link linkend="opt.instr-atstart">--instr-atstart</link></option>. + </para> </listitem> </varlistentry> @@ -1228,7 +1240,8 @@ their arguments.</para> speed up the Callgrind run for uninteresting code parts. Use <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput> to enable instrumentation again. See also option - <option><xref linkend="opt.instr-atstart"/></option>.</para> + <option><link linkend="opt.instr-atstart">--instr-atstart</link></option>. + </para> </listitem> </varlistentry> diff --git a/dhat/docs/dh-manual.xml b/dhat/docs/dh-manual.xml index e1d2ac6141..eeb6080551 100644 --- a/dhat/docs/dh-manual.xml +++ b/dhat/docs/dh-manual.xml @@ -689,7 +689,7 @@ triggered.</para> <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core - option <option><xref linkend="opt.log-file"/></option>. + option <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml index f6ba05439b..7141e07c2f 100644 --- a/exp-bbv/docs/bbv-manual.xml +++ b/exp-bbv/docs/bbv-manual.xml @@ -128,7 +128,7 @@ command line.</para> <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option - <option><xref linkend="opt.log-file"/></option>. + <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> @@ -148,7 +148,7 @@ command line.</para> <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option - <option><xref linkend="opt.log-file"/></option>. + <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/massif/docs/ms-manual.xml b/massif/docs/ms-manual.xml index f8637de807..8d41286cff 100644 --- a/massif/docs/ms-manual.xml +++ b/massif/docs/ms-manual.xml @@ -391,7 +391,7 @@ a small amount of information is recorded for each one:</para> larger number, usually 8 or 16. This is required to ensure that elements within the block are suitably aligned. If N bytes are asked for, Massif rounds N up to the nearest multiple of the value specified by the - <option><xref linkend="opt.alignment"/></option> option. + <option><link linkend="opt.alignment">--alignment</link></option> option. </para></listitem> <listitem><para>The size of the stack(s). By default, stack profiling is @@ -866,7 +866,7 @@ various places online. <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option - <option><xref linkend="opt.log-file"/></option>. + <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml index 5d6031376c..9d7d217221 100644 --- a/memcheck/docs/mc-manual.xml +++ b/memcheck/docs/mc-manual.xml @@ -104,8 +104,9 @@ which has already been freed, you'll be informed of this, and also where the block was freed. Likewise, if it should turn out to be just off the end of a heap block, a common result of off-by-one-errors in array subscripting, you'll be informed of this fact, and also where the -block was allocated. If you use the <option><xref -linkend="opt.read-var-info"/></option> option Memcheck will run more slowly +block was allocated. If you use the <option><link +linkend="opt.read-var-info">--read-var-info</link></option> option +Memcheck will run more slowly but may give a more detailed description of any illegal address.</para> <para>In this example, Memcheck can't identify the address. Actually |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:56:56
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=4cc73dcc2825d921fe20b8184e0b79982f32a739 commit 4cc73dcc2825d921fe20b8184e0b79982f32a739 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 00:53:16 2020 +0200 cl-manual.xml: xref cannot be used inside computeroutput, use link. Diff: --- callgrind/docs/cl-manual.xml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 67e677ed02..10da8d973a 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -190,7 +190,7 @@ has to rely on heuristics to detect calls and returns.</para> <computeroutput>callgrind_control -i on</computeroutput> just before the interesting code section is executed. To exactly specify the code position where profiling should start, use the client request - <computeroutput><xref linkend="cr.start-instr"/></computeroutput>.</para> + <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput>.</para> <para>If you want to be able to see assembly code level annotation, specify <option><xref linkend="opt.dump-instr"/>=yes</option>. This will produce @@ -286,9 +286,10 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa <listitem> <para><command>Program controlled dumping.</command> Insert - <computeroutput><xref linkend="cr.dump-stats"/>;</computeroutput> - at the position in your code where you want a profile dump to happen. Use - <computeroutput><xref linkend="cr.zero-stats"/>;</computeroutput> to only + <computeroutput><link linkend="cr.dump-stats">CALLGRIND_DUMP_STATS</link>;</computeroutput> + at the position in your code where you want a profile dump to + happen. Use + <computeroutput><link linkend="cr.zero-stats">CALLGRIND_ZERO_STATS</link>;</computeroutput> to only zero profile counters. See <xref linkend="cl-manual.clientrequests"/> for more information on Callgrind specific client requests.</para> @@ -364,8 +365,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa interactively with: <screen>callgrind_control -i on</screen> (and switching off again by specifying "off" instead of "on"). Second, instrumentation state can be programmatically changed with the - macros <computeroutput><xref linkend="cr.start-instr"/>;</computeroutput> - and <computeroutput><xref linkend="cr.stop-instr"/>;</computeroutput>. + macros <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link>;</computeroutput> + and <computeroutput><link linkend="cr.stop-instr">CALLGRIND_STOP_INSTRUMENTATION</link>;</computeroutput>. </para> <para>Similarly, the collection state at program start can be @@ -511,8 +512,9 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa <para>If your program forks, the child will inherit all the profiling data that has been gathered for the parent. To start with empty profile counter values in the child, the client request - <computeroutput><xref linkend="cr.zero-stats"/>;</computeroutput> - can be inserted into code to be executed by the child, directly after + <computeroutput><link linkend="cr.zero-stats">CALLGRIND_ZERO_STATS</link>;</computeroutput> + can be inserted into code to be executed by the child, directly + after <computeroutput>fork</computeroutput>.</para> <para>However, you will have to make sure that the output file format string @@ -1224,8 +1226,8 @@ their arguments.</para> instrumentation afterwards: it effectivly will run at the same speed as Nulgrind, i.e. at minimal slowdown. Use this to speed up the Callgrind run for uninteresting code parts. Use - <computeroutput><xref linkend="cr.start-instr"/></computeroutput> to - enable instrumentation again. See also option + <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput> + to enable instrumentation again. See also option <option><xref linkend="opt.instr-atstart"/></option>.</para> </listitem> </varlistentry> |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:56:50
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=77052fccbc6630d88950019735943444c3ebdb5f commit 77052fccbc6630d88950019735943444c3ebdb5f Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 00:48:34 2020 +0200 ms_print-manpage.xml: date is not a valid tag inside refmeta. Diff: --- massif/docs/ms_print-manpage.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index cd1f4a061c..856728ec8a 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -10,7 +10,6 @@ <refentrytitle>ms_print</refentrytitle> <manvolnum>1</manvolnum> <refmiscinfo>Release &rel-version;</refmiscinfo> - <date>rel-date</date> </refmeta> <refnamediv> |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:56:43
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=022f8daf02ca89acfcb2875ed78f7fa4ee2522e7 commit 022f8daf02ca89acfcb2875ed78f7fa4ee2522e7 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 00:38:27 2020 +0200 drd-manual.xml: C++ isn't a valid id syntax, use CXX instead. Diff: --- drd/docs/drd-manual.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drd/docs/drd-manual.xml b/drd/docs/drd-manual.xml index 8e28e96e26..897a1bbe53 100644 --- a/drd/docs/drd-manual.xml +++ b/drd/docs/drd-manual.xml @@ -1285,7 +1285,7 @@ before Valgrind's header files are available. </sect2> -<sect2 id="drd-manual.C++11" xreflabel="C++11"> +<sect2 id="drd-manual.CXX11" xreflabel="C++11"> <title>Debugging C++11 Programs</title> <para>If you want to use the C++11 class std::thread you will need to do the |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:56:27
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=66d7f279e7c6aa450d4ef32c4c59c5bef74572fa commit 66d7f279e7c6aa450d4ef32c4c59c5bef74572fa Author: Mark Wielaard <ma...@kl...> Date: Wed May 13 23:51:52 2020 +0200 nl-manual.xml: Use unique nl-manual.overview as id, not ms-manual.overview. Diff: --- none/docs/nl-manual.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/none/docs/nl-manual.xml b/none/docs/nl-manual.xml index 53758f214e..eae9a52cd9 100644 --- a/none/docs/nl-manual.xml +++ b/none/docs/nl-manual.xml @@ -11,7 +11,7 @@ <option>--tool=none</option> on the Valgrind command line.</para> -<sect1 id="ms-manual.overview" xreflabel="Overview"> +<sect1 id="nl-manual.overview" xreflabel="Overview"> <title>Overview</title> <para>Nulgrind is the simplest possible Valgrind tool. It performs no |
|
From: Mark W. <ma...@so...> - 2020-05-15 12:56:18
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=1922e3622847aa4451b7aee3149f054488734df9 commit 1922e3622847aa4451b7aee3149f054488734df9 Author: Mark Wielaard <ma...@kl...> Date: Wed May 13 23:39:40 2020 +0200 Don't use similar ids for varlistentry in cg-manual and cl-manual. Diff: --- cachegrind/docs/cg-manual.xml | 6 +++--- callgrind/docs/cl-manual.xml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index 353e1dbc6d..7a44e489f2 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -793,7 +793,7 @@ small differences like these; it works in the same way as <variablelist id="cg.opts.list"> - <varlistentry id="opt.I1" xreflabel="--I1"> + <varlistentry id="cg.opt.I1" xreflabel="--I1"> <term> <option><![CDATA[--I1=<size>,<associativity>,<line size> ]]></option> </term> @@ -803,7 +803,7 @@ small differences like these; it works in the same way as </listitem> </varlistentry> - <varlistentry id="opt.D1" xreflabel="--D1"> + <varlistentry id="cg.opt.D1" xreflabel="--D1"> <term> <option><![CDATA[--D1=<size>,<associativity>,<line size> ]]></option> </term> @@ -813,7 +813,7 @@ small differences like these; it works in the same way as </listitem> </varlistentry> - <varlistentry id="opt.LL" xreflabel="--LL"> + <varlistentry id="cg.opt.LL" xreflabel="--LL"> <term> <option><![CDATA[--LL=<size>,<associativity>,<line size> ]]></option> </term> diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 713c1b7453..67e677ed02 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -1082,7 +1082,7 @@ Also see <xref linkend="cl-manual.cycles"/>.</para> </listitem> </varlistentry> - <varlistentry id="opt.I1" xreflabel="--I1"> + <varlistentry id="cl.opt.I1" xreflabel="--I1"> <term> <option><![CDATA[--I1=<size>,<associativity>,<line size> ]]></option> </term> @@ -1092,7 +1092,7 @@ Also see <xref linkend="cl-manual.cycles"/>.</para> </listitem> </varlistentry> - <varlistentry id="opt.D1" xreflabel="--D1"> + <varlistentry id="cl.opt.D1" xreflabel="--D1"> <term> <option><![CDATA[--D1=<size>,<associativity>,<line size> ]]></option> </term> @@ -1102,7 +1102,7 @@ Also see <xref linkend="cl-manual.cycles"/>.</para> </listitem> </varlistentry> - <varlistentry id="opt.LL" xreflabel="--LL"> + <varlistentry id="cl.opt.LL" xreflabel="--LL"> <term> <option><![CDATA[--LL=<size>,<associativity>,<line size> ]]></option> </term> |
|
From: Mark W. <ma...@so...> - 2020-05-15 10:36:09
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=a2ef3fcf6a05fbc423b9ff6ad17867e0c2249b5b commit a2ef3fcf6a05fbc423b9ff6ad17867e0c2249b5b Author: Mark Wielaard <ma...@kl...> Date: Fri May 15 12:30:00 2020 +0200 Explicitly set stylesheet to use with xmlto. Diff: --- docs/Makefile.am | 2 ++ docs/README | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/Makefile.am b/docs/Makefile.am index 4a7e3d9870..db833cab53 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -189,6 +189,7 @@ print-docs: mkdir -p $(myprintdir)/images && \ cp $(myimgdir)/*.png $(myprintdir)/images && \ xmlto -v $(WITH_FOP) --stringparam=keep.relative.image.uris="1" \ + -x $(XSL_FO_STYLE) \ --searchpath print pdf $(myxmldir)/index.xml &> $(LOGFILE) && \ echo "Generating PS file: $(myprintdir)/index.ps ..." && \ pdftops index.pdf && \ @@ -301,6 +302,7 @@ download-docs: mkdir -p $(vgdir)/print/images cp $(myimgdir)/*.png $(vgdir)/print/images/ xmlto -v $(WITH_FOP) --stringparam=keep.relative.image.uris="1" \ + -x $(XSL_FO_STYLE) \ --searchpath print pdf $(myxmldir)/index.xml &> $(LOGFILE) mv index.pdf $(vgdir)/print/manual.pdf @echo "" diff --git a/docs/README b/docs/README index 482fe82777..bae567c908 100644 --- a/docs/README +++ b/docs/README @@ -94,6 +94,8 @@ If fop is giving you trouble you can edit the docs/Makefile.am file at the top to remove WITH_FOP. It will then fall back to pdfxmltex for which you will need the hack described in "Notes [Mar 2015]". +On Fedora the pdftops command is provided by poppler-utils. + Notes [Jan 2019] ----------------- For Ubuntu 18.04, to build HTML docs I had to: |
|
From: Mark W. <ma...@so...> - 2020-05-14 23:13:26
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=5f4a5783aa24b549c088f7409846898012fe15f1 commit 5f4a5783aa24b549c088f7409846898012fe15f1 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 22:45:30 2020 +0200 Move to xmlto with fop for print-docs. Default to using fop for pdf generation. pdfxmltex is known to be broken by default. xmlto can also use pdfxmltex or dblatex if available. Diff: --- docs/Makefile.am | 31 +++++++++++++++++-------------- docs/README | 11 +++++++++++ 2 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index 931caf6be9..4a7e3d9870 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -9,6 +9,12 @@ # you need to re-run autogen.sh and configure to make it take effect. BUILD_ALL_DOCS=yes +# Whether to run xmlto pdf --with-fop +# This is de fault, set to empty to use the default fo to pdf +# processor that xmlto uses (which might be pdfxmltex, which is +# known to be broken). +WITH_FOP=--with-fop + ##------------------------------------------------------------- ## END OF HACK ##------------------------------------------------------------- @@ -182,14 +188,12 @@ print-docs: mkdir -p $(myprintdir) && \ mkdir -p $(myprintdir)/images && \ cp $(myimgdir)/*.png $(myprintdir)/images && \ - $(XSLTPROC) $(XSLTPROC_FLAGS) -o $(myprintdir)/index.fo $(XSL_FO_STYLE) $(myxmldir)/index.xml && \ - (cd $(myprintdir) && \ - ( pdfxmltex index.fo && \ - pdfxmltex index.fo && \ - pdfxmltex index.fo ) &> $(LOGFILE) < /dev/null && \ - echo "Generating PS file: $(myprintdir)/index.ps ..." && \ - pdftops index.pdf && \ - rm -f *.log *.aux *.fo *.out) + xmlto -v $(WITH_FOP) --stringparam=keep.relative.image.uris="1" \ + --searchpath print pdf $(myxmldir)/index.xml &> $(LOGFILE) && \ + echo "Generating PS file: $(myprintdir)/index.ps ..." && \ + pdftops index.pdf && \ + mv index.pdf index.ps $(myprintdir) && \ + rm $(LOGFILE) # If the docs have been built, install them. But don't worry if they have # not -- developers do 'make install' not from a 'make dist'-ified distro all @@ -295,11 +299,10 @@ download-docs: @echo "Generating valgrind_manual.pdf ..." mkdir -p $(vgdir)/print mkdir -p $(vgdir)/print/images - $(XSLTPROC) $(XSLTPROC_FLAGS) -o $(vgdir)/print/manual.fo $(XSL_FO_STYLE) $(myxmldir)/index.xml - (cd $(vgdir)/print/ && \ - ( pdfxmltex manual.fo && \ - pdfxmltex manual.fo && \ - pdfxmltex manual.fo ) &> $(LOGFILE) < /dev/null ) + cp $(myimgdir)/*.png $(vgdir)/print/images/ + xmlto -v $(WITH_FOP) --stringparam=keep.relative.image.uris="1" \ + --searchpath print pdf $(myxmldir)/index.xml &> $(LOGFILE) + mv index.pdf $(vgdir)/print/manual.pdf @echo "" @echo "Generating valgrind_manual.ps.bz2 ..." (cd $(vgdir)/print/ && \ @@ -307,4 +310,4 @@ download-docs: mv $(vgdir)/print/manual.pdf $(downloadsdir)/valgrind_manual.pdf mv $(vgdir)/print/manual.ps $(downloadsdir)/valgrind_manual.ps bzip2 $(downloadsdir)/valgrind_manual.ps - /bin/rm -fr $(vgdir) + /bin/rm -fr $(vgdir) $(LOGFILE) diff --git a/docs/README b/docs/README index 76245b5164..482fe82777 100644 --- a/docs/README +++ b/docs/README @@ -83,6 +83,17 @@ from the XML source at various times on various Linux distros. They're mostly about the PDF/PS documents, because they are the hardest to build. +Notes [May 2020] +---------------- + +The default pdf generation has switched to xmlto using fop. +Make sure to install the packages xmlto fop (and on Fedora +also xmlto-tex). For other package requirements, see below. + +If fop is giving you trouble you can edit the docs/Makefile.am file +at the top to remove WITH_FOP. It will then fall back to pdfxmltex +for which you will need the hack described in "Notes [Mar 2015]". + Notes [Jan 2019] ----------------- For Ubuntu 18.04, to build HTML docs I had to: |
|
From: Mark W. <ma...@so...> - 2020-05-14 23:13:18
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=052cc9741642ce7e0d4cfdd4c7a27b7c0eb842ec commit 052cc9741642ce7e0d4cfdd4c7a27b7c0eb842ec Author: Mark Wielaard <ma...@kl...> Date: Fri May 15 00:43:33 2020 +0200 Run xmllint on make check. Now that we have valid docbookx xml lets try to keep it that way. If the user has xmllint installed then run it on make check. Diff: --- docs/Makefile.am | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index f63116b5fe..931caf6be9 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -133,8 +133,12 @@ XSL_MAN_STYLES = \ all-docs: FAQ.txt man-pages html-docs print-docs valid: - $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/index.xml - $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/manpages-index.xml + if type $(XMLLINT) 2>/dev/null; then \ + $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/index.xml; \ + $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/manpages-index.xml; \ + fi + +check-local: valid # The text version of the FAQ. FAQ.txt: |
|
From: Mark W. <ma...@so...> - 2020-05-14 17:14:13
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=21ceb09d5debb74bda84af2060339c885af48285 commit 21ceb09d5debb74bda84af2060339c885af48285 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 19:11:22 2020 +0200 Set refmiscinfo class to version in all manpages. Otherwise xsltproc will complain while producing the manpage that it doesn't know how to interpret the release string. Diff: --- auxprogs/docs/valgrind-di-server-manpage.xml | 2 +- auxprogs/docs/valgrind-listener-manpage.xml | 2 +- cachegrind/docs/cg_annotate-manpage.xml | 2 +- cachegrind/docs/cg_diff-manpage.xml | 2 +- cachegrind/docs/cg_merge-manpage.xml | 2 +- callgrind/docs/callgrind_annotate-manpage.xml | 2 +- callgrind/docs/callgrind_control-manpage.xml | 2 +- coregrind/docs/vgdb-manpage.xml | 2 +- docs/xml/valgrind-manpage.xml | 2 +- massif/docs/ms_print-manpage.xml | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/auxprogs/docs/valgrind-di-server-manpage.xml b/auxprogs/docs/valgrind-di-server-manpage.xml index e42a744bc3..3b029ee773 100644 --- a/auxprogs/docs/valgrind-di-server-manpage.xml +++ b/auxprogs/docs/valgrind-di-server-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>valgrind-di-server</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/auxprogs/docs/valgrind-listener-manpage.xml b/auxprogs/docs/valgrind-listener-manpage.xml index 705f9001da..f763e9e8cc 100644 --- a/auxprogs/docs/valgrind-listener-manpage.xml +++ b/auxprogs/docs/valgrind-listener-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>valgrind-listener</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml index 61854cf08f..5790eb0609 100644 --- a/cachegrind/docs/cg_annotate-manpage.xml +++ b/cachegrind/docs/cg_annotate-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>cg_annotate</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/cachegrind/docs/cg_diff-manpage.xml b/cachegrind/docs/cg_diff-manpage.xml index 1af0c15427..daffdfbbb0 100644 --- a/cachegrind/docs/cg_diff-manpage.xml +++ b/cachegrind/docs/cg_diff-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>cg_diff</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/cachegrind/docs/cg_merge-manpage.xml b/cachegrind/docs/cg_merge-manpage.xml index 228f9d159f..e4e97310e5 100644 --- a/cachegrind/docs/cg_merge-manpage.xml +++ b/cachegrind/docs/cg_merge-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>cg_merge</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/callgrind/docs/callgrind_annotate-manpage.xml b/callgrind/docs/callgrind_annotate-manpage.xml index 21fe922227..e58c35eaa8 100644 --- a/callgrind/docs/callgrind_annotate-manpage.xml +++ b/callgrind/docs/callgrind_annotate-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>Callgrind Annotate</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv id="a-name"> diff --git a/callgrind/docs/callgrind_control-manpage.xml b/callgrind/docs/callgrind_control-manpage.xml index d6f7e654a3..5755d1f561 100644 --- a/callgrind/docs/callgrind_control-manpage.xml +++ b/callgrind/docs/callgrind_control-manpage.xml @@ -8,7 +8,7 @@ <refmeta> <refentrytitle>Callgrind Control</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv id="c-name"> diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index 090ff56682..7ba82f8e80 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>vgdb</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index d81382dca4..3c893c680e 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>VALGRIND</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="source">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index 3ac62739b5..085a21ab54 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -9,7 +9,7 @@ <refmeta> <refentrytitle>ms_print</refentrytitle> <manvolnum>1</manvolnum> - <refmiscinfo>Release &rel-version;</refmiscinfo> + <refmiscinfo class="version">Release &rel-version;</refmiscinfo> </refmeta> <refnamediv> |
|
From: Mark W. <ma...@so...> - 2020-05-14 17:14:06
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=e35c8a096a19ed370c4d83c069180dbd6bed838b commit e35c8a096a19ed370c4d83c069180dbd6bed838b Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 18:47:57 2020 +0200 Resolve id conflicts in See Also sections in valgrind and vgdb manpages. Because the manpages are processed together they cannot contain the same ids. Both the valgrind and vgdb manpage reference the vgdb main manual URL. That conflicts even though the valgrind.1 and vgdb.1 manual page are separate. Prefixing the vgdb ids (with "vgdb-") works around the conflict. It still works fine, since in vgdb the references are only directly used in the "See Also" refsect. The labels and urls still come out as intended. With this fix make valid validates both the manual index.xml and manpages-index.xml without errors. Diff: --- coregrind/docs/vgdb-manpage.xml | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index 2eeedbd490..090ff56682 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -57,13 +57,18 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes: valgrind(1), <filename>&vg-docs-path;</filename> or <filename>&vg-docs-url;</filename>, -<ulink id="&vg-gdbserver-id;" +<!-- Note that the ids used have vgdb- prefixed. This is because the same + ids are used in the valgrind.1 man page. That conflict even though + the valgrind.1 and vgdb.1 manual page are generated separately. It + still works fine, since in vgdb the references are only direct in this + "See Also" refsect. The labels and urls still come out as intended. --> +<ulink id="vgdb-&vg-gdbserver-id;" xreflabel="&vg-gdbserver-label;" url="&vg-gdbserver-url;">&vg-gdbserver-label;</ulink> -<ulink id="&vg-vgdb-id;" +<ulink id="vgdb-&vg-vgdb-id;" xreflabel="&vg-vgdb-label;" url="&vg-vgdb-url;">&vg-vgdb-label;</ulink>, -<ulink id="&vg-monitor-id;" +<ulink id="vgdb-&vg-monitor-id;" xreflabel="&vg-monitor-label;" url="&vg-monitor-url;">&vg-monitor-label;</ulink>. </para> |
|
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> |
|
From: Mark W. <ma...@so...> - 2020-05-14 15:57:18
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=28b8d8b5a1e3d620621bdb5f00ccd931840bb331 commit 28b8d8b5a1e3d620621bdb5f00ccd931840bb331 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 16:07:04 2020 +0200 Turn manpages-index.xml into a "real" book, so it can be validated. manpages-index.xml is just to easily get at each individual man page with xsltproc. It wasn't a complete docbookx xml file. Now that it is we can validate it with xmllint. It doesn't fully validate, but we are close. Diff: --- auxprogs/docs/valgrind-di-server-manpage.xml | 8 +++---- auxprogs/docs/valgrind-listener-manpage.xml | 8 +++---- cachegrind/docs/cg_annotate-manpage.xml | 8 +++---- cachegrind/docs/cg_diff-manpage.xml | 8 +++---- cachegrind/docs/cg_merge-manpage.xml | 8 +++---- coregrind/docs/vgdb-manpage.xml | 8 +++---- docs/Makefile.am | 1 + docs/xml/manpages-index.xml | 32 ++++++++++++++++++++++++++++ massif/docs/ms_print-manpage.xml | 8 +++---- 9 files changed, 61 insertions(+), 28 deletions(-) diff --git a/auxprogs/docs/valgrind-di-server-manpage.xml b/auxprogs/docs/valgrind-di-server-manpage.xml index a1244600be..e42a744bc3 100644 --- a/auxprogs/docs/valgrind-di-server-manpage.xml +++ b/auxprogs/docs/valgrind-di-server-manpage.xml @@ -25,7 +25,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="di-server-description"> <title>Description</title> <para><command>valgrind-di-server</command> accepts (multiple) connections @@ -38,7 +38,7 @@ from <command>valgrind</command> processes that use the -<refsect1 id="options"> +<refsect1 id="di-server-options"> <title>Options</title> <variablelist> <varlistentry> @@ -74,7 +74,7 @@ from <command>valgrind</command> processes that use the -<refsect1 id="see_also"> +<refsect1 id="di-server-see_also"> <title>See Also</title> <para> @@ -86,7 +86,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="di-server-author"> <title>Author</title> <para>Julian Seward.</para> diff --git a/auxprogs/docs/valgrind-listener-manpage.xml b/auxprogs/docs/valgrind-listener-manpage.xml index b94e2a5f62..705f9001da 100644 --- a/auxprogs/docs/valgrind-listener-manpage.xml +++ b/auxprogs/docs/valgrind-listener-manpage.xml @@ -25,7 +25,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="listener-description"> <title>Description</title> <para><command>valgrind-listener</command> accepts (multiple) connections @@ -38,7 +38,7 @@ commentary it is sent to stdout. -<refsect1 id="options"> +<refsect1 id="listener-options"> <title>Options</title> <xi:include href="../../docs/xml/manual-core.xml" xpointer="listener.opts.list" @@ -49,7 +49,7 @@ commentary it is sent to stdout. -<refsect1 id="see_also"> +<refsect1 id="listener-see_also"> <title>See Also</title> <para> @@ -61,7 +61,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="listener-author"> <title>Author</title> <para>Julian Seward.</para> diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml index 112f1607d4..61854cf08f 100644 --- a/cachegrind/docs/cg_annotate-manpage.xml +++ b/cachegrind/docs/cg_annotate-manpage.xml @@ -27,7 +27,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="cg_annotate-description"> <title>Description</title> <para><command>cg_annotate</command> takes an output file produced by the @@ -38,7 +38,7 @@ Valgrind tool Cachegrind and prints the information in an easy-to-read form. -<refsect1 id="options"> +<refsect1 id="cg_annotate-options"> <title>Options</title> <xi:include href="cg-manual.xml" xpointer="cg_annotate.opts.list" @@ -49,7 +49,7 @@ Valgrind tool Cachegrind and prints the information in an easy-to-read form. -<refsect1 id="see_also"> +<refsect1 id="cg_annotate-see_also"> <title>See Also</title> <para> @@ -61,7 +61,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="cg_annotate-author"> <title>Author</title> <para>Nicholas Nethercote.</para> diff --git a/cachegrind/docs/cg_diff-manpage.xml b/cachegrind/docs/cg_diff-manpage.xml index c37a55acb6..1af0c15427 100644 --- a/cachegrind/docs/cg_diff-manpage.xml +++ b/cachegrind/docs/cg_diff-manpage.xml @@ -27,7 +27,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="cg_diff-description"> <title>Description</title> <para><command>cg_diff</command> takes two output files produced by the @@ -39,7 +39,7 @@ in the same format that Cachegrinds outputs. -<refsect1 id="options"> +<refsect1 id="cg_diff-options"> <title>Options</title> <xi:include href="cg-manual.xml" xpointer="cg_diff.opts.list" @@ -50,7 +50,7 @@ in the same format that Cachegrinds outputs. -<refsect1 id="see_also"> +<refsect1 id="cg_diff-see_also"> <title>See Also</title> <para> @@ -62,7 +62,7 @@ cg_annotate(1), valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="cg_diff-author"> <title>Author</title> <para>Nicholas Nethercote.</para> diff --git a/cachegrind/docs/cg_merge-manpage.xml b/cachegrind/docs/cg_merge-manpage.xml index 72227b8b1c..228f9d159f 100644 --- a/cachegrind/docs/cg_merge-manpage.xml +++ b/cachegrind/docs/cg_merge-manpage.xml @@ -26,7 +26,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="cg_merge-description"> <title>Description</title> <para><command>cg_merge</command> sums together the outputs of multiple @@ -37,7 +37,7 @@ Cachegrind runs into a single output file. -<refsect1 id="options"> +<refsect1 id="cg_merge-options"> <title>Options</title> <xi:include href="cg-manual.xml" xpointer="cg_merge.opts.list" @@ -48,7 +48,7 @@ Cachegrind runs into a single output file. -<refsect1 id="see_also"> +<refsect1 id="cg_merge-see_also"> <title>See Also</title> <para> @@ -60,7 +60,7 @@ cg_annotate(1), valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="cg_merge-author"> <title>Author</title> <para>Nicholas Nethercote.</para> diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index d5aa305358..2eeedbd490 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -25,7 +25,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="vgdb-description"> <title>Description</title> <para><command>vgdb</command> ("Valgrind to GDB") is used as an @@ -38,7 +38,7 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes: </refsect1> -<refsect1 id="options"> +<refsect1 id="vgdb-options"> <title>Options</title> <xi:include href="../../docs/xml/manual-core-adv.xml" @@ -50,7 +50,7 @@ intermediary between Valgrind and GDB or a shell. It has two usage modes: -<refsect1 id="see_also"> +<refsect1 id="vgdb-see_also"> <title>See Also</title> <para> @@ -71,7 +71,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="vgdb-author"> <title>Author</title> <para>Philippe Waroquiers.</para> diff --git a/docs/Makefile.am b/docs/Makefile.am index f875d6dcc3..f63116b5fe 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -134,6 +134,7 @@ all-docs: FAQ.txt man-pages html-docs print-docs valid: $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/index.xml + $(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/manpages-index.xml # The text version of the FAQ. FAQ.txt: diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml index 3e422c1431..17a81c99f0 100644 --- a/docs/xml/manpages-index.xml +++ b/docs/xml/manpages-index.xml @@ -6,46 +6,78 @@ point $(XSTLPROC) at a single file and get all the man pages. --> <set> +<book> <!-- valgrind --> +<chapter> +<title>valgrind</title> <xi:include href="valgrind-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- cg_annotate --> +<chapter> +<title>cg_annotate</title> <xi:include href="../../cachegrind/docs/cg_annotate-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- cg_diff --> +<chapter> +<title>cg_diff</title> <xi:include href="../../cachegrind/docs/cg_diff-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- cg_merge --> +<chapter> +<title>cg_merge</title> <xi:include href="../../cachegrind/docs/cg_merge-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- callgrind_annotate --> +<chapter> +<title>callgrind_annotate</title> <xi:include href="../../callgrind/docs/callgrind_annotate-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- callgrind_control --> +<chapter> +<title>callgrind_control</title> <xi:include href="../../callgrind/docs/callgrind_control-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- ms_print --> +<chapter> +<title>ms_print</title> <xi:include href="../../massif/docs/ms_print-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- valgrind-listener --> +<chapter> +<title>valgrind-listener</title> <xi:include href="../../auxprogs/docs/valgrind-listener-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- valgrind-di-server --> +<chapter> +<title>valgrind-di-server</title> <xi:include href="../../auxprogs/docs/valgrind-di-server-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> <!-- vgdb --> +<chapter> +<title>vgdb</title> <xi:include href="../../coregrind/docs/vgdb-manpage.xml" parse="xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> +</book> </set> diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index 47a74c8764..3ac62739b5 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -26,7 +26,7 @@ </refsynopsisdiv> -<refsect1 id="description"> +<refsect1 id="ms_print-description"> <title>Description</title> <para><command>ms_print</command> takes an output file produced by the @@ -37,7 +37,7 @@ Valgrind tool Massif and prints the information in an easy-to-read form. -<refsect1 id="options"> +<refsect1 id="ms_print-options"> <title>Options</title> <xi:include href="ms-manual.xml" xpointer="ms_print.opts.list" @@ -48,7 +48,7 @@ Valgrind tool Massif and prints the information in an easy-to-read form. -<refsect1 id="see_also"> +<refsect1 id="ms_print-see_also"> <title>See Also</title> <para> @@ -60,7 +60,7 @@ valgrind(1), </refsect1> -<refsect1 id="author"> +<refsect1 id="ms_print-author"> <title>Author</title> <para>Nicholas Nethercote.</para> |
|
From: Mark W. <ma...@so...> - 2020-05-14 15:57:11
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=555ddc4753e9014b809683c840867ed424dd7d99 commit 555ddc4753e9014b809683c840867ed424dd7d99 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 15:11:56 2020 +0200 Use DTD DocBook XML V4.5 everywhere. This makes the rule for xmllint easier since it doesn't need to override the DTD to validate against. It also helps with other tools tryinf to process the docbookx xml files. Diff: --- auxprogs/docs/valgrind-di-server-manpage.xml | 4 ++-- auxprogs/docs/valgrind-listener-manpage.xml | 4 ++-- cachegrind/docs/cg-manual.xml | 4 ++-- cachegrind/docs/cg_annotate-manpage.xml | 4 ++-- cachegrind/docs/cg_diff-manpage.xml | 4 ++-- cachegrind/docs/cg_merge-manpage.xml | 4 ++-- callgrind/docs/callgrind_annotate-manpage.xml | 4 ++-- callgrind/docs/callgrind_control-manpage.xml | 4 ++-- callgrind/docs/cl-format.xml | 4 ++-- callgrind/docs/cl-manual.xml | 4 ++-- coregrind/docs/vgdb-manpage.xml | 4 ++-- dhat/docs/dh-manual.xml | 4 ++-- docs/Makefile.am | 5 +---- docs/xml/FAQ.xml | 4 ++-- docs/xml/design-impl.xml | 4 ++-- docs/xml/dist-docs.xml | 4 ++-- docs/xml/index.xml | 4 ++-- docs/xml/licenses.xml | 4 ++-- docs/xml/manpages-index.xml | 4 ++-- docs/xml/manual-core-adv.xml | 4 ++-- docs/xml/manual-core.xml | 4 ++-- docs/xml/manual-intro.xml | 4 ++-- docs/xml/manual-writing-tools.xml | 4 ++-- docs/xml/manual.xml | 4 ++-- docs/xml/quick-start-guide.xml | 4 ++-- docs/xml/tech-docs.xml | 4 ++-- docs/xml/valgrind-manpage.xml | 4 ++-- drd/docs/drd-manual.xml | 4 ++-- exp-bbv/docs/bbv-manual.xml | 4 ++-- helgrind/docs/hg-manual.xml | 4 ++-- lackey/docs/lk-manual.xml | 4 ++-- massif/docs/ms-manual.xml | 4 ++-- massif/docs/ms_print-manpage.xml | 4 ++-- memcheck/docs/mc-manual.xml | 4 ++-- memcheck/docs/mc-tech-docs.xml | 4 ++-- none/docs/nl-manual.xml | 4 ++-- 36 files changed, 71 insertions(+), 74 deletions(-) diff --git a/auxprogs/docs/valgrind-di-server-manpage.xml b/auxprogs/docs/valgrind-di-server-manpage.xml index deca81d0a4..a1244600be 100644 --- a/auxprogs/docs/valgrind-di-server-manpage.xml +++ b/auxprogs/docs/valgrind-di-server-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/auxprogs/docs/valgrind-listener-manpage.xml b/auxprogs/docs/valgrind-listener-manpage.xml index da761b1015..b94e2a5f62 100644 --- a/auxprogs/docs/valgrind-listener-manpage.xml +++ b/auxprogs/docs/valgrind-listener-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index adff8aa730..7fabfa7fee 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> <!-- Referenced from both the manual and manpage --> diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml index 095207182f..112f1607d4 100644 --- a/cachegrind/docs/cg_annotate-manpage.xml +++ b/cachegrind/docs/cg_annotate-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/cachegrind/docs/cg_diff-manpage.xml b/cachegrind/docs/cg_diff-manpage.xml index 4823db0718..c37a55acb6 100644 --- a/cachegrind/docs/cg_diff-manpage.xml +++ b/cachegrind/docs/cg_diff-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/cachegrind/docs/cg_merge-manpage.xml b/cachegrind/docs/cg_merge-manpage.xml index 5e733d2ffc..72227b8b1c 100644 --- a/cachegrind/docs/cg_merge-manpage.xml +++ b/cachegrind/docs/cg_merge-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/callgrind/docs/callgrind_annotate-manpage.xml b/callgrind/docs/callgrind_annotate-manpage.xml index 2d0482b1ab..21fe922227 100644 --- a/callgrind/docs/callgrind_annotate-manpage.xml +++ b/callgrind/docs/callgrind_annotate-manpage.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/callgrind/docs/callgrind_control-manpage.xml b/callgrind/docs/callgrind_control-manpage.xml index 952a1c0c13..d6f7e654a3 100644 --- a/callgrind/docs/callgrind_control-manpage.xml +++ b/callgrind/docs/callgrind_control-manpage.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/callgrind/docs/cl-format.xml b/callgrind/docs/cl-format.xml index 77fe5dfdf6..06a0449ad9 100644 --- a/callgrind/docs/cl-format.xml +++ b/callgrind/docs/cl-format.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> <chapter id="cl-format" xreflabel="Callgrind Format Specification"> diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index d8b65f8021..7b7172ed4b 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> <chapter id="cl-manual" xreflabel="Callgrind Manual"> diff --git a/coregrind/docs/vgdb-manpage.xml b/coregrind/docs/vgdb-manpage.xml index 85a62aadc7..d5aa305358 100644 --- a/coregrind/docs/vgdb-manpage.xml +++ b/coregrind/docs/vgdb-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/dhat/docs/dh-manual.xml b/dhat/docs/dh-manual.xml index eeb6080551..f52cca204d 100644 --- a/dhat/docs/dh-manual.xml +++ b/dhat/docs/dh-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/docs/Makefile.am b/docs/Makefile.am index ac9110e63e..f875d6dcc3 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -114,10 +114,7 @@ LOGFILE = print.log # validation stuff XMLLINT = xmllint -LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent -# validate with docbook 4.3 'cos it supports xml:base natively -VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd -XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS) +XMLLINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent # stylesheet processor XSLTPROC = xsltproc diff --git a/docs/xml/FAQ.xml b/docs/xml/FAQ.xml index 9919c8d40c..845f5bb96c 100644 --- a/docs/xml/FAQ.xml +++ b/docs/xml/FAQ.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/design-impl.xml b/docs/xml/design-impl.xml index f891f3ba8b..a7b0ab3678 100644 --- a/docs/xml/design-impl.xml +++ b/docs/xml/design-impl.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/docs/xml/dist-docs.xml b/docs/xml/dist-docs.xml index e4021ed923..9bf4d100ae 100644 --- a/docs/xml/dist-docs.xml +++ b/docs/xml/dist-docs.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/index.xml b/docs/xml/index.xml index 758c669132..3bdb38aa12 100644 --- a/docs/xml/index.xml +++ b/docs/xml/index.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/licenses.xml b/docs/xml/licenses.xml index e9c4ef65ad..e93bd6a367 100644 --- a/docs/xml/licenses.xml +++ b/docs/xml/licenses.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <book id="licenses" xreflabel="GNU Licenses"> diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml index a038ee416f..3e422c1431 100644 --- a/docs/xml/manpages-index.xml +++ b/docs/xml/manpages-index.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- This file is not part of the distributed docs, it's just here so we can point $(XSTLPROC) at a single file and get all the man pages. --> diff --git a/docs/xml/manual-core-adv.xml b/docs/xml/manual-core-adv.xml index fd05ecf2ec..fe05c8ef28 100644 --- a/docs/xml/manual-core-adv.xml +++ b/docs/xml/manual-core-adv.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml index b36009ed90..a5168acf62 100644 --- a/docs/xml/manual-core.xml +++ b/docs/xml/manual-core.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/manual-intro.xml b/docs/xml/manual-intro.xml index 6f730d1ac0..5f84671fd6 100644 --- a/docs/xml/manual-intro.xml +++ b/docs/xml/manual-intro.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> <chapter id="manual-intro" xreflabel="Introduction"> diff --git a/docs/xml/manual-writing-tools.xml b/docs/xml/manual-writing-tools.xml index a36d775544..272d54ccf8 100644 --- a/docs/xml/manual-writing-tools.xml +++ b/docs/xml/manual-writing-tools.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/manual.xml b/docs/xml/manual.xml index da37102d00..e71a9cf750 100644 --- a/docs/xml/manual.xml +++ b/docs/xml/manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> diff --git a/docs/xml/quick-start-guide.xml b/docs/xml/quick-start-guide.xml index f7bbf68741..a61f5f095a 100644 --- a/docs/xml/quick-start-guide.xml +++ b/docs/xml/quick-start-guide.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> <book id="QuickStart" xreflabel="Valgrind Quick Start Guide"> diff --git a/docs/xml/tech-docs.xml b/docs/xml/tech-docs.xml index 918e8e37eb..28070f970c 100644 --- a/docs/xml/tech-docs.xml +++ b/docs/xml/tech-docs.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]> <book id="tech-docs" xreflabel="Valgrind Technical Documentation"> diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml index 10decc258a..e1867c6ad6 100644 --- a/docs/xml/valgrind-manpage.xml +++ b/docs/xml/valgrind-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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 "vg-entities.xml"> %vg-entities; ]> diff --git a/drd/docs/drd-manual.xml b/drd/docs/drd-manual.xml index 897a1bbe53..8fe1903e6c 100644 --- a/drd/docs/drd-manual.xml +++ b/drd/docs/drd-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml index 7195e9151c..6be1ffeeee 100644 --- a/exp-bbv/docs/bbv-manual.xml +++ b/exp-bbv/docs/bbv-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="bbv-manual" xreflabel="BBV"> <title>BBV: an experimental basic block vector generation tool</title> diff --git a/helgrind/docs/hg-manual.xml b/helgrind/docs/hg-manual.xml index 887a4be519..44cb74603c 100644 --- a/helgrind/docs/hg-manual.xml +++ b/helgrind/docs/hg-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/lackey/docs/lk-manual.xml b/lackey/docs/lk-manual.xml index a5c7bbd327..4170a8c3dc 100644 --- a/lackey/docs/lk-manual.xml +++ b/lackey/docs/lk-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="lk-manual" xreflabel="Lackey"> diff --git a/massif/docs/ms-manual.xml b/massif/docs/ms-manual.xml index 8d41286cff..b590536889 100644 --- a/massif/docs/ms-manual.xml +++ b/massif/docs/ms-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" +<!DOCTYPE chapter 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; ]> diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index 856728ec8a..47a74c8764 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -1,6 +1,6 @@ <?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" +<!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; ]> diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml index 9d7d217221..2acf6fd4f7 100644 --- a/memcheck/docs/mc-manual.xml +++ b/memcheck/docs/mc-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="mc-manual" xreflabel="Memcheck: a memory error detector"> diff --git a/memcheck/docs/mc-tech-docs.xml b/memcheck/docs/mc-tech-docs.xml index 94911d0890..44bbb8c6ee 100644 --- a/memcheck/docs/mc-tech-docs.xml +++ b/memcheck/docs/mc-tech-docs.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="mc-tech-docs" diff --git a/none/docs/nl-manual.xml b/none/docs/nl-manual.xml index eae9a52cd9..6d1e89c5c4 100644 --- a/none/docs/nl-manual.xml +++ b/none/docs/nl-manual.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- -*- sgml -*- --> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="nl-manual" xreflabel="Nulgrind"> |
|
From: Mark W. <ma...@so...> - 2020-05-14 11:04:53
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=51c85defe0a4fcfa7b6e8ff64443b5498ae60ad5 commit 51c85defe0a4fcfa7b6e8ff64443b5498ae60ad5 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 12:54:23 2020 +0200 Update README_DEVELOPERS and references to --vex-guest-chase-thresh. Add a hint about using lldb in README_DEVELOPERS and fix any old references to --vex-guest-chase-thresh=0 to --vex-guest-chase=no (mirroring the change in commit 56e04256a "Rationalise --vex-guest* flags in the new IRSB construction framework". Reported-by: Paul FLOYD <pj...@wa...> Diff: --- README_DEVELOPERS | 6 +++++- exp-bbv/docs/bbv-manual.xml | 2 +- lackey/lk_main.c | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README_DEVELOPERS b/README_DEVELOPERS index 97f2329059..86f539bb6f 100644 --- a/README_DEVELOPERS +++ b/README_DEVELOPERS @@ -110,6 +110,10 @@ without too much problem by following these steps: (gdb) handle SIGILL SIGSEGV nostop noprint + If you are using lldb, then the equivalent command is + + (lldb) pro hand -p true -s false -n false SIGILL SIGSEGV + (4) Set any breakpoints you want and proceed as normal for gdb. The macro VG_(FUNC) is expanded to vgPlain_FUNC, so If you want to set a breakpoint VG_(do_exec), you could do like this in GDB: @@ -327,7 +331,7 @@ Printing out problematic blocks If you want to print out a disassembly of a particular block that causes a crash, do the following. -Try running with "--vex-guest-chase-thresh=0 --trace-flags=10000000 +Try running with "--vex-guest-chase=no --trace-flags=10000000 --trace-notbelow=999999". This should print one line for each block translated, and that includes the address. diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml index 7141e07c2f..7195e9151c 100644 --- a/exp-bbv/docs/bbv-manual.xml +++ b/exp-bbv/docs/bbv-manual.xml @@ -263,7 +263,7 @@ T:18:45 :12:135353 :56:78 314:4324263]]></programlisting> BBV vectors will be different than those generated by other tools. In practice this does not seem to affect the accuracy of the SimPoint results. We do internally force the - <option>--vex-guest-chase-thresh=0</option> + <option>--vex-guest-chase=no</option> option to Valgrind which forces a more basic-block-like behavior. </para> diff --git a/lackey/lk_main.c b/lackey/lk_main.c index d4393b4890..e19b39f16f 100644 --- a/lackey/lk_main.c +++ b/lackey/lk_main.c @@ -739,7 +739,7 @@ IRSB* lk_instrument ( VgCallbackClosure* closure, * instrument, by the VEX statements that are the * translation of that known destination. This feature is * called 'SB chasing' and can be influenced by command - * line option --vex-guest-chase-thresh. + * line option --vex-guest-chase=[yes|no]. * * To get an accurate count of the calls to a specific * function, taking SB chasing into account, we need to |
|
From: Mark W. <ma...@so...> - 2020-05-14 11:04:45
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=c0916494f651a33822be64bf264459bb2c452097 commit c0916494f651a33822be64bf264459bb2c452097 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 12:43:39 2020 +0200 docbook xml doesn't allow xref inside option, use link instead Diff: --- cachegrind/docs/cg-manual.xml | 2 +- callgrind/docs/cl-manual.xml | 89 +++++++++++++++++++++++++------------------ dhat/docs/dh-manual.xml | 2 +- exp-bbv/docs/bbv-manual.xml | 4 +- massif/docs/ms-manual.xml | 4 +- memcheck/docs/mc-manual.xml | 5 ++- 6 files changed, 60 insertions(+), 46 deletions(-) diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index 7a44e489f2..adff8aa730 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -860,7 +860,7 @@ small differences like these; it works in the same way as <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core - option <option><xref linkend="opt.log-file"/></option>. + option <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 10da8d973a..d8b65f8021 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -176,8 +176,9 @@ has to rely on heuristics to detect calls and returns.</para> <para>If you are additionally interested in measuring the cache behavior of your program, use Callgrind with the option - <option><xref linkend="clopt.cache-sim"/>=yes</option>. For - branch prediction simulation, use <option><xref linkend="clopt.branch-sim"/>=yes</option>. + <option><link linkend="clopt.cache-sim">--cache-sim=yes</link></option>. + For branch prediction simulation, use + <option><link linkend="clopt.branch-sim">--branch-sim=yes</link></option>. Expect a further slow down approximately by a factor of 2.</para> <para>If the program section you want to profile is somewhere in the @@ -185,7 +186,7 @@ has to rely on heuristics to detect calls and returns.</para> <emphasis>fast forward</emphasis> to this section without any profiling, and then enable profiling. This is achieved by using the command line option - <option><xref linkend="opt.instr-atstart"/>=no</option> + <option><link linkend="opt.instr-atstart">--instr-atstart=no</link></option> and running, in a shell: <computeroutput>callgrind_control -i on</computeroutput> just before the interesting code section is executed. To exactly specify @@ -193,13 +194,14 @@ has to rely on heuristics to detect calls and returns.</para> <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput>.</para> <para>If you want to be able to see assembly code level annotation, specify - <option><xref linkend="opt.dump-instr"/>=yes</option>. This will produce - profile data at instruction granularity. Note that the resulting profile - data + <option><link linkend="opt.dump-instr">--dump-instr=yes</link></option>. + This will produce profile data at instruction granularity. + Note that the resulting profile data can only be viewed with KCachegrind. For assembly annotation, it also is interesting to see more details of the control flow inside of functions, i.e. (conditional) jumps. This will be collected by further specifying - <option><xref linkend="opt.collect-jumps"/>=yes</option>.</para> + <option><link linkend="opt.collect-jumps">--collect-jumps=yes</link></option>. + </para> </sect2> @@ -228,7 +230,9 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa dump (".part" is skipped for the dump at program termination), and <emphasis>threadID</emphasis> is a thread identification ("-threadID" is only used if you request dumps of individual - threads with <option><xref linkend="opt.separate-threads"/>=yes</option>).</para> + threads with + <option><link linkend="opt.separate-threads">--separate-threads=yes</link></option>). + </para> <para>There are different ways to generate multiple profile dumps while a program is running under Callgrind's supervision. Nevertheless, @@ -265,20 +269,20 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa <listitem> <para><command>Periodic dumping after execution of a specified number of basic blocks</command>. For this, use the command line - option <option><xref linkend="opt.dump-every-bb"/>=count</option>. + option <option><link linkend="opt.dump-every-bb">--dump-every-bb=count</link></option>. </para> </listitem> <listitem> <para><command>Dumping at enter/leave of specified functions.</command> Use the - option <option><xref linkend="opt.dump-before"/>=function</option> - and <option><xref linkend="opt.dump-after"/>=function</option>. + option <option><link linkend="opt.dump-before">--dump-before=function</link></option> + and <option><link linkend="opt.dump-after">--dump-after=function</link></option>. To zero cost counters before entering a function, use - <option><xref linkend="opt.zero-before"/>=function</option>.</para> + <option><link linkend="opt.zero-before">--zero-before=function</link></option>.</para> <para>You can specify these options multiple times for different functions. Function specifications support wildcards: e.g. use - <option><xref linkend="opt.dump-before"/>='foo*'</option> to + <option><link linkend="opt.dump-before">--dump-before='foo*'</link></option> to generate dumps before entering any function starting with <emphasis>foo</emphasis>.</para> </listitem> @@ -297,7 +301,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa </itemizedlist> <para>If you are running a multi-threaded application and specify the - command line option <option><xref linkend="opt.separate-threads"/>=yes</option>, + command line option + <option><link linkend="opt.separate-threads">--separate-threads=yes</link></option>, every thread will be profiled on its own and will create its own profile dump. Thus, the last two methods will only generate one dump of the currently running thread. With the other methods, you will get @@ -359,8 +364,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa </para> <para>Callgrind can start with instrumentation mode switched off by - specifying - option <option><xref linkend="opt.instr-atstart"/>=no</option>. + specifying option + <option><link linkend="opt.instr-atstart">--instr-atstart=no</link></option>. Afterwards, instrumentation can be controlled in two ways: first, interactively with: <screen>callgrind_control -i on</screen> (and switching off again by specifying "off" instead of "on"). Second, @@ -370,12 +375,12 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa </para> <para>Similarly, the collection state at program start can be - switched off - by <option><xref linkend="opt.instr-atstart"/>=no</option>. During - execution, it can be controlled programmatically with the + switched off by + <option><link linkend="opt.instr-atstart">--instr-atstart=no</link></option>. + During execution, it can be controlled programmatically with the macro <computeroutput>CALLGRIND_TOGGLE_COLLECT;</computeroutput>. Further, you can limit event collection to a specific function by - using <option><xref linkend="opt.toggle-collect"/>=function</option>. + using <option><link linkend="opt.toggle-collect">--toggle-collect=function</link></option>. This will toggle the collection state on entering and leaving the specified function. When this option is in effect, the default collection state at program start is "off". Only events happening @@ -401,7 +406,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa "global bus events" is used.</para> <para>The short name of the event type used for global bus events is "Ge". - To count global bus events, use <option><xref linkend="clopt.collect-bus"/>=yes</option>. + To count global bus events, use + <option><link linkend="clopt.collect-bus">--collect-bus=yes</link></option>. </para> </sect2> @@ -475,32 +481,34 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa also skips any call information from and to an ignored function, and thus can break a cycle. Candidates for this typically are dispatcher functions in event driven code. The option to ignore calls to a function is - <option><xref linkend="opt.fn-skip"/>=function</option>. Aside from - possibly breaking cycles, this is used in Callgrind to skip + <option><link linkend="opt.fn-skip">--fn-skip=function</link></option>. + Aside from possibly breaking cycles, this is used in Callgrind to skip trampoline functions in the PLT sections for calls to functions in shared libraries. You can see the difference - if you profile with <option><xref linkend="opt.skip-plt"/>=no</option>. + if you profile with + <option><link linkend="opt.skip-plt">--skip-plt=no</link></option>. If a call is ignored, its cost events will be propagated to the enclosing function.</para> <para>If you have a recursive function, you can distinguish the first 10 recursion levels by specifying - <option><xref linkend="opt.separate-recs-num"/>=function</option>. + <option><link linkend="opt.separate-recs-num">--separate-recs10=function</link></option>. Or for all functions with - <option><xref linkend="opt.separate-recs"/>=10</option>, but this will + <option><link linkend="opt.separate-recs">--separate-recs=10</link></option>, + but this will give you much bigger profile data files. In the profile data, you will see the recursion levels of "func" as the different functions with names "func", "func'2", "func'3" and so on.</para> <para>If you have call chains "A > B > C" and "A > C > B" in your program, you usually get a "false" cycle "B <> C". Use - <option><xref linkend="opt.separate-callers-num"/>=B</option> - <option><xref linkend="opt.separate-callers-num"/>=C</option>, + <option><link linkend="opt.separate-callers-num">--separate-callers2=B</link></option> + <option><link linkend="opt.separate-callers-num">--separate-callers2=C</link></option>, and functions "B" and "C" will be treated as different functions depending on the direct caller. Using the apostrophe for appending this "context" to the function name, you get "A > B'A > C'B" and "A > C'A > B'C", and there will be no cycle. Use - <option><xref linkend="opt.separate-callers"/>=2</option> to get a 2-caller + <option><link linkend="opt.separate-callers">--separate-callers=2</link></option> to get a 2-caller dependency for all functions. Note that doing this will increase the size of profile data files.</para> @@ -539,9 +547,9 @@ In the following, options are grouped into classes. </para> <para> Some options allow the specification of a function/symbol name, such as -<option><xref linkend="opt.dump-before"/>=function</option>, or -<option><xref linkend="opt.fn-skip"/>=function</option>. All these options -can be specified multiple times for different functions. +<option><link linkend="opt.dump-before">--dump-before=function</link></option>, or +<option><link linkend="opt.fn-skip">--fn-skip=function</link></option>. +All these options can be specified multiple times for different functions. In addition, the function specifications actually are patterns by supporting the use of wildcards '*' (zero or more arbitrary characters) and '?' (exactly one arbitrary character), similar to file name globbing in the @@ -572,7 +580,8 @@ These options influence the name and format of the profile data files. <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core - option <option><xref linkend="opt.log-file"/></option>. + option + <option><link linkend="opt.log-file">--log-file</link></option>. When multiple dumps are made, the file name is modified further; see below.</para> </listitem> @@ -762,7 +771,7 @@ Also see <xref linkend="cl-manual.limits"/>.</para> dumps is not practical here.</para> <para>Collection state can be toggled at entry and exit of a given function with the - option <option><xref linkend="opt.toggle-collect"/></option>. If you + option <option><link linkend="opt.toggle-collect">--toggle-collect</link></option>. If you use this option, collection state should be disabled at the beginning. Note that the specification of <option>--toggle-collect</option> @@ -1198,8 +1207,9 @@ their arguments.</para> <listitem> <para>Toggle the collection state. This allows to ignore events with regard to profile counters. See also options - <option><xref linkend="opt.collect-atstart"/></option> and - <option><xref linkend="opt.toggle-collect"/></option>.</para> + <option><link linkend="opt.collect-atstart">--collect-atstart</link></option> + and + <option><link linkend="opt.toggle-collect">--toggle-collect</link></option>.</para> </listitem> </varlistentry> @@ -1212,7 +1222,9 @@ their arguments.</para> When cache simulation is done, this will flush the simulated cache and lead to an artificial cache warmup phase afterwards with cache misses which would not have happened in reality. See also - option <option><xref linkend="opt.instr-atstart"/></option>.</para> + option + <option><link linkend="opt.instr-atstart">--instr-atstart</link></option>. + </para> </listitem> </varlistentry> @@ -1228,7 +1240,8 @@ their arguments.</para> speed up the Callgrind run for uninteresting code parts. Use <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput> to enable instrumentation again. See also option - <option><xref linkend="opt.instr-atstart"/></option>.</para> + <option><link linkend="opt.instr-atstart">--instr-atstart</link></option>. + </para> </listitem> </varlistentry> diff --git a/dhat/docs/dh-manual.xml b/dhat/docs/dh-manual.xml index e1d2ac6141..eeb6080551 100644 --- a/dhat/docs/dh-manual.xml +++ b/dhat/docs/dh-manual.xml @@ -689,7 +689,7 @@ triggered.</para> <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core - option <option><xref linkend="opt.log-file"/></option>. + option <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml index f6ba05439b..7141e07c2f 100644 --- a/exp-bbv/docs/bbv-manual.xml +++ b/exp-bbv/docs/bbv-manual.xml @@ -128,7 +128,7 @@ command line.</para> <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option - <option><xref linkend="opt.log-file"/></option>. + <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> @@ -148,7 +148,7 @@ command line.</para> <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option - <option><xref linkend="opt.log-file"/></option>. + <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/massif/docs/ms-manual.xml b/massif/docs/ms-manual.xml index f8637de807..8d41286cff 100644 --- a/massif/docs/ms-manual.xml +++ b/massif/docs/ms-manual.xml @@ -391,7 +391,7 @@ a small amount of information is recorded for each one:</para> larger number, usually 8 or 16. This is required to ensure that elements within the block are suitably aligned. If N bytes are asked for, Massif rounds N up to the nearest multiple of the value specified by the - <option><xref linkend="opt.alignment"/></option> option. + <option><link linkend="opt.alignment">--alignment</link></option> option. </para></listitem> <listitem><para>The size of the stack(s). By default, stack profiling is @@ -866,7 +866,7 @@ various places online. <option>%p</option> and <option>%q</option> format specifiers can be used to embed the process ID and/or the contents of an environment variable in the name, as is the case for the core option - <option><xref linkend="opt.log-file"/></option>. + <option><link linkend="opt.log-file">--log-file</link></option>. </para> </listitem> </varlistentry> diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml index 5d6031376c..9d7d217221 100644 --- a/memcheck/docs/mc-manual.xml +++ b/memcheck/docs/mc-manual.xml @@ -104,8 +104,9 @@ which has already been freed, you'll be informed of this, and also where the block was freed. Likewise, if it should turn out to be just off the end of a heap block, a common result of off-by-one-errors in array subscripting, you'll be informed of this fact, and also where the -block was allocated. If you use the <option><xref -linkend="opt.read-var-info"/></option> option Memcheck will run more slowly +block was allocated. If you use the <option><link +linkend="opt.read-var-info">--read-var-info</link></option> option +Memcheck will run more slowly but may give a more detailed description of any illegal address.</para> <para>In this example, Memcheck can't identify the address. Actually |
|
From: Mark W. <ma...@so...> - 2020-05-14 11:04:38
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=4cc73dcc2825d921fe20b8184e0b79982f32a739 commit 4cc73dcc2825d921fe20b8184e0b79982f32a739 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 00:53:16 2020 +0200 cl-manual.xml: xref cannot be used inside computeroutput, use link. Diff: --- callgrind/docs/cl-manual.xml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 67e677ed02..10da8d973a 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -190,7 +190,7 @@ has to rely on heuristics to detect calls and returns.</para> <computeroutput>callgrind_control -i on</computeroutput> just before the interesting code section is executed. To exactly specify the code position where profiling should start, use the client request - <computeroutput><xref linkend="cr.start-instr"/></computeroutput>.</para> + <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput>.</para> <para>If you want to be able to see assembly code level annotation, specify <option><xref linkend="opt.dump-instr"/>=yes</option>. This will produce @@ -286,9 +286,10 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa <listitem> <para><command>Program controlled dumping.</command> Insert - <computeroutput><xref linkend="cr.dump-stats"/>;</computeroutput> - at the position in your code where you want a profile dump to happen. Use - <computeroutput><xref linkend="cr.zero-stats"/>;</computeroutput> to only + <computeroutput><link linkend="cr.dump-stats">CALLGRIND_DUMP_STATS</link>;</computeroutput> + at the position in your code where you want a profile dump to + happen. Use + <computeroutput><link linkend="cr.zero-stats">CALLGRIND_ZERO_STATS</link>;</computeroutput> to only zero profile counters. See <xref linkend="cl-manual.clientrequests"/> for more information on Callgrind specific client requests.</para> @@ -364,8 +365,8 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa interactively with: <screen>callgrind_control -i on</screen> (and switching off again by specifying "off" instead of "on"). Second, instrumentation state can be programmatically changed with the - macros <computeroutput><xref linkend="cr.start-instr"/>;</computeroutput> - and <computeroutput><xref linkend="cr.stop-instr"/>;</computeroutput>. + macros <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link>;</computeroutput> + and <computeroutput><link linkend="cr.stop-instr">CALLGRIND_STOP_INSTRUMENTATION</link>;</computeroutput>. </para> <para>Similarly, the collection state at program start can be @@ -511,8 +512,9 @@ callgrind.out.<emphasis>pid</emphasis>.<emphasis>part</emphasis>-<emphasis>threa <para>If your program forks, the child will inherit all the profiling data that has been gathered for the parent. To start with empty profile counter values in the child, the client request - <computeroutput><xref linkend="cr.zero-stats"/>;</computeroutput> - can be inserted into code to be executed by the child, directly after + <computeroutput><link linkend="cr.zero-stats">CALLGRIND_ZERO_STATS</link>;</computeroutput> + can be inserted into code to be executed by the child, directly + after <computeroutput>fork</computeroutput>.</para> <para>However, you will have to make sure that the output file format string @@ -1224,8 +1226,8 @@ their arguments.</para> instrumentation afterwards: it effectivly will run at the same speed as Nulgrind, i.e. at minimal slowdown. Use this to speed up the Callgrind run for uninteresting code parts. Use - <computeroutput><xref linkend="cr.start-instr"/></computeroutput> to - enable instrumentation again. See also option + <computeroutput><link linkend="cr.start-instr">CALLGRIND_START_INSTRUMENTATION</link></computeroutput> + to enable instrumentation again. See also option <option><xref linkend="opt.instr-atstart"/></option>.</para> </listitem> </varlistentry> |
|
From: Mark W. <ma...@so...> - 2020-05-14 11:04:31
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=77052fccbc6630d88950019735943444c3ebdb5f commit 77052fccbc6630d88950019735943444c3ebdb5f Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 00:48:34 2020 +0200 ms_print-manpage.xml: date is not a valid tag inside refmeta. Diff: --- massif/docs/ms_print-manpage.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml index cd1f4a061c..856728ec8a 100644 --- a/massif/docs/ms_print-manpage.xml +++ b/massif/docs/ms_print-manpage.xml @@ -10,7 +10,6 @@ <refentrytitle>ms_print</refentrytitle> <manvolnum>1</manvolnum> <refmiscinfo>Release &rel-version;</refmiscinfo> - <date>rel-date</date> </refmeta> <refnamediv> |
|
From: Mark W. <ma...@so...> - 2020-05-14 11:04:15
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=022f8daf02ca89acfcb2875ed78f7fa4ee2522e7 commit 022f8daf02ca89acfcb2875ed78f7fa4ee2522e7 Author: Mark Wielaard <ma...@kl...> Date: Thu May 14 00:38:27 2020 +0200 drd-manual.xml: C++ isn't a valid id syntax, use CXX instead. Diff: --- drd/docs/drd-manual.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/drd/docs/drd-manual.xml b/drd/docs/drd-manual.xml index 8e28e96e26..897a1bbe53 100644 --- a/drd/docs/drd-manual.xml +++ b/drd/docs/drd-manual.xml @@ -1285,7 +1285,7 @@ before Valgrind's header files are available. </sect2> -<sect2 id="drd-manual.C++11" xreflabel="C++11"> +<sect2 id="drd-manual.CXX11" xreflabel="C++11"> <title>Debugging C++11 Programs</title> <para>If you want to use the C++11 class std::thread you will need to do the |
|
From: Mark W. <ma...@so...> - 2020-05-14 11:03:58
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=66d7f279e7c6aa450d4ef32c4c59c5bef74572fa commit 66d7f279e7c6aa450d4ef32c4c59c5bef74572fa Author: Mark Wielaard <ma...@kl...> Date: Wed May 13 23:51:52 2020 +0200 nl-manual.xml: Use unique nl-manual.overview as id, not ms-manual.overview. Diff: --- none/docs/nl-manual.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/none/docs/nl-manual.xml b/none/docs/nl-manual.xml index 53758f214e..eae9a52cd9 100644 --- a/none/docs/nl-manual.xml +++ b/none/docs/nl-manual.xml @@ -11,7 +11,7 @@ <option>--tool=none</option> on the Valgrind command line.</para> -<sect1 id="ms-manual.overview" xreflabel="Overview"> +<sect1 id="nl-manual.overview" xreflabel="Overview"> <title>Overview</title> <para>Nulgrind is the simplest possible Valgrind tool. It performs no |