guru-delay: add tapset documentation

diff --git a/doc/SystemTap_Tapset_Reference/tapsets.tmpl b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
index 442876e8521686ae2842e8fa2043027e97cf3b81..ef053baa5ab86b4d691974d9d0d66a10b3215378 100644 (file)
--- a/doc/SystemTap_Tapset_Reference/tapsets.tmpl
+++ b/doc/SystemTap_Tapset_Reference/tapsets.tmpl
@@ -347,6 +347,16 @@
 !Itapset/conversions-guru.stp
     </chapter>
 
+  <chapter id="guru-delay.stp">
+    <title>Delay tapset</title>
+    <para>
+      Functions to insert a deliberate delay into a probe handler.
+      All the functions in this tapset require the use of
+      guru mode (<command>-g</command>).
+    </para>
+!Itapset/guru-delay.stp
+  </chapter>
+
   <chapter id="string.stp">
     <title>A collection of standard string functions</title>
     <para>

diff --git a/tapset/guru-delay.stp b/tapset/guru-delay.stp
index 6292883dc40527a844cb5012bbcb332e978f243b..ee0dc62c73b6416fafb5a6ee0f06da59b55cdaa4 100644 (file)
--- a/tapset/guru-delay.stp
+++ b/tapset/guru-delay.stp
@@ -7,7 +7,10 @@
 //
 
 // <tapsetdescription>
-// Programmable delays at probe sites.
+// Functions in the guru-delay tapset allow a probe handler to insert
+// deliberate delays.  This is sometimes useful as a fault-injection
+// aid.  Due to its likelihood of interference with the kernel, guru
+// mode is required, and overload-prevention is suppressed.
 // </tapsetdescription>
 
 %{
@@ -16,11 +19,26 @@
 #include <linux/delay.h>
 %}
 
+
+/**
+ * sfunction mdelay - millisecond delay
+ * @ms: Number of milliseconds to delay.
+ *
+ * Description: This function inserts a multi-millisecond busy-delay into a probe handler.
+ * It requires guru mode.
+ */
 function mdelay(ms:long) %{
   /* guru */
   mdelay(THIS->ms);
 %}
 
+/**
+ * sfunction mdelay - microsecond delay
+ * @ms: Number of microseconds to delay.
+ *
+ * Description: This function inserts a multi-microsecond busy-delay into a probe handler.
+ * It requires guru mode.
+ */
 function udelay(us:long) %{
   /* guru */
   udelay(THIS->us);