This is the mail archive of the systemtap@sourceware.org mailing list for the systemtap project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Start of Systemtap Tapset Reference manual


Hi all,

The infrastructure is in place to extract xml from the files in systemtap/tapset for the reference manual. I have taken the documentation from the timestamp functions and placed it in the timestamp.stp file. The xml in the timestamp.stp file is preceded by ///.

The process of generating the document is fairly simple. Go to the systemtap/doc/SystemTap_Tapset_Reference. If there have been changes to the tapset files, the xml can extracted from the tapset files with:

make extract-xml

You will need to have publican installed on the computer to build the pdf or html files. There are instructions on publican at:

http://sourceware.org/systemtap/wiki/PublicanQuikHowto

Once publican is installed make the pdf with:

make pdf-en-US

Or if HTML is desired:

make html-en-US

The resulting output will be in placed in the appropriate directory:

systemtap/doc/SystemTap_Tapset_Reference/tmp/pdf
systemtap/doc/SystemTap_Tapset_Reference/tmp/html

I have attached the current Tapset_Reference.pdf to get feedback on this process and refine it, so I don't have to revise a bunch of entries.

-Will

Attachment: Tapset_Reference.pdf
Description: pdf


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]