This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
Using RoboDoc for tapset documentation
- From: Mike Mason <mmlnx at us dot ibm dot com>
- To: systemtap at sources dot redhat dot com
- Date: Tue, 10 Jul 2007 08:56:42 -0700
- Subject: Using RoboDoc for tapset documentation
I've been experimenting with something called RoboDoc to generate documentation from tapset file comments. You can see an example that uses the sockets tapset at http://www.mwmnet.com/systemtap/robodoc/. The socket.stp file shows the robodoc markup I used in the tapset file. The other directories show the resulting output in various formats. It's not perfect, but it's pretty good, IMHO. Still needs fine tuning in some areas.
Please take a look and let me know what you think. Sure would be nice to standardize tapset documentation using something like this.
Question... RoboDoc is GPL'd, but doesn't appear to be shipped in any distros. Is that an issue? Could we just include RoboDoc in the SystemTap src tree?
Mike