Re: Start of Systemtap Tapset Reference manual

["Peter Teoh" <htmldeveloper@gmail.com>]

(resent due to bounced email)

Not sure if my suggestion has any relevancy or unanticipated or not,
but I will just describe it.

what i am proposing is:   do the minimal work to create the
documentation, maximize the consistency with that of Linux Kernel, so
that UNIFICATION of systemtap with Linux Kernel source may one be
possible.

How?

a.   When create the documentation, for example, the current
systemtap/doc always assumed that the entire subdirectory can be moved
to become Linux Kernel's Documentation's subdirectory, perhaps
"systemtap" as the name.

b.   So when a user go to Linux Kernel source and enter "make
htmldocs", or "make pdfdocs", a htmlized or pdf-ized document will be
created under DocBook.  Ie, there will be ZERO scripting effort from
systemtap developer, and all existing infrastructure provided by Linux
Kernel source's "script" subdirectory can be reused.

On a wider scale, the above can be generalized further.   But I would
like some feedback before venturing too far.


On Wed, Nov 12, 2008 at 12:44 AM, William Cohen <wcohen@redhat.com> wrote:
>
> 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



--
Regards,
Peter Teoh