This is the mail archive of the systemtap@sourceware.org mailing list for the systemtap project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Start of Systemtap Tapset Reference manual


Not sure if it has been mentioned before:

a.   In the section on netdev.receive, are three global parameter.
But I read the source (tapset/networking.stp), inside this function
are declared 4 variables instead.   "truesize" is missed out?

b.   Wouldn't it be good to have an example (perhaps not for all
function, but at least one example to summarize a few functions etc)
after each function description?   Or another way - an
"example/sample" section entirely dedicated to describing the
testsuite/systemtap.examples or testsuite/systemtap.samples and
showing some of the codes and its expected output?

Expected output speaks a thousand words, so not much explanation is
really needed.

Similarly, a real, short script showing how the function/stapprobe
are used, speaks a hundred words, if not a thousand.

c.   I also saw quite a many others similar references - it will be
good to reference these existing documentation if possible:

http://sourceware.org/systemtap/langref.pdf
http://fedoraproject.org/w/uploads/3/3c/LCA_Melbourne2008_systemtap-scripts.pdf
etc etc.


On Tue, Nov 25, 2008 at 11:03 PM, William Cohen <wcohen@redhat.com> wrote:
> Mark Wielaard wrote:
>
>> Just a quick note on how it looks. I like the output. It is imho nicer
>> (less verbose) than the previous versions based on publican. The only
>> thing that would need some tweaking is the synopsis in the pdf version
>> it comes after the name with a lot of extra whitespace (but not the word
>> synopsis). In both the pdf and the html version functions are formatted
>> somewhat oddly with the closing bracket on their own line.
>>
>>> The man pages are at:
>>>
>>> http://people.redhat.com/wcohen/systemtap-doc/SystemTap_Tapset_Reference/
>>
>> It might be a bit much to have a man page for each probe and function.
>> Is there a way to group them in sets based on tapset filename or the
>> chapter names for example?
>>
>> Cheers,
>>
>> Mark
>>
>
>
> Hi Mark,
>
> Thanks for the feedback. I noticed the closing parenthesis oddity also and I
> have modified the output of SystemTap function synopis to be a bit more
> compact.
>
> I found man pages for each function and probe a bit much. I am not sure if
> there is a way to get xmlto to group them together.
>
> -Will
>



-- 
Regards,
Peter Teoh

Ernest Hemingway - "Never mistake motion for action."


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]