Using RoboDoc for tapset documentation

Mike Mason mmlnx@us.ibm.com
Tue Jul 10 15:57:00 GMT 2007


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




More information about the Systemtap mailing list