summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--ChangeLog7
-rw-r--r--stap.1.in6
-rw-r--r--stapex.5.in4
-rw-r--r--stapfuncs.5.in20
4 files changed, 17 insertions, 20 deletions
diff --git a/ChangeLog b/ChangeLog
index 0cdb4e7d..95dff80c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
2007-11-12 Martin Hunt <hunt@redhat.com>
+ * stap.1.in: Replaced references to the log() function.
+ * stapex.5.in: Ditto.
+ * stapfuncs.5.in: Ditto. ALso remove print and printf. They are
+ documented in stap.1.in.
+
+2007-11-12 Martin Hunt <hunt@redhat.com>
+
* translate.cxx (visit_print_format): Strings without a format or
formatted with "%s" or "%s\n" should be printed with calls to _stp_print().
Call _stp_print_char() if printing a char.
diff --git a/stap.1.in b/stap.1.in
index 8fd7fec7..135e92f5 100644
--- a/stap.1.in
+++ b/stap.1.in
@@ -276,7 +276,7 @@ var1 = 5
var2 = "bar"
array1 [pid()] = "name" # single numeric key
array2 ["foo",4,i++] += 5 # vector of string/num/num keys
-if (["hello",5,4] in array2) log ("yes") # membership test
+if (["hello",5,4] in array2) println ("yes") # membership test
.ESAMPLE
.PP
The translator performs
@@ -517,9 +517,9 @@ a macro in the translated C code and is in the neighbourhood of 10.
.SS PRINTING
There are a set of function names that are specially treated by the
translator. They format values for printing to the standard systemtap
-log stream in a more convenient way. The
+output stream in a more convenient way. The
.IR sprint*
-variants return the formatted string instead of logging it.
+variants return the formatted string instead of printing it.
.TP
.BR print ", " sprint
Print one or more values of any type, concatenated directly together.
diff --git a/stapex.5.in b/stapex.5.in
index f8f61c32..86e1c87b 100644
--- a/stapex.5.in
+++ b/stapex.5.in
@@ -97,8 +97,8 @@ limits, and result in an error.
To trace entry and exit from a function, use a pair of probes:
.SAMPLE
-probe kernel.function("sys_mkdir") { log ("enter") }
-probe kernel.function("sys_mkdir").return { log ("exit") }
+probe kernel.function("sys_mkdir") { println ("enter") }
+probe kernel.function("sys_mkdir").return { println ("exit") }
.ESAMPLE
To list the probeable functions in the kernel, use the last-pass
diff --git a/stapfuncs.5.in b/stapfuncs.5.in
index 496d5760..cd10a2ba 100644
--- a/stapfuncs.5.in
+++ b/stapfuncs.5.in
@@ -23,32 +23,22 @@ example2:unknown ()
In function "example2", do something. There is no explicit return value
and take no parameters.
-.SS LOGGING
+.SS PRINTING
.TP
log:unknown (msg:string)
-Log the given string to the common trace buffer. Append an implicit
-end-of-line.
-
-.TP
-print:unknown (...)
-Print the given integer, string, or statistics value to
-the common trace buffer.
-
-.TP
-printf:unknown (fmt:string, ...)
-Like the C printf, except valid types are limited to string ("%s")
-and integer ("%d").
+Writes the given string to the common trace buffer. Append an implicit
+end-of-line. Deprecated. Please use the faster print functions.
.TP
warn:unknown (msg:string)
-Log the given string to the warning stream. Append an implicit end-of-line.
+Write the given string to the warning stream. Append an implicit end-of-line.
.I staprun
prepends the string "WARNING:".
.TP
error:unknown (msg:string)
-An error has occurred. Log the given string to the error stream.
+An error has occurred. Write the given string to the error stream.
Append an implicit end-of-line.
.I staprun
prepends the string "ERROR:".