This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
Re: Using RoboDoc for tapset documentation
- From: Eugene Teo <eteo at redhat dot com>
- To: Mike Mason <mmlnx at us dot ibm dot com>
- Cc: systemtap at sources dot redhat dot com
- Date: Wed, 11 Jul 2007 00:08:47 +0800
- Subject: Re: Using RoboDoc for tapset documentation
- Organization: Red Hat, Inc
- References: <4693AC3A.7040708@us.ibm.com>
Mike Mason wrote:
>
> 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.
Very nice. Are there alternatives or is this the best one you tried?
> 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?
Would be silly if we just include RoboDoc into the src tree. Probably better
if RoboDoc is packaged separately if we decided to use it.
Eugene