From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6802 invoked by alias); 5 Dec 2008 17:28:31 -0000 Received: (qmail 6787 invoked by uid 22791); 5 Dec 2008 17:28:29 -0000 X-Spam-Level: * X-Spam-Status: No, hits=-1.8 required=5.0 tests=AWL,BAYES_00,J_CHICKENPOX_63,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.43rc1) with ESMTP; Fri, 05 Dec 2008 17:27:54 +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 mB5HRq1Y003208 for ; Fri, 5 Dec 2008 12:27:52 -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 mB5HRqOD013274 for ; Fri, 5 Dec 2008 12:27:52 -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 mB5HRqmH002039 for ; Fri, 5 Dec 2008 12:27:52 -0500 Message-ID: <49396498.1010700@redhat.com> Date: Fri, 05 Dec 2008 17:28:00 -0000 From: William Cohen User-Agent: Thunderbird 2.0.0.18 (X11/20081119) MIME-Version: 1.0 To: SystemTAP Subject: SystemTap Tapset Reference Manual 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/msg00489.txt.bz2 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