SystemTap Tapset Reference Manual

[William Cohen]

Recently I included a tweaked version of kernel-doc from the linux kernel in 
systemtap to extract documentation from the tapsets and produce html, pdf, and 
man pages. A number of the tapset files were modified to include the extractable 
documentation information (for example  socket.stp and context.stp)

When systemtap is configured a directory doc/SystemTap_Reference_Manual is setup 
with a makefile. This make file will generate the html pdf and man pages in 
subdirectories. Currently this makefile isn't connected to the top-level 
makefile and it doesn't install the resulting documentation. However, it should 
be relatively simple to add those.

If people familar with specific tapsets to got through and review and/or add the 
documentation comments to tapsets, that would be greatly appreciated. For 
sytemtap probes the structure is the following:

/**
  * probe probe_name(:)? (- short description)?
(* @variable(space)*: (description of probe variable x)?)*
(* a blank line)?
  * (Description:)? (Description of probe)?
  * (section header: (section description)? )*
(*)?*/

For systemtap functions it is:

/**
  * sfunction function_name(:)? (- short description)?
(* @parameter(space)*: (description of function parameter x)?)*
(* a blank line)?
  * (Description:)? (Description of function)?
  * (section header: (section description)? )*
(*)?*/

-Will