summaryrefslogtreecommitdiffstats
path: root/doc/Tapset_Reference_Guide/README
blob: 1f27abe7485dab62c30dc3a35308a41ed3af3cde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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