summaryrefslogtreecommitdiffstats
path: root/doc/SystemTap_Tapset_Reference
diff options
context:
space:
mode:
authorMark Wielaard <mjw@redhat.com>2009-01-23 14:28:47 +0100
committerMark Wielaard <mjw@redhat.com>2009-01-23 14:28:47 +0100
commitc3bad3042df505a3470f1e20b09822a9df1d4761 (patch)
tree6842e8eaa705e406379d34cf07a85431b6d71344 /doc/SystemTap_Tapset_Reference
parent750b1f2f5c84acaf0776de5239dc81e2e95c1dec (diff)
parentf120873cb40cfc16cc94f06fd722abc927b96227 (diff)
downloadsystemtap-steved-c3bad3042df505a3470f1e20b09822a9df1d4761.tar.gz
systemtap-steved-c3bad3042df505a3470f1e20b09822a9df1d4761.tar.xz
systemtap-steved-c3bad3042df505a3470f1e20b09822a9df1d4761.zip
Merge branch 'master' into pr6866.
Diffstat (limited to 'doc/SystemTap_Tapset_Reference')
-rw-r--r--doc/SystemTap_Tapset_Reference/Makefile.am44
-rw-r--r--doc/SystemTap_Tapset_Reference/Makefile.in134
-rw-r--r--doc/SystemTap_Tapset_Reference/tapsets.tmpl15
3 files changed, 99 insertions, 94 deletions
diff --git a/doc/SystemTap_Tapset_Reference/Makefile.am b/doc/SystemTap_Tapset_Reference/Makefile.am
index c196e977..9e7d2069 100644
--- a/doc/SystemTap_Tapset_Reference/Makefile.am
+++ b/doc/SystemTap_Tapset_Reference/Makefile.am
@@ -1,6 +1,11 @@
# Makefile.am --- automake input file for systemtap tapset reference manual
## process this file with automake to produce Makefile.in
+DOC_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap
+MAN_INSTALL_DIR = $(DESTDIR)$(mandir)/man5
+HTML_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap/tapsets
+
+
###
# The build process is as follows (targets):
# (xmldocs) [by docproc]
@@ -9,29 +14,38 @@
# +--> DIR=file (htmldocs) [by xmlto]
# +--> man/ (mandocs) [by xmlto]
-bin_PROGRAMS = docproc
-docproc_SOURCES = docproc.c
-
-all: pdfdocs htmldocs mandocs
-
-
+noinst_PROGRAMS = docproc
SRCTREE=$(abs_top_srcdir)/
DOCPROC=$(abs_builddir)/docproc
-xmldocs: docproc
- SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml
-
-htmldocs: xmldocs
+if BUILD_REFDOCS
+all: tapsets.pdf stamp-htmldocs stamp-mandocs
+tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp')
+ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new
+ if cmp tapsets.xml.new tapsets.xml >/dev/null ; then \
+ echo tapsets.xml unchanged; \
+ else \
+ mv tapsets.xml.new tapsets.xml; \
+ fi
+
+stamp-htmldocs: tapsets.xml
xmlto html -o tapsets tapsets.xml
+ touch stamp-htmldocs
-pdfdocs: xmldocs
+tapsets.pdf: tapsets.xml
xmlto pdf tapsets.xml
-mandocs: xmldocs
+stamp-mandocs: tapsets.xml
xmlto man -o man5 tapsets.xml
+ touch stamp-mandocs
#FIXME need to figure out where to install things appropriately
#installmandocs: mandocs
-# $(MKDIR_P) /usr/local/man/man5/
-# install Documentation/DocBook/man/*.5.gz /usr/local/man/man5/
-
+install-data-hook:
+ $(MKDIR_P) $(DOC_INSTALL_DIR)
+ $(INSTALL_DATA) tapsets.pdf $(DOC_INSTALL_DIR)
+ $(MKDIR_P) $(MAN_INSTALL_DIR)
+ $(INSTALL_DATA) man5/* $(MAN_INSTALL_DIR)
+ $(MKDIR_P) $(HTML_INSTALL_DIR)
+ $(INSTALL_DATA) tapsets/* $(HTML_INSTALL_DIR)
+endif
diff --git a/doc/SystemTap_Tapset_Reference/Makefile.in b/doc/SystemTap_Tapset_Reference/Makefile.in
index b61be1b7..f840d8c5 100644
--- a/doc/SystemTap_Tapset_Reference/Makefile.in
+++ b/doc/SystemTap_Tapset_Reference/Makefile.in
@@ -1,8 +1,8 @@
-# Makefile.in generated by automake 1.10.1 from Makefile.am.
+# Makefile.in generated by automake 1.10 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
-# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+# 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
@@ -16,14 +16,6 @@
# Makefile.am --- automake input file for systemtap tapset reference manual
-###
-# The build process is as follows (targets):
-# (xmldocs) [by docproc]
-# file.tmpl --> file.xml +--> file.ps (psdocs) [by xmlto]
-# +--> file.pdf (pdfdocs) [by xmlto]
-# +--> DIR=file (htmldocs) [by xmlto]
-# +--> man/ (mandocs) [by xmlto]
-
VPATH = @srcdir@
pkgdatadir = $(datadir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@@ -40,7 +32,7 @@ POST_INSTALL = :
NORMAL_UNINSTALL = :
PRE_UNINSTALL = :
POST_UNINSTALL = :
-bin_PROGRAMS = docproc$(EXEEXT)
+noinst_PROGRAMS = docproc$(EXEEXT)
subdir = doc/SystemTap_Tapset_Reference
DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
@@ -50,21 +42,19 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
mkinstalldirs = $(install_sh) -d
CONFIG_HEADER = $(top_builddir)/config.h
CONFIG_CLEAN_FILES =
-am__installdirs = "$(DESTDIR)$(bindir)"
-binPROGRAMS_INSTALL = $(INSTALL_PROGRAM)
-PROGRAMS = $(bin_PROGRAMS)
-am_docproc_OBJECTS = docproc.$(OBJEXT)
-docproc_OBJECTS = $(am_docproc_OBJECTS)
+PROGRAMS = $(noinst_PROGRAMS)
+docproc_SOURCES = docproc.c
+docproc_OBJECTS = docproc.$(OBJEXT)
docproc_LDADD = $(LDADD)
-DEFAULT_INCLUDES = -I.@am__isrc@ -I$(top_builddir)
+DEFAULT_INCLUDES = -I. -I$(top_builddir)@am__isrc@
depcomp = $(SHELL) $(top_srcdir)/depcomp
am__depfiles_maybe = depfiles
COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) $(AM_CPPFLAGS) \
$(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
CCLD = $(CC)
LINK = $(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@
-SOURCES = $(docproc_SOURCES)
-DIST_SOURCES = $(docproc_SOURCES)
+SOURCES = docproc.c
+DIST_SOURCES = docproc.c
ETAGS = etags
CTAGS = ctags
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@@ -115,6 +105,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
PIELDFLAGS = @PIELDFLAGS@
+PKG_CONFIG = @PKG_CONFIG@
PROCFLAGS = @PROCFLAGS@
RANLIB = @RANLIB@
SET_MAKE = @SET_MAKE@
@@ -146,6 +137,7 @@ have_dvips = @have_dvips@
have_latex = @have_latex@
have_latex2html = @have_latex2html@
have_ps2pdf = @have_ps2pdf@
+have_xmlto = @have_xmlto@
host_alias = @host_alias@
htmldir = @htmldir@
includedir = @includedir@
@@ -157,6 +149,10 @@ localedir = @localedir@
localstatedir = @localstatedir@
mandir = @mandir@
mkdir_p = @mkdir_p@
+nspr_CFLAGS = @nspr_CFLAGS@
+nspr_LIBS = @nspr_LIBS@
+nss_CFLAGS = @nss_CFLAGS@
+nss_LIBS = @nss_LIBS@
oldincludedir = @oldincludedir@
pdfdir = @pdfdir@
prefix = @prefix@
@@ -173,7 +169,9 @@ sysconfdir = @sysconfdir@
target_alias = @target_alias@
top_builddir = @top_builddir@
top_srcdir = @top_srcdir@
-docproc_SOURCES = docproc.c
+DOC_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap
+MAN_INSTALL_DIR = $(DESTDIR)$(mandir)/man5
+HTML_INSTALL_DIR = $(DESTDIR)$(datadir)/doc/systemtap/tapsets
SRCTREE = $(abs_top_srcdir)/
DOCPROC = $(abs_builddir)/docproc
all: all-am
@@ -209,29 +207,9 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps)
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
-install-binPROGRAMS: $(bin_PROGRAMS)
- @$(NORMAL_INSTALL)
- test -z "$(bindir)" || $(MKDIR_P) "$(DESTDIR)$(bindir)"
- @list='$(bin_PROGRAMS)'; for p in $$list; do \
- p1=`echo $$p|sed 's/$(EXEEXT)$$//'`; \
- if test -f $$p \
- ; then \
- f=`echo "$$p1" | sed 's,^.*/,,;$(transform);s/$$/$(EXEEXT)/'`; \
- echo " $(INSTALL_PROGRAM_ENV) $(binPROGRAMS_INSTALL) '$$p' '$(DESTDIR)$(bindir)/$$f'"; \
- $(INSTALL_PROGRAM_ENV) $(binPROGRAMS_INSTALL) "$$p" "$(DESTDIR)$(bindir)/$$f" || exit 1; \
- else :; fi; \
- done
-uninstall-binPROGRAMS:
- @$(NORMAL_UNINSTALL)
- @list='$(bin_PROGRAMS)'; for p in $$list; do \
- f=`echo "$$p" | sed 's,^.*/,,;s/$(EXEEXT)$$//;$(transform);s/$$/$(EXEEXT)/'`; \
- echo " rm -f '$(DESTDIR)$(bindir)/$$f'"; \
- rm -f "$(DESTDIR)$(bindir)/$$f"; \
- done
-
-clean-binPROGRAMS:
- -test -z "$(bin_PROGRAMS)" || rm -f $(bin_PROGRAMS)
+clean-noinstPROGRAMS:
+ -test -z "$(noinst_PROGRAMS)" || rm -f $(noinst_PROGRAMS)
docproc$(EXEEXT): $(docproc_OBJECTS) $(docproc_DEPENDENCIES)
@rm -f docproc$(EXEEXT)
$(LINK) $(docproc_OBJECTS) $(docproc_LDADD) $(LIBS)
@@ -263,8 +241,8 @@ ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES)
unique=`for i in $$list; do \
if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \
done | \
- $(AWK) '{ files[$$0] = 1; nonemtpy = 1; } \
- END { if (nonempty) { for (i in files) print i; }; }'`; \
+ $(AWK) ' { files[$$0] = 1; } \
+ END { for (i in files) print i; }'`; \
mkid -fID $$unique
tags: TAGS
@@ -276,8 +254,8 @@ TAGS: $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \
unique=`for i in $$list; do \
if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \
done | \
- $(AWK) '{ files[$$0] = 1; nonempty = 1; } \
- END { if (nonempty) { for (i in files) print i; }; }'`; \
+ $(AWK) ' { files[$$0] = 1; } \
+ END { for (i in files) print i; }'`; \
if test -z "$(ETAGS_ARGS)$$tags$$unique"; then :; else \
test -n "$$unique" || unique=$$empty_fix; \
$(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \
@@ -287,12 +265,13 @@ ctags: CTAGS
CTAGS: $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \
$(TAGS_FILES) $(LISP)
tags=; \
+ here=`pwd`; \
list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \
unique=`for i in $$list; do \
if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \
done | \
- $(AWK) '{ files[$$0] = 1; nonempty = 1; } \
- END { if (nonempty) { for (i in files) print i; }; }'`; \
+ $(AWK) ' { files[$$0] = 1; } \
+ END { for (i in files) print i; }'`; \
test -z "$(CTAGS_ARGS)$$tags$$unique" \
|| $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \
$$tags $$unique
@@ -335,9 +314,6 @@ check-am: all-am
check: check-am
all-am: Makefile $(PROGRAMS)
installdirs:
- for dir in "$(DESTDIR)$(bindir)"; do \
- test -z "$$dir" || $(MKDIR_P) "$$dir"; \
- done
install: install-am
install-exec: install-exec-am
install-data: install-data-am
@@ -362,9 +338,10 @@ distclean-generic:
maintainer-clean-generic:
@echo "This command is intended for maintainers to use"
@echo "it deletes files that may require special tools to rebuild."
+@BUILD_REFDOCS_FALSE@install-data-hook:
clean: clean-am
-clean-am: clean-binPROGRAMS clean-generic mostlyclean-am
+clean-am: clean-generic clean-noinstPROGRAMS mostlyclean-am
distclean: distclean-am
-rm -rf ./$(DEPDIR)
@@ -383,10 +360,12 @@ info: info-am
info-am:
install-data-am:
+ @$(NORMAL_INSTALL)
+ $(MAKE) $(AM_MAKEFLAGS) install-data-hook
install-dvi: install-dvi-am
-install-exec-am: install-binPROGRAMS
+install-exec-am:
install-html: install-html-am
@@ -417,42 +396,53 @@ ps: ps-am
ps-am:
-uninstall-am: uninstall-binPROGRAMS
+uninstall-am:
-.MAKE: install-am install-strip
+.MAKE: install-am install-data-am install-strip
-.PHONY: CTAGS GTAGS all all-am check check-am clean clean-binPROGRAMS \
- clean-generic ctags distclean distclean-compile \
+.PHONY: CTAGS GTAGS all all-am check check-am clean clean-generic \
+ clean-noinstPROGRAMS ctags distclean distclean-compile \
distclean-generic distclean-tags distdir dvi dvi-am html \
- html-am info info-am install install-am install-binPROGRAMS \
- install-data install-data-am install-dvi install-dvi-am \
+ html-am info info-am install install-am install-data \
+ install-data-am install-data-hook install-dvi install-dvi-am \
install-exec install-exec-am install-html install-html-am \
install-info install-info-am install-man install-pdf \
install-pdf-am install-ps install-ps-am install-strip \
installcheck installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-compile \
mostlyclean-generic pdf pdf-am ps ps-am tags uninstall \
- uninstall-am uninstall-binPROGRAMS
-
+ uninstall-am
-all: pdfdocs htmldocs mandocs
-xmldocs: docproc
- SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml
+@BUILD_REFDOCS_TRUE@all: tapsets.pdf stamp-htmldocs stamp-mandocs
+@BUILD_REFDOCS_TRUE@tapsets.xml: docproc $(shell find $(SRCTREE) -name '*.stp')
+@BUILD_REFDOCS_TRUE@ SRCTREE=$(SRCTREE) $(DOCPROC) doc $(abs_srcdir)/tapsets.tmpl > tapsets.xml.new
+@BUILD_REFDOCS_TRUE@ if cmp tapsets.xml.new tapsets.xml >/dev/null ; then \
+@BUILD_REFDOCS_TRUE@ echo tapsets.xml unchanged; \
+@BUILD_REFDOCS_TRUE@ else \
+@BUILD_REFDOCS_TRUE@ mv tapsets.xml.new tapsets.xml; \
+@BUILD_REFDOCS_TRUE@ fi
-htmldocs: xmldocs
- xmlto html -o tapsets tapsets.xml
+@BUILD_REFDOCS_TRUE@stamp-htmldocs: tapsets.xml
+@BUILD_REFDOCS_TRUE@ xmlto html -o tapsets tapsets.xml
+@BUILD_REFDOCS_TRUE@ touch stamp-htmldocs
-pdfdocs: xmldocs
- xmlto pdf tapsets.xml
+@BUILD_REFDOCS_TRUE@tapsets.pdf: tapsets.xml
+@BUILD_REFDOCS_TRUE@ xmlto pdf tapsets.xml
-mandocs: xmldocs
- xmlto man -o man5 tapsets.xml
+@BUILD_REFDOCS_TRUE@stamp-mandocs: tapsets.xml
+@BUILD_REFDOCS_TRUE@ xmlto man -o man5 tapsets.xml
+@BUILD_REFDOCS_TRUE@ touch stamp-mandocs
#FIXME need to figure out where to install things appropriately
#installmandocs: mandocs
-# $(MKDIR_P) /usr/local/man/man5/
-# install Documentation/DocBook/man/*.5.gz /usr/local/man/man5/
+@BUILD_REFDOCS_TRUE@install-data-hook:
+@BUILD_REFDOCS_TRUE@ $(MKDIR_P) $(DOC_INSTALL_DIR)
+@BUILD_REFDOCS_TRUE@ $(INSTALL_DATA) tapsets.pdf $(DOC_INSTALL_DIR)
+@BUILD_REFDOCS_TRUE@ $(MKDIR_P) $(MAN_INSTALL_DIR)
+@BUILD_REFDOCS_TRUE@ $(INSTALL_DATA) man5/* $(MAN_INSTALL_DIR)
+@BUILD_REFDOCS_TRUE@ $(MKDIR_P) $(HTML_INSTALL_DIR)
+@BUILD_REFDOCS_TRUE@ $(INSTALL_DATA) tapsets/* $(HTML_INSTALL_DIR)
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT:
diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
index 00dcd92f..f1750d45 100644
--- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl
+++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
@@ -8,7 +8,7 @@
<authorgroup>
<author>
- <firstname>Willliam</firstname>
+ <firstname>William</firstname>
<surname>Cohen</surname>
<affiliation>
<address>
@@ -19,7 +19,7 @@
</authorgroup>
<copyright>
- <year>2008</year>
+ <year>2008, 2009</year>
<holder>Red Hat, Inc.</holder>
</copyright>
@@ -92,11 +92,10 @@
</para>
<para>
- In some cases, tapsets do not have a <replaceable>return</replaceable> v
-alue. This
- simply means that the tapset does not extract anything from the kernel.
-This is common among
- asynchronous events such as timers, exit functions, and print functions.
+ In some cases, tapsets do not have a <replaceable>return</replaceable>
+ value. This simply means that the tapset does not extract anything from
+ the kernel. This is common among asynchronous events such as timers,
+ exit functions, and print functions.
</para>
<!--
@@ -122,6 +121,8 @@ This is common among
and the current register values for the processor.
</para>
!Itapset/context.stp
+!Itapset/context-symbols.stp
+!Itapset/context-unwind.stp
</chapter>
<chapter id="timestamp_stp">