Debian Codegraph @

doc/Tapset_Reference_Guide/README

raw
1 The Publican Tapset Reference Guide is build from files generated
2 during the build of SystemTap when it is configured with
3 "--enable-refdocs".
4
5 Assuming that SystemTap was built in /home/wcohen/systemtap/build, the
6 file needed to generate the Publican Tapset Reference Guide would be
7 /home/wcohen/systemtap/build/doc/SystemTap_Tapset_Reference/tapsets.xml.
8
9 To generate the required DocBook XML file of the tapsets.xml file and build
10 the Publican Tapset Reference Guide from this directory:
11
12 export BUILD=/home/wcohen/systemtap/build
13 ./publicanize.sh -i=$BUILD/doc/SystemTap_Tapset_Reference/tapsets.xml
14
15 This will copy and clean the XML source of SystemTap_Tapset_Reference
16 created by kernel-doc and place the resulting file in
17 ./en-US/Tapset_Reference_Guide.xml. You can now build it in pdf, html,
18 etc using Publican. To make the Publican pdf file:
19
20 make pdf-en-US
21
22 The resulting output file will be
23 ./tmp/en-US/pdf/Tapset_Reference_Guide.pdf
24
25 The main source of the Language Reference Guide is in the build directory:
26
27 $BUILD/doc/SystemTap_Tapset_Reference/tapsets.xml
28
29 This main source is generated by kernel-doc when you run 'make' in the
30 main git tree. The tapset documentation inside is collected from all
31 tapset files defined in the following template file:
32
33 ../SystemTap_Tapset_Reference/tapsets.tmpl
34
35 The tapset file definitions appear in tapsets.tmpl as:
36
37 !Itapset/context.stp
38 !Itapset/context-symbols.stp
39 etc
40
41 context.stp, context-symbols, and all the other tapset files are located in:
42
43 ../../tapset
44
45 All tapset documentation should be done inside their respective tapset files.
46 For more information about this project, refer to:
47
48 http://sourceware.org/systemtap/wiki/ProjectTapsetReferenceGuide