From: Nicholas Nethercote <njn@valgrind.org>
Date: Fri, 7 Aug 2009 07:56:20 +0000 (+0000)
Subject: Add a manpage for cg_annotate.  Now only valgrind-listener and cg_merge lack
X-Git-Tag: svn/VALGRIND_3_5_0~106
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6fcbcab5198bc561b9e28c297da96382c58b1538;p=thirdparty%2Fvalgrind.git

Add a manpage for cg_annotate.  Now only valgrind-listener and cg_merge lack
a manpage, and they're so simple I can't be bothered doing ones for them
(they don't even have sections in the manual).

Also fixed a few minor things relating to manpages.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10744
---

diff --git a/cachegrind/Makefile.am b/cachegrind/Makefile.am
index fa257f0485..94df249e60 100644
--- a/cachegrind/Makefile.am
+++ b/cachegrind/Makefile.am
@@ -1,6 +1,8 @@
 include $(top_srcdir)/Makefile.tool.am
 
-EXTRA_DIST = docs/cg-manual.xml
+EXTRA_DIST = \
+	docs/cg-manual.xml \
+	docs/cg_annotate-manpage.xml
 
 #----------------------------------------------------------------------------
 # Headers, etc
diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml
index 7eedb134c9..88db94e75a 100644
--- a/cachegrind/docs/cg-manual.xml
+++ b/cachegrind/docs/cg-manual.xml
@@ -793,7 +793,8 @@ fail these checks.</para>
 <sect1 id="cg-manual.annopts" xreflabel="cg_annotate Options">
 <title>cg_annotate Options</title>
 
-<variablelist>
+<!-- start of xi:include in the manpage -->
+<variablelist id="cg_annotate.opts.list">
 
   <varlistentry>
     <term>
@@ -896,6 +897,7 @@ fail these checks.</para>
   </varlistentry>
 
 </variablelist>
+<!-- end of xi:include in the manpage -->
   
 </sect1>
 
diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml
new file mode 100644
index 0000000000..a8178897c4
--- /dev/null
+++ b/cachegrind/docs/cg_annotate-manpage.xml
@@ -0,0 +1,73 @@
+<?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"
+[ <!ENTITY % vg-entities SYSTEM "../../docs/xml/vg-entities.xml"> %vg-entities; ]>
+
+
+<refentry id="cg_annotate">
+
+<refmeta>
+  <refentrytitle>cg_annotate</refentrytitle>
+  <manvolnum>1</manvolnum>
+  <refmiscinfo>Release &rel-version;</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+  <refname>cg_annotate</refname>
+  <refpurpose>post-processing tool for Cachegrind</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+  <command>cg_annotate</command>
+  <arg><replaceable>options</replaceable></arg>
+  <arg>filename</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+
+<refsect1 id="description">
+<title>Description</title>
+
+<para><command>cg_annotate</command> takes an output file produced by the
+Valgrind tool Cachegrind and prints the information in an easy-to-read form.
+</para>
+
+</refsect1>
+
+
+
+<refsect1 id="options">
+<title>Options</title>
+
+<xi:include href="cg-manual.xml" xpointer="cg_annotate.opts.list"
+            xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</refsect1>
+
+
+
+
+<refsect1 id="see_also">
+<title>See Also</title>
+
+<para>
+valgrind(1),
+<filename>&vg-docs-path;</filename> or
+<filename>&vg-docs-url;</filename>.
+</para>
+
+</refsect1>
+
+
+<refsect1 id="author">
+<title>Author</title>
+
+<para>Nicholas Nethercote.</para>
+
+</refsect1>
+
+
+</refentry>
+
+
diff --git a/callgrind/docs/callgrind_annotate-manpage.xml b/callgrind/docs/callgrind_annotate-manpage.xml
index 42323168d5..a1d8aa8dec 100644
--- a/callgrind/docs/callgrind_annotate-manpage.xml
+++ b/callgrind/docs/callgrind_annotate-manpage.xml
@@ -14,7 +14,7 @@
 
 <refnamediv id="a-name">
   <refname>callgrind_annotate</refname>
-  <refpurpose>post-processing tool for the Valgrind tool Callgrind</refpurpose>
+  <refpurpose>post-processing tool for the Callgrind</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv id="a-synopsis">
diff --git a/callgrind/docs/callgrind_control-manpage.xml b/callgrind/docs/callgrind_control-manpage.xml
index 2b5a2bd750..dd71af0afb 100644
--- a/callgrind/docs/callgrind_control-manpage.xml
+++ b/callgrind/docs/callgrind_control-manpage.xml
@@ -13,8 +13,7 @@
 
 <refnamediv id="c-name">
   <refname>callgrind_control</refname>
-  <refpurpose>observe and control programs being run by the Valgrind tool
-  Callgrind</refpurpose>
+  <refpurpose>observe and control programs being run by Callgrind</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv id="c-synopsis">
@@ -43,6 +42,8 @@ being run by Callgrind.</para>
 <refsect1 id="c-options">
 <title>Options</title>
 
+<xi:include href="cl-manual.xml" xpointer="callgrind_control.opts.list"
+            xmlns:xi="http://www.w3.org/2001/XInclude" />
 
 </refsect1>
 
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 9cf464e0f0..f0151fd5be 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -111,7 +111,7 @@ XSL_MAN_STYLES = \
     /usr/share/xml/docbook/stylesheet/nwalsh/current/manpages/docbook.xsl \
     /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl
 
-all-docs: FAQ.txt man-page html-docs print-docs
+all-docs: FAQ.txt man-pages html-docs print-docs
 
 valid:
 	$(XMLLINT) $(XMLLINT_FLAGS) $(myxmldir)/index.xml
@@ -123,7 +123,7 @@ FAQ.txt:
 	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ./FAQ.txt $(XSL_TEXT_STYLE) $(myxmldir)/FAQ.xml
 
 # the valgrind manpages
-man-page:
+man-pages:
 	for x in $(XSL_MAN_STYLES) ; do \
 	    if test -f $$x; then \
 		echo "Using manpage stylesheet: $$x"; \
@@ -198,14 +198,14 @@ install-data-hook:
 # docs and man page and copies them into the docs/ directory in the
 # tarball.
  ifeq ($(BUILD_ALL_DOCS),yes)
-dist-hook: FAQ.txt html-docs print-docs man-page
+dist-hook: FAQ.txt html-docs print-docs man-pages
 	cp -r html $(distdir)
 	cp FAQ.txt $(distdir)/..
 	cp valgrind.1 $(distdir)
 	cp print/index.pdf $(distdir)
 	cp print/index.ps $(distdir)
  else
-dist-hook: FAQ.txt html-docs man-page
+dist-hook: FAQ.txt html-docs man-pages
 	cp FAQ.txt $(distdir)/..
 	cp -r html $(distdir)
  endif
diff --git a/docs/xml/manpages-index.xml b/docs/xml/manpages-index.xml
index 889bb8fa62..b02fc9ca30 100644
--- a/docs/xml/manpages-index.xml
+++ b/docs/xml/manpages-index.xml
@@ -11,6 +11,10 @@
 <xi:include href="valgrind-manpage.xml" parse="xml"  
     xmlns:xi="http://www.w3.org/2001/XInclude" />
 
+<!-- cg_annotate -->
+<xi:include href="../../cachegrind/docs/cg_annotate-manpage.xml" parse="xml"  
+    xmlns:xi="http://www.w3.org/2001/XInclude" />
+
 <!-- callgrind_annotate -->
 <xi:include href="../../callgrind/docs/callgrind_annotate-manpage.xml" parse="xml"  
     xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/docs/xml/valgrind-manpage.xml b/docs/xml/valgrind-manpage.xml
index 1bd5681856..04918e291c 100644
--- a/docs/xml/valgrind-manpage.xml
+++ b/docs/xml/valgrind-manpage.xml
@@ -222,6 +222,7 @@ system: <filename>&vg-docs-path;</filename>, or online:
 <title>See Also</title>
 
 <para>
+cg_annotate(1),
 callgrind_annotate(1),
 callgrind_control(1),
 ms_print(1),
diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml
index efec8fded8..835d49bcfb 100644
--- a/massif/docs/ms_print-manpage.xml
+++ b/massif/docs/ms_print-manpage.xml
@@ -14,7 +14,7 @@
 
 <refnamediv>
   <refname>ms_print</refname>
-  <refpurpose>post-processing tool for the Valgrind tool Massif</refpurpose>
+  <refpurpose>post-processing tool for Massif</refpurpose>
 </refnamediv>
 
 <refsynopsisdiv>