summaryrefslogtreecommitdiffstats
path: root/doc/Tapset_Reference_Guide/README
diff options
context:
space:
mode:
authorDave Brolley <brolley@redhat.com>2009-03-16 12:15:24 -0400
committerDave Brolley <brolley@redhat.com>2009-03-16 12:15:24 -0400
commit24068a1f2e17857f4ce096a17244d09575a199c1 (patch)
treeb00dd1b858b19cc21a440d734e44ebe14d080d5a /doc/Tapset_Reference_Guide/README
parent5bc7237f1c7bdb0eb850752c9611f94d009feff0 (diff)
parent2497c78e8aa704366683dad56fc8d749a5e92f52 (diff)
downloadsystemtap-steved-24068a1f2e17857f4ce096a17244d09575a199c1.tar.gz
systemtap-steved-24068a1f2e17857f4ce096a17244d09575a199c1.tar.xz
systemtap-steved-24068a1f2e17857f4ce096a17244d09575a199c1.zip
Merge branch 'master' of git://sources.redhat.com/git/systemtap
Conflicts: Makefile.in main.cxx stap-find-servers stap-start-server
Diffstat (limited to 'doc/Tapset_Reference_Guide/README')
-rw-r--r--doc/Tapset_Reference_Guide/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/Tapset_Reference_Guide/README b/doc/Tapset_Reference_Guide/README
new file mode 100644
index 00000000..1f27abe7
--- /dev/null
+++ b/doc/Tapset_Reference_Guide/README
@@ -0,0 +1,35 @@
+This is an automated source build of the SystemTap_Tapset_Reference Guide,
+used to build it in Publican.
+
+To build the DocBook XML source (required by Publican), run:
+
+ bash publicanize.sh
+
+This will copy and clean the XML source of SystemTap_Tapset_Reference
+created by kernel-doc. You can now build it in pdf, html, etc using
+Publican.
+
+The main source of the Language Reference Guide is:
+
+ ../SystemTap_Tapset_Reference/tapsets.xml
+
+This main source is generated by kernel-doc when you run 'make' in the
+main git tree. The tapset documentation inside is collected from all
+tapset files defined in the following template file:
+
+ ../SystemTap_Tapset_Reference/tapsets.tmpl
+
+The tapset file definitions appear in tapsets.tmpl as:
+
+ !Itapset/context.stp
+ !Itapset/context-symbols.stp
+ etc
+
+context.stp, context-symbols, and all the other tapset files are located in:
+
+ ../../tapset
+
+All tapset documentation should be done inside their respective tapset files.
+For more information about this project, refer to:
+
+ http://sourceware.org/systemtap/wiki/ProjectTapsetReferenceGuide \ No newline at end of file