2006-01-17 Josh Stone <joshua.i.stone@intel.com>

	* stap.1.in: Document the 'delete' operator.

diff --git a/ChangeLog b/ChangeLog
index 94128a63e91360f87be0d25689edffb8837b67e6..41105f149542b1d846e1506e95450331c643e798 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-01-17  Josh Stone  <joshua.i.stone@intel.com>
+
+       * stap.1.in: Document the 'delete' operator.
+
 2006-01-16  Roland McGrath  <roland@redhat.com>
 
        * systemtap.spec.in (elfutils_version): Require 0.119 now.

diff --git a/stap.1.in b/stap.1.in
index 69c1e6d2b9d2e2c5f2f025d309f0a0a4eb92d868..d37060eb1d82142cc599b702f5214cf2e772da15 100644 (file)
--- a/stap.1.in
+++ b/stap.1.in
@@ -294,6 +294,18 @@ function will have a special "unknown" type with no return value.
 .TP
 .BR next
 Return now from enclosing probe handler.
+.TP
+.BR delete " ARRAY[INDEX1, INDEX2, ...]"
+Remove from ARRAY the element specified by the index tuple.  The value will no
+longer be available, and subsequent iterations will not report the element.
+It is not an error to delete an element that does not exist.
+.TP
+.BR delete " ARRAY"
+Remove all elements from ARRAY.
+.TP
+.BR delete " SCALAR"
+Removes the value of SCALAR.  Integers and strings are cleared to 0 and ""
+respectively, while statistics are reset to the initial empty state.
 
 .SS EXPRESSIONS
 Systemtap supports a number of operators that have the same general syntax,