summaryrefslogtreecommitdiffstats
path: root/testsuite/systemtap.examples/README
diff options
context:
space:
mode:
authorFrank Ch. Eigler <fche@elastic.org>2008-08-11 17:34:47 -0400
committerFrank Ch. Eigler <fche@elastic.org>2008-08-11 17:34:47 -0400
commit42e740602dbb7960e11b0bbf9053e95e8a1cb1e5 (patch)
treeaa32f56c7c5b1838e9d80bec2c15325c71742660 /testsuite/systemtap.examples/README
parent3213d0891c826f16ba727a3e863075e2922666a0 (diff)
parent79640c29c5bcf8de20f013dcc80e1a9c7a93811f (diff)
downloadsystemtap-steved-42e740602dbb7960e11b0bbf9053e95e8a1cb1e5.tar.gz
systemtap-steved-42e740602dbb7960e11b0bbf9053e95e8a1cb1e5.tar.xz
systemtap-steved-42e740602dbb7960e11b0bbf9053e95e8a1cb1e5.zip
Merge commit 'origin/master' into pr4225
* commit 'origin/master': (34 commits) PR5049: fix overbroad effects of naive "*" prefixing; instead use optional "*/" only. stap-serverd was incorectly determining that the server could stapprobes man page: clarify statement(NUM).absolute and process("path") searching PR5049: prefix with "*" any filenames given in "fn@filename:line" probes Indentation fix. Redirect stderr gets redircted so warnings don't let example script run fail. PR6835. io/io_submit.stp: Fix #! start. Convert to normal line-ending. PR2895. Add proper #! /usr/bin/env stap line. Make example scripts executable. Use INSTALL_PROGRAM, not INSTALL_DATA for executable .stp scripts. example index: only warn if old, do not regenerate Start/stop the systemtap server from systemtap.exp and not in the top level Makefile. Lower statement wildcard test matching threshold. Moved details of utrace detach to stap_utrace_detach(). Saves thread vma information. Always generate examples indexes and install examples from srcdir. Refer to srcdir spec file Makefile so make rpm works when builddir != srcdir. Add index of subsystem and keywords at top of HTML indexes. Don't output output, exits, status line in indexes (mentioned in descriptions). Disable chmodding of samples/kmalloc-top in spec file since it isn't installed. Make sure examples indexes are always generated in builddir. ...
Diffstat (limited to 'testsuite/systemtap.examples/README')
-rw-r--r--testsuite/systemtap.examples/README52
1 files changed, 50 insertions, 2 deletions
diff --git a/testsuite/systemtap.examples/README b/testsuite/systemtap.examples/README
index 6718a55a..e505bdfb 100644
--- a/testsuite/systemtap.examples/README
+++ b/testsuite/systemtap.examples/README
@@ -5,5 +5,53 @@ Each script should be checked in as executable.
The first line should be
#! /usr/bin/env stap
-There should be an accompanying ".txt" file describing what the
-script does and how to use it.
+There should be an accompanying ".meta" file describing what the
+script does and how to use it, and how the testsuite should compile
+and run it. The meta files are also used to create a txt and html
+index (by keyword and subsystem) of all the examples by the
+examples-index-gen.pl script.
+
+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
+elements are separated by spaces.
+
+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)
+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)
+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)
+application: when user-space probing becomes available (optional)
+ a script might probe a particular application
+ 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
+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)
+description: A text description what the script does. (required)
+test_check: How to check that the example compiles.
+ (e.g. stap -p4 iotime.stp)
+test_installcheck: How to check that the example runs.
+ (e.g. stap iotime.stp -c "sleep 1")
+