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]

Re: Start of Systemtap Tapset Reference manual


William Cohen wrote:
Randy Dunlap wrote:

Not currently, but I don't see why it couldn't be done. Then the question
becomes: is it the same scripts/kernel-doc file or is it scripts/stap-doc
(e.g. -- or some other name)?

This weekend I played around this some more and created some patches to use kernel-doc as method of encoding the documentation in the tapset files.


kernel-doc1.patch  removes the old documentation method
kernel-doc2.patch  adds the kernel-doc
kernel-doc3.patch  revises the tapsets files to generate instumentation.

To make the instrumentation need to go in the the build directory doc/SystemTap_Tapset_Reference and do a "make" in there. It dodn't currently install the resulting documtation any where.

Comments on this series of patches would be appreciated.

-Will

Hi,


I have also placed the patches kernel-doc[123].patch at:

http://people.redhat.com/wcohen/systemtap-doc/

If you are interested in see what the output looks like, I made the current types of output available. The pdf is:

http://people.redhat.com/wcohen/systemtap-doc/SystemTap_Tapset_Reference/tapsets.pdf

The html:

http://people.redhat.com/wcohen/systemtap-doc/SystemTap_Tapset_Reference/tapset/

The man pages are at:

http://people.redhat.com/wcohen/systemtap-doc/SystemTap_Tapset_Reference/

-Will


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