diff options
| author | Frank Ch. Eigler <fche@elastic.org> | 2009-09-29 14:09:32 -0400 |
|---|---|---|
| committer | Frank Ch. Eigler <fche@elastic.org> | 2009-09-29 14:09:32 -0400 |
| commit | 7a18a12684f498929b5938ceb18f66b18d2e1fe3 (patch) | |
| tree | e2ef22aac08b85a54094445f7ec0509dbd45e304 /doc/SystemTap_Tapset_Reference | |
| parent | f3d75239e30b5ba55936d9340b0e95caa698034b (diff) | |
| download | systemtap-steved-7a18a12684f498929b5938ceb18f66b18d2e1fe3.tar.gz systemtap-steved-7a18a12684f498929b5938ceb18f66b18d2e1fe3.tar.xz systemtap-steved-7a18a12684f498929b5938ceb18f66b18d2e1fe3.zip | |
tapset docs cleanup
Several problems: some invalid <command> etc. directives
in the tapset embedded docs; some analysis about the
non-generation of the pdf; some cleanup of the generated
man pages.
* configure.ac (BUILD_PDFREFDOCS): Correct condition typo, but still
leave disabled.
* doc/SystemTap_Tapset_Reference/Makefile.am (XMLTOMANPARMS): Add,
to disable noise "AUTHORS" / "COPYRIGHT" sections.
* tapset/*.stp: Removed several docbook-y markup that is not valid
in kerneldoc.
Diffstat (limited to 'doc/SystemTap_Tapset_Reference')
| -rw-r--r-- | doc/SystemTap_Tapset_Reference/Makefile.am | 8 | ||||
| -rw-r--r-- | doc/SystemTap_Tapset_Reference/Makefile.in | 7 |
2 files changed, 9 insertions, 6 deletions
diff --git a/doc/SystemTap_Tapset_Reference/Makefile.am b/doc/SystemTap_Tapset_Reference/Makefile.am index 4adba34e..bd1bb18f 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.am +++ b/doc/SystemTap_Tapset_Reference/Makefile.am @@ -22,6 +22,8 @@ if BUILD_PDFREFDOCS PDFDOCS = tapsets.pdf endif +XMLTOMANPARAMS=--stringparam man.authors.section.enabled=0 --stringparam man.copyright.section.enabled=0 + if BUILD_REFDOCS all: $(PDFDOCS) stamp-htmldocs stamp-mandocs tapsets.xml: docproc $(shell find $(SRCTREE)/tapset -name '*.stp') @@ -34,15 +36,15 @@ tapsets.xml: docproc $(shell find $(SRCTREE)/tapset -name '*.stp') fi stamp-htmldocs: tapsets.xml - xmlto html -o tapsets tapsets.xml + xmlto $(XMLTOHTMLPARAMS) html -o tapsets tapsets.xml touch stamp-htmldocs # bump up the allocated space so "xmlto pdf" works tapsets.pdf: tapsets.xml - env pool_size=2000000 hash_extra=2000000 xmlto pdf tapsets.xml + env pool_size=2000000 hash_extra=2000000 xmlto $(XMLTOPDFPARAMS) pdf tapsets.xml stamp-mandocs: tapsets.xml - xmlto man -o man3 tapsets.xml + xmlto $(XMLTOMANPARAMS) man -o man3 tapsets.xml touch stamp-mandocs #FIXME need to figure out where to install things appropriately diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in index 66822d7b..b2529891 100644 --- a/doc/SystemTap_Tapset_Reference/Makefile.in +++ b/doc/SystemTap_Tapset_Reference/Makefile.in @@ -186,6 +186,7 @@ HTML_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap/tapsets SRCTREE = $(abs_top_srcdir)/ DOCPROC = $(abs_builddir)/docproc @BUILD_PDFREFDOCS_TRUE@PDFDOCS = tapsets.pdf +XMLTOMANPARAMS = --stringparam man.authors.section.enabled=0 --stringparam man.copyright.section.enabled=0 CLEANFILES = tapsets.xml stamp-* $(PDFDOCS) all: all-am @@ -461,15 +462,15 @@ uninstall-am: @BUILD_REFDOCS_TRUE@ fi @BUILD_REFDOCS_TRUE@stamp-htmldocs: tapsets.xml -@BUILD_REFDOCS_TRUE@ xmlto html -o tapsets tapsets.xml +@BUILD_REFDOCS_TRUE@ xmlto $(XMLTOHTMLPARAMS) html -o tapsets tapsets.xml @BUILD_REFDOCS_TRUE@ touch stamp-htmldocs # bump up the allocated space so "xmlto pdf" works @BUILD_REFDOCS_TRUE@tapsets.pdf: tapsets.xml -@BUILD_REFDOCS_TRUE@ env pool_size=2000000 hash_extra=2000000 xmlto pdf tapsets.xml +@BUILD_REFDOCS_TRUE@ env pool_size=2000000 hash_extra=2000000 xmlto $(XMLTOPDFPARAMS) pdf tapsets.xml @BUILD_REFDOCS_TRUE@stamp-mandocs: tapsets.xml -@BUILD_REFDOCS_TRUE@ xmlto man -o man3 tapsets.xml +@BUILD_REFDOCS_TRUE@ xmlto $(XMLTOMANPARAMS) man -o man3 tapsets.xml @BUILD_REFDOCS_TRUE@ touch stamp-mandocs #FIXME need to figure out where to install things appropriately |