From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 32293 invoked by alias); 14 Nov 2008 14:08:44 -0000 Received: (qmail 32160 invoked by uid 22791); 14 Nov 2008 14:08:43 -0000 X-Spam-Status: No, hits=-2.0 required=5.0 tests=AWL,BAYES_00,J_CHICKENPOX_93,KAM_MX,SPF_HELO_PASS,SPF_PASS X-Spam-Check-By: sourceware.org Received: from mx1.redhat.com (HELO mx1.redhat.com) (66.187.233.31) by sourceware.org (qpsmtpd/0.31) with ESMTP; Fri, 14 Nov 2008 14:07:51 +0000 Received: from int-mx1.corp.redhat.com (int-mx1.corp.redhat.com [172.16.52.254]) by mx1.redhat.com (8.13.8/8.13.8) with ESMTP id mAEE7nR2007426 for ; Fri, 14 Nov 2008 09:07:49 -0500 Received: from ns3.rdu.redhat.com (ns3.rdu.redhat.com [10.11.255.199]) by int-mx1.corp.redhat.com (8.13.1/8.13.1) with ESMTP id mAEE7mlU030129 for ; Fri, 14 Nov 2008 09:07:48 -0500 Received: from localhost.localdomain (dhcp231-126.rdu.redhat.com [10.11.231.126]) by ns3.rdu.redhat.com (8.13.8/8.13.8) with ESMTP id mAEE7lAL004151; Fri, 14 Nov 2008 09:07:48 -0500 Message-ID: <491D8633.4000605@redhat.com> Date: Fri, 14 Nov 2008 14:08:00 -0000 From: William Cohen User-Agent: Thunderbird 2.0.0.16 (X11/20080723) MIME-Version: 1.0 To: Don Domingo CC: SystemTAP Subject: Re: Start of Systemtap Tapset Reference manual References: <4919B665.2060606@redhat.com> <491CBA1C.4080108@redhat.com> In-Reply-To: <491CBA1C.4080108@redhat.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit X-Scanned-By: MIMEDefang 2.58 on 172.16.52.254 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/msg00362.txt.bz2 Don Domingo wrote: > Hi Will, > > Thanks for this. As far as format goes, everything is just perfect; I'll > be doing a proofread run soon. The only suggestion I have for everyone > working on this guide is that for "FIXME: needs description" > placeholders, use the tags so everybody can see clearly which > tapsets still need to be defined. I've edited the ones for > module_name:string() and stp_pid:long() to demonstrate this. > > /// > /// stp_pid:long() > /// stp_pid > /// > /// FIXME: need description. > /// > /// > > To make work, I also added the SHOW_REMARKS=1 option in the > Makefile. This ensures that remarks are displayed by default. > > Cheers, > Don Thanks for the feedback. Remarks would be a better way of handling that. I find the xml to be rather verbose. The original comments in the tapsets were much more compact. I am considering having something generate the xml from the stylized comments rather than having all the raw xml in the tapsets. -Will > > William Cohen 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 >