diff options
Diffstat (limited to 'doc/Tapset_Reference_Guide/README')
| -rw-r--r-- | doc/Tapset_Reference_Guide/README | 33 |
1 files changed, 23 insertions, 10 deletions
diff --git a/doc/Tapset_Reference_Guide/README b/doc/Tapset_Reference_Guide/README index 1f27abe7..4ef2333a 100644 --- a/doc/Tapset_Reference_Guide/README +++ b/doc/Tapset_Reference_Guide/README @@ -1,17 +1,30 @@ -This is an automated source build of the SystemTap_Tapset_Reference Guide, -used to build it in Publican. +The Publican Tapset Reference Guide is build from files generated +during the build of SystemTap when it is configured with +"--enable-refdocs". -To build the DocBook XML source (required by Publican), run: +Assuming that SystemTap was built in /home/wcohen/systemtap/build, the +file needed to generate the Publican Tapset Reference Guide would be +/home/wcohen/systemtap/build/doc/SystemTap_Tapset_Reference/tapsets.xml. - bash publicanize.sh +To generate the required DocBook XML file of the tapsets.xml file and build +the Publican Tapset Reference Guide from this directory: -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. +export BUILD=/home/wcohen/systemtap/build +./publicanize.sh -i=$BUILD/doc/SystemTap_Tapset_Reference/tapsets.xml -The main source of the Language Reference Guide is: +This will copy and clean the XML source of SystemTap_Tapset_Reference +created by kernel-doc and place the resulting file in +./en-US/Tapset_Reference_Guide.xml. You can now build it in pdf, html, +etc using Publican. To make the Publican pdf file: - ../SystemTap_Tapset_Reference/tapsets.xml +make pdf-en-US + +The resulting output file will be +./tmp/en-US/pdf/Tapset_Reference_Guide.pdf + +The main source of the Language Reference Guide is in the build directory: + + $BUILD/doc/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 @@ -32,4 +45,4 @@ context.stp, context-symbols, and all the other tapset files are located in: 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 + http://sourceware.org/systemtap/wiki/ProjectTapsetReferenceGuide |