|
[Valgrind-developers] [valgrind] Turn manpages-index.xml into a
"real" book, so it can be validated.
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> |