From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 3855 invoked by alias); 27 Nov 2008 01:47:09 -0000 Received: (qmail 3845 invoked by uid 22791); 27 Nov 2008 01:47:08 -0000 X-Spam-Level: * X-Spam-Status: No, hits=-0.9 required=5.0 tests=AWL,BAYES_00,SARE_MSGID_LONG40,SPF_PASS X-Spam-Check-By: sourceware.org Received: from yx-out-1718.google.com (HELO yx-out-1718.google.com) (74.125.44.154) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 27 Nov 2008 01:46:15 +0000 Received: by yx-out-1718.google.com with SMTP id 3so399498yxi.80 for ; Wed, 26 Nov 2008 17:46:13 -0800 (PST) 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= Received: by 10.100.9.19 with SMTP id 19mr3221272ani.8.1227750372979; Wed, 26 Nov 2008 17:46:12 -0800 (PST) Received: by 10.100.3.11 with HTTP; Wed, 26 Nov 2008 17:46:12 -0800 (PST) Message-ID: <804dabb00811261746t6deda52cg1f674ad809d7d47a@mail.gmail.com> Date: Thu, 27 Nov 2008 01:47:00 -0000 From: "Peter Teoh" To: "William Cohen" Subject: Re: Start of Systemtap Tapset Reference manual Cc: "Mark Wielaard" , SystemTAP In-Reply-To: <492C13A8.8000600@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Content-Disposition: inline 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> X-IsSubscribed: yes Mailing-List: contact systemtap-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Post: List-Help: , Sender: systemtap-owner@sourceware.org X-SW-Source: 2008-q4/txt/msg00431.txt.bz2 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 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."