[PATCH 10/10] Correct and consistent .meta files for example scripts: README

["Oestman, Fredrik" <Fredrik_Oestman at mentor dot com>]

Signed-off-by: Fredrik Östman <fredrik_oestman@mentor.com>
---
 testsuite/systemtap.examples/README |   83 +++++++++++++++++++----------------
 1 files changed, 45 insertions(+), 38 deletions(-)

diff --git a/testsuite/systemtap.examples/README b/testsuite/systemtap.examples/README
index 552f9f0..2e40876 100644
--- a/testsuite/systemtap.examples/README
+++ b/testsuite/systemtap.examples/README
@@ -17,7 +17,7 @@ examples.  Discussions take place on the
   You must designate the appropriate copyright holder for your
   contribution.  The copyright holder is assumed to agree with the
   general licensing terms (GPLv2+).
-  
+
 - coding style
 
   Abide by the general formatting of the code for SystemTap.  The
@@ -30,8 +30,8 @@ examples.  Discussions take place on the
   - No probes by file and line number are allowed in examples.
   - Avoid using guru mode (-g) in the examples.
   - Minimize use of globals variables:
- 	All associative arrays must be global in SystemTap.
-	Variables used only for the duration of a probe should be local.
+        All associative arrays must be global in SystemTap.
+        Variables used only for the duration of a probe should be local.
   - Make the file executable and use the following line at the
     beginning of the script to select the proper interpreter:
 
@@ -46,8 +46,8 @@ examples.  Discussions take place on the
   available examples; the webpage is available at:
   http://sourceware.org/systemtap/examples/.  The .meta file also
   describes how to run the compiled example script for testing. This
-  ensures that the example is frequently run to verified it works on a
-  wide range fo platforms.
+  ensures that the example is frequently run to verify it works on a
+  wide range of platforms.
 
   The meta file contains the following elements. Each element (key and
   value) are on one line. If a key can have a list of values, the list
@@ -55,46 +55,54 @@ examples.  Discussions take place on the
 
   title: Descriptive title for the script (required)
   name: the file name for the script, e.g. iotime.stp (required)
-  version: versioning if any fixes and developed can be identified (required)
+  version: versioning if any fixes and developed can be identified
+           (required)
   author: name of author(s), "anonymous" if unknown (required)
   exclusivearch: Stated if the script can only run on some arches
-	       this concept borrowed from rpm, matches types for rpm:
-	       x86 i386 x86_64 ppc ppc64, s390 (optional)
-  requires: Some scripts may require software to be available. In some cases
-	    may need version numbering, e.g. kernel >= 2.6
-    	    Can have multiple "requires:" tags. (optional)
+                 this concept borrowed from rpm, matches types for
+                 rpm: x86 i386 x86_64 ppc ppc64, s390 (optional)
+  requires: Some scripts may require software to be available. In some
+            cases may need version numbering, e.g. kernel >= 2.6
+            Can have multiple "requires:" tags. (optional)
   keywords: List of likely words to categorize the script (required)
-	    keywords are separated by spaces.
-            #FIXME have list of keyword
-  subsystem: List what part of the kernel the instrumentation probes (required)
-	     audit cpu blockio file filesystem locking memory numa network
-	     process scheduler or user-space (probes are in the user-space)
+            keywords are separated by spaces.
+            autofs backtrace callgraph cpu device disk file filesystem
+            format function futex interrupt io kvm limits locking
+            memory monitoring nanosleep network nfs numa process
+            profiling qemu scheduler scsi security signals simple slab
+            socket statistics syscall tcp thread time trace tracepoint
+            traffic tty utilization virtualization watchdog watchpoint
+  subsystem: List what part of the kernel the instrumentation probes
+             (required) any none audit cpu blockio file filesystem
+             locking memory numa network process scheduler syscall or
+             user-space (probes are in the user-space)
   application: when user-space probing becomes available (optional)
                a script might probe a particular application
-	       this tag indicates the applicaton
+               this tag indicates the applicaton
   status: describes the state of development for the script (required)
-	  proposed    	just an idea
-	  experimental	an implemented idea, but use at own risk
-	  alpha		   
-	  beta
-	  production	should be safe to use
-  exit: how long do the script run? (required)
-        fixed	    	exits in a fixed amount of time
-        user-controlled	      exits with "cntrl-c"
-        event-ended	      	    exits with some arbitrary event
+          proposed      just an idea
+          experimental  an implemented idea, but use at own risk
+          alpha
+          beta
+          production    should be safe to use
+  exit: how long does the script run? (required)
+        fixed           exits in a fixed amount of time
+        user-controlled       exits with "cntrl-c"
+        event-ended                 exits with some arbitrary event
   output: what kind of output does the script generate? (required)
-	  trace histogram graph sorted batch timed
-  scope: How much of the processes on the machine does the script watch?
-         system-wide or pid
-  arg_[0-9]+: Describe what the arguments into the script are. (optional)
+          trace histogram graph sorted-list batch timed on-exit
+  scope: How much of the processes on the machine does the script
+         watch? (required) system-wide, process or per-socket
+  arg_[0-9]+: Describe what the arguments into the script are.
+              (optional)
   description: A text description what the script does. (required)
-  test_support: How to check that the example is applicable.  Run by 'sh -c COMMAND'.
-              (e.g. stap -l needed.probe)
-  test_check: How to check that the example compiles.  Run by 'sh -c COMMAND'.
-	      (e.g. stap -p4 iotime.stp)
-  test_installcheck: How to check that the example runs.  Run by 'sh -c COMMAND'.
-		     (e.g. stap iotime.stp -c "sleep 1")
-
+  test_support: How to check that the example is applicable.  Run by
+                'sh -c COMMAND'. (e.g. stap -l needed.probe)
+  test_check: How to check that the example compiles.  Run by
+              'sh -c COMMAND'. (e.g. stap -p4 iotime.stp)
+  test_installcheck: How to check that the example runs.  Run by
+                     'sh -c COMMAND'.
+                     (e.g. stap iotime.stp -c "sleep 1")
 
 - Review, revision, and submission of the example script
 
@@ -104,4 +112,3 @@ examples.  Discussions take place on the
   ready for submission as an example, feel free to ask questions or
   discuss the work-in-progress script with other people working with
   SystemTap.
-
-- 
1.7.6.4