This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
Re: Start of Systemtap Tapset Reference manual
- From: "Peter Teoh" <htmldeveloper at gmail dot com>
- To: "William Cohen" <wcohen at redhat dot com>
- Cc: "Mark Wielaard" <mjw at redhat dot com>, SystemTAP <systemtap at sources dot redhat dot com>
- Date: Thu, 27 Nov 2008 09:46:12 +0800
- Subject: Re: Start of Systemtap Tapset Reference manual
- Dkim-signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:received:message-id:date:from:to :subject:cc:in-reply-to:mime-version:content-type :content-transfer-encoding:content-disposition:references; bh=vPTWCUSsRQZEZq/ztcNmOq2e6rOtyCybx9eKiuhQ5ww=; b=HsEvE7cDVzbqt240uVN9cz9zYvO44WyyARd6NkFZUdzsRZ3bzj4FKuM+VPVvvKCPTi 3mVMgk0Z8cdFr9Q/AU1GJCuIsk1ndUEUHDFQYYFWGaO+uynvRlcI/RbMZk+/mnnXrePG lVIM15n8MWwpP/RNPCOon9Z6iEKY+zDbhRaAA=
- Domainkey-signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=message-id:date:from:to:subject:cc:in-reply-to:mime-version :content-type:content-transfer-encoding:content-disposition :references; b=v1KUqlNaRlVETEkB/wAh9VJmAWoDKY/p4VZtrcuyA4JFZyErwZPfHg8lm2JK9UFVTr hTW+ihqzQpmnA+ic26uE7Ao8kGi5JihqikdUqyBFz/nxPT5EpshNLHd27UCFuApceElm 1ErKpL4Vzsu7TT/AxcAt6b9Ie7wy3ydbPXGL0=
- References: <4919B665.2060606@redhat.com> <804dabb00811162156s7cc931deja89861e47571331f@mail.gmail.com> <4922F374.2060609@redhat.com> <492328F5.3080003@oracle.com> <4925D70F.4010602@redhat.com> <4925D92B.50401@oracle.com> <492ADA6D.7040705@redhat.com> <492AFD5F.8040102@redhat.com> <1227612392.29090.14.camel@dijkstra.wildebeest.org> <492C13A8.8000600@redhat.com>
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."