summaryrefslogtreecommitdiffstats
path: root/doc/Tapset_Reference_Guide
diff options
context:
space:
mode:
authorddomingo <ddomingo@redhat.com>2009-03-05 11:23:00 +1000
committerddomingo <ddomingo@redhat.com>2009-03-05 11:23:00 +1000
commit345f6a4daad184385b7ee1dc3797f57a3be01452 (patch)
tree2c933134197c5bbb603b5786574b5c9743c5fbb4 /doc/Tapset_Reference_Guide
parenta06948f6631daaeb1cf3f63d9ecd20795deebc21 (diff)
downloadsystemtap-steved-345f6a4daad184385b7ee1dc3797f57a3be01452.tar.gz
systemtap-steved-345f6a4daad184385b7ee1dc3797f57a3be01452.tar.xz
systemtap-steved-345f6a4daad184385b7ee1dc3797f57a3be01452.zip
change to fedora, add README for more info
Diffstat (limited to 'doc/Tapset_Reference_Guide')
-rw-r--r--doc/Tapset_Reference_Guide/Makefile2
-rw-r--r--doc/Tapset_Reference_Guide/README35
2 files changed, 36 insertions, 1 deletions
diff --git a/doc/Tapset_Reference_Guide/Makefile b/doc/Tapset_Reference_Guide/Makefile
index 05220405..87a1fb5f 100644
--- a/doc/Tapset_Reference_Guide/Makefile
+++ b/doc/Tapset_Reference_Guide/Makefile
@@ -3,7 +3,7 @@
XML_LANG = en-US
DOCNAME = Tapset_Reference_Guide
#PRODUCT = FIX_ME!
-BRAND = RedHat
+BRAND = fedora
#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW
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