]> sourceware.org Git - systemtap.git/commitdiff
new intro, tapset dev guide
authorddomingo <ddomingo@redhat.com>
Thu, 5 Mar 2009 05:21:10 +0000 (15:21 +1000)
committerddomingo <ddomingo@redhat.com>
Thu, 5 Mar 2009 05:21:10 +0000 (15:21 +1000)
doc/Tapset_Reference_Guide/en-US/Introduction.xml [new file with mode: 0644]
doc/Tapset_Reference_Guide/en-US/Tapset_Dev_Guide.xml [new file with mode: 0644]

diff --git a/doc/Tapset_Reference_Guide/en-US/Introduction.xml b/doc/Tapset_Reference_Guide/en-US/Introduction.xml
new file mode 100644 (file)
index 0000000..633521e
--- /dev/null
@@ -0,0 +1,59 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+
+<chapter id="introduction">
+       <title>Introduction</title>
+       
+       <para>
+               SystemTap provides free software (GPL) infrastructure to simplify the
+               gathering of information about the running Linux system. This assists
+               diagnosis of a performance or functional problem. SystemTap eliminates the
+               need for the developer to go through the tedious and disruptive instrument,
+               recompile, install, and reboot sequence that may be otherwise required to
+               collect data.
+       </para>
+       
+       <para>
+               SystemTap provides a simple command line interface and scripting language
+               for writing instrumentation for a live, running kernel. This instrumentation
+               uses probe points and functions provided in the <firstterm>tapset</firstterm> library.
+       </para>
+       
+       <para>
+               Simply put, tapsets are scripts that encapsulate knowledge about a kernel subsystem
+               into pre-written probes and functions that can be used by other scripts. 
+               Tapsets are analogous to libraries for C programs.  They hide the
+               underlying details of a kernel area while exposing the key information
+               needed to manage and monitor that aspect of the kernel.  They are typically
+               developed by kernel subject-matter experts.
+       </para>
+               
+       <para>
+               A tapset exposes the high-level data and state transitions of a
+               subsystem. For the most part, good tapset developers assume that
+               SystemTap users know little to nothing about the kernel subsystem's 
+               low-level details. As such, tapset developers write tapsets that help
+               ordinary SystemTap users write meaningful and useful SystemTap scripts.
+       </para>
+               
+<!-- add xref to upcoming section on how to write Tapsets/Tapset Comments -->
+       
+       <section id="docsgoals">
+               <title>Documentation Goals</title>
+               
+               <para>
+                       This guide aims to document SystemTap's most useful and common tapset entries; it 
+                       also contains guidelines on proper tapset development and documentation.
+                       The tapset definitions contained in this guide are extracted automatically from 
+                       properly-formatted comments in the code of each tapset file. As such, any revisions
+                       to the definitions in this guide should be applied directly to their respective
+                       tapset file.
+               </para>
+               
+<remark>add: "while users can read from code, it's easier to read from here!"</remark>
+<remark>add: target audience, expected proficiency of readers</remark>
+               
+       </section>
+       
+</chapter>
\ No newline at end of file
diff --git a/doc/Tapset_Reference_Guide/en-US/Tapset_Dev_Guide.xml b/doc/Tapset_Reference_Guide/en-US/Tapset_Dev_Guide.xml
new file mode 100644 (file)
index 0000000..be59d94
--- /dev/null
@@ -0,0 +1,33 @@
+<?xml version='1.0'?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+
+<chapter id="Tapset_Dev_Guide">
+       <title>Tapset Development Guidelines</title>
+
+<para>
+       This chapter describes the upstream guidelines on proper tapset documentation. It also contains
+       information on how to properly document your tapsets, to ensure that they are properly 
+       defined in this guide.
+</para>
+       
+       <section id="Tapsetcontents">
+               <title>Writing Good Tapsets</title>
+               
+<para>
+       The first step to writing good tapsets is  to create a simple model of your subject area.  For
+       example, a model of the process subsystem might include the following:
+</para>
+<remark>info from here:http://sources.redhat.com/git/?p=systemtap.git;a=blob_plain;f=tapset/DEVGUIDE</remark>
+
+       </section>
+       
+       <section id="Tapset_Reference_Guide-Test-Section_2_Test">
+               <title>Section 2 Test</title>
+               <para>
+                       Test of a section
+               </para>
+       </section>
+
+</chapter>
+
This page took 0.027242 seconds and 5 git commands to generate.