summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Wielaard <mark@klomp.org>2020-06-09 11:23:46 +0200
committerMark Wielaard <mark@klomp.org>2020-06-09 11:23:46 +0200
commita489f40f78cee5559c230699befe11ff52388c28 (patch)
tree253ecf9c3fd1cefaba325b64c91d05e2873c6a8c
parentAdd execveat for arm[64], [nano]mips[32|64], ppc[32|64], s390x and x86. (diff)
downloadvalgrind-xml-ids.tar.gz
valgrind-xml-ids.tar.bz2
valgrind-xml-ids.tar.xz
docs: Make sure all elements that need it have an id tag.xml-ids
When generating HTML it is useful if every element that can be referenced has a stable id. If it doesn't a random one is generated which makes it harder to link to parts of the manual on the website. It also generates spurious diffs. Explicitly add an id tag for the sect2 and sect3 elements in dh-manual, a unique id for each legalnotice element and for each FAQ question and answer.
-rw-r--r--dhat/docs/dh-manual.xml20
-rw-r--r--docs/xml/FAQ.xml8
-rw-r--r--docs/xml/dist-docs.xml2
-rw-r--r--docs/xml/index.xml2
-rw-r--r--docs/xml/manual.xml2
-rw-r--r--docs/xml/quick-start-guide.xml2
-rw-r--r--docs/xml/tech-docs.xml2
7 files changed, 19 insertions, 19 deletions
diff --git a/dhat/docs/dh-manual.xml b/dhat/docs/dh-manual.xml
index f52cca2..6b9f1cb 100644
--- a/dhat/docs/dh-manual.xml
+++ b/dhat/docs/dh-manual.xml
@@ -153,7 +153,7 @@ smaller <option>--num-callers</option> value to reduce the stack depths,
153because this can significantly reduce the size of DHAT's output files.</para> 153because this can significantly reduce the size of DHAT's output files.</para>
154 154
155 155
156<sect2><title>The Output Header</title> 156<sect2 id="dh-output-header"><title>The Output Header</title>
157 157
158<para>The first part of the output shows the program command and process ID. 158<para>The first part of the output shows the program command and process ID.
159For example:</para> 159For example:</para>
@@ -179,13 +179,13 @@ Times {
179</sect2> 179</sect2>
180 180
181 181
182<sect2><title>The AP Tree</title> 182<sect2 id="dh-ap-tree"><title>The AP Tree</title>
183 183
184<para>The third part of the output is the largest and most interesting part, 184<para>The third part of the output is the largest and most interesting part,
185showing the allocation point (AP) tree.</para> 185showing the allocation point (AP) tree.</para>
186 186
187 187
188<sect3><title>Structure</title> 188<sect3 id="dh-structure"><title>Structure</title>
189 189
190<para>The following image shows a screenshot of part of an AP 190<para>The following image shows a screenshot of part of an AP
191tree. The font is very small because this screenshot is intended to 191tree. The font is very small because this screenshot is intended to
@@ -223,7 +223,7 @@ email, bug report, etc.</para>
223</sect3> 223</sect3>
224 224
225 225
226<sect3><title>The Root Node</title> 226<sect3 id="dh-root-node"><title>The Root Node</title>
227 227
228<para>The root node looks like this:</para> 228<para>The root node looks like this:</para>
229 229
@@ -248,7 +248,7 @@ next example will explain these in more detail.</para>
248</sect3> 248</sect3>
249 249
250 250
251<sect3><title>Interior Nodes</title> 251<sect3 id="dh-interior-nodes"><title>Interior Nodes</title>
252 252
253<para>AP nodes further down the tree show information about a subset of 253<para>AP nodes further down the tree show information about a subset of
254allocations. For example:</para> 254allocations. For example:</para>
@@ -331,7 +331,7 @@ vectors and hash tables, and isn't always fixable. </para>
331</sect3> 331</sect3>
332 332
333 333
334<sect3><title>Leaf Nodes</title> 334<sect3 id="dh-leaf-nodes"><title>Leaf Nodes</title>
335 335
336<para>This is a leaf node:</para> 336<para>This is a leaf node:</para>
337 337
@@ -381,7 +381,7 @@ This also means that each node makes complete sense on its own.</para>
381</sect3> 381</sect3>
382 382
383 383
384<sect3><title>Access Counts</title> 384<sect3 id="dh-access-counts"><title>Access Counts</title>
385 385
386<para>If all blocks covered by an AP node have the same size, an additional 386<para>If all blocks covered by an AP node have the same size, an additional
387<computeroutput>Accesses</computeroutput> field will be present. It indicates 387<computeroutput>Accesses</computeroutput> field will be present. It indicates
@@ -423,7 +423,7 @@ layout inefficiencies.</para>
423</sect3> 423</sect3>
424 424
425 425
426<sect3><title>Aggregate Nodes</title> 426<sect3 id="aggregate-nodes"><title>Aggregate Nodes</title>
427 427
428<para>The AP tree is very large and many nodes represent tiny numbers of blocks 428<para>The AP tree is very large and many nodes represent tiny numbers of blocks
429and bytes. Therefore, DHAT's viewer aggregates insignificant nodes like 429and bytes. Therefore, DHAT's viewer aggregates insignificant nodes like
@@ -447,7 +447,7 @@ case).</para>
447</sect2> 447</sect2>
448 448
449 449
450<sect2><title>The Output Footer</title> 450<sect2 id="dh-output-footer"><title>The Output Footer</title>
451 451
452<para>Below the AP tree is a line like this:</para> 452<para>Below the AP tree is a line like this:</para>
453 453
@@ -466,7 +466,7 @@ terms, abbreviations and symbols used in the output.</para>
466</sect2> 466</sect2>
467 467
468 468
469<sect2><title>Sort Metrics</title> 469<sect2 id="dh-sort-metrics"><title>Sort Metrics</title>
470 470
471<para>The order in which sub-trees are sorted can be changed via the "Sort 471<para>The order in which sub-trees are sorted can be changed via the "Sort
472metric" drop-down menu at the top of DHAT's viewer. Different sort metrics can 472metric" drop-down menu at the top of DHAT's viewer. Different sort metrics can
diff --git a/docs/xml/FAQ.xml b/docs/xml/FAQ.xml
index 845f5bb..414ac13 100644
--- a/docs/xml/FAQ.xml
+++ b/docs/xml/FAQ.xml
@@ -13,7 +13,7 @@
13 <year>&vg-lifespan;</year> 13 <year>&vg-lifespan;</year>
14 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder> 14 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder>
15 </copyright> 15 </copyright>
16 <legalnotice> 16 <legalnotice id="faq-legal">
17 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para> 17 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para>
18 </legalnotice> 18 </legalnotice>
19</bookinfo> 19</bookinfo>
@@ -96,14 +96,14 @@
96</qandaentry> 96</qandaentry>
97 97
98<qandaentry id="faq.glibc_devel"> 98<qandaentry id="faq.glibc_devel">
99 <question> 99 <question id="q-glibc_devel">
100 <para>When building Valgrind, 'make' fails with this:</para> 100 <para>When building Valgrind, 'make' fails with this:</para>
101<screen> 101<screen>
102/usr/bin/ld: cannot find -lc 102/usr/bin/ld: cannot find -lc
103collect2: ld returned 1 exit status 103collect2: ld returned 1 exit status
104</screen> 104</screen>
105 </question> 105 </question>
106 <answer> 106 <answer id="a-glibc_devel">
107 <para>You need to install the glibc-static-devel package.</para> 107 <para>You need to install the glibc-static-devel package.</para>
108 </answer> 108 </answer>
109</qandaentry> 109</qandaentry>
@@ -629,7 +629,7 @@ is built standalone as FAQ.txt. That's why we link to, for example, the
629online copy of the manual. --> 629online copy of the manual. -->
630 630
631<qandaentry id="e-help"> 631<qandaentry id="e-help">
632 <question><para>Where can I get more help?</para></question> 632 <question id="q-help"><para>Where can I get more help?</para></question>
633 <answer id="a-help"> 633 <answer id="a-help">
634 <para>Read the appropriate section(s) of the 634 <para>Read the appropriate section(s) of the
635 <ulink url="&vg-docs-url;">Valgrind Documentation</ulink>.</para> 635 <ulink url="&vg-docs-url;">Valgrind Documentation</ulink>.</para>
diff --git a/docs/xml/dist-docs.xml b/docs/xml/dist-docs.xml
index 9bf4d10..b1b5598 100644
--- a/docs/xml/dist-docs.xml
+++ b/docs/xml/dist-docs.xml
@@ -13,7 +13,7 @@
13 <year>&vg-lifespan;</year> 13 <year>&vg-lifespan;</year>
14 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder> 14 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder>
15 </copyright> 15 </copyright>
16 <legalnotice> 16 <legalnotice id="dist-legal">
17 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para> 17 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para>
18 </legalnotice> 18 </legalnotice>
19</bookinfo> 19</bookinfo>
diff --git a/docs/xml/index.xml b/docs/xml/index.xml
index 3bdb38a..4166239 100644
--- a/docs/xml/index.xml
+++ b/docs/xml/index.xml
@@ -16,7 +16,7 @@
16 </holder> 16 </holder>
17 </copyright> 17 </copyright>
18 18
19 <legalnotice> 19 <legalnotice id="legal">
20 <para>Permission is granted to copy, distribute and/or modify 20 <para>Permission is granted to copy, distribute and/or modify
21 this document under the terms of the GNU Free Documentation 21 this document under the terms of the GNU Free Documentation
22 License, Version 1.2 or any later version published by the 22 License, Version 1.2 or any later version published by the
diff --git a/docs/xml/manual.xml b/docs/xml/manual.xml
index e71a9cf..518be29 100644
--- a/docs/xml/manual.xml
+++ b/docs/xml/manual.xml
@@ -13,7 +13,7 @@
13 <year>&vg-lifespan;</year> 13 <year>&vg-lifespan;</year>
14 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder> 14 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder>
15 </copyright> 15 </copyright>
16 <legalnotice> 16 <legalnotice id="manual-legal">
17 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para> 17 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para>
18 </legalnotice> 18 </legalnotice>
19</bookinfo> 19</bookinfo>
diff --git a/docs/xml/quick-start-guide.xml b/docs/xml/quick-start-guide.xml
index a61f5f0..0f5e0a5 100644
--- a/docs/xml/quick-start-guide.xml
+++ b/docs/xml/quick-start-guide.xml
@@ -12,7 +12,7 @@
12 <year>&vg-lifespan;</year> 12 <year>&vg-lifespan;</year>
13 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder> 13 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder>
14 </copyright> 14 </copyright>
15 <legalnotice> 15 <legalnotice id="quickstart-legal">
16 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para> 16 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para>
17 </legalnotice> 17 </legalnotice>
18</bookinfo> 18</bookinfo>
diff --git a/docs/xml/tech-docs.xml b/docs/xml/tech-docs.xml
index 28070f9..2e077fc 100644
--- a/docs/xml/tech-docs.xml
+++ b/docs/xml/tech-docs.xml
@@ -12,7 +12,7 @@
12 <year>&vg-lifespan;</year> 12 <year>&vg-lifespan;</year>
13 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder> 13 <holder><ulink url="&vg-devs-url;">Valgrind Developers</ulink></holder>
14 </copyright> 14 </copyright>
15 <legalnotice> 15 <legalnotice id="tech-legal">
16 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para> 16 <para>Email: <ulink url="mailto:&vg-vemail;">&vg-vemail;</ulink></para>
17 </legalnotice> 17 </legalnotice>
18</bookinfo> 18</bookinfo>