From 4ff35bd8427b8505a9eeec7d1119803ec4d011b2 Mon Sep 17 00:00:00 2001 From: mmason Date: Sun, 28 Oct 2007 17:37:49 +0000 Subject: [PATCH] Regenerated langref html docs after changes to hist_linear() and hist_log() descriptions. --- langref/index.html | 170 +++++----- langref/labels.pl | 2 +- langref/langref.html | 170 +++++----- langref/node1.html | 158 ++++----- langref/node10.html | 121 ++++--- langref/node11.html | 761 ++++++++++++++++++++++--------------------- langref/node12.html | 20 +- langref/node13.html | 198 +++++------ langref/node14.html | 18 +- langref/node2.html | 28 +- langref/node3.html | 58 ++-- langref/node4.html | 24 +- langref/node5.html | 60 ++-- langref/node6.html | 70 ++-- langref/node7.html | 106 +++--- langref/node8.html | 64 ++-- langref/node9.html | 48 +-- 17 files changed, 1064 insertions(+), 1012 deletions(-) diff --git a/langref/index.html b/langref/index.html index ce23f9f2..d998af8f 100644 --- a/langref/index.html +++ b/langref/index.html @@ -370,7 +370,7 @@ Fifth Floor, Boston, MA 02110-1301, USA. HREF="node11.html#SECTION0001111100000000000000">9.1.11 warn
  • 9.2 Task context at the probe point + HREF="node11.html#SECTION000112000000000000000">9.2 Context at the probe point
  • 9.2.23 task_cpu + HREF="node11.html#SECTION000113000000000000000">9.3 Task data + + HREF="node11.html#SECTION0001131400000000000000">9.3.14 task_open_file_handles
  • 9.3 Accessing string data at a probe point -
  • 9.3.1 kernel_string + HREF="node11.html#SECTION000114000000000000000">9.4 Accessing string data at a probe point + + HREF="node11.html#SECTION000114400000000000000">9.4.4 user_string_warn
  • 9.4 Initializing queue statistics -
  • 9.4.1 qs_wait + HREF="node11.html#SECTION000115000000000000000">9.5 Initializing queue statistics + + HREF="node11.html#SECTION000115200000000000000">9.5.2 qs_run
  • 9.5 Using queue statistics -
  • 9.5.1 qsq_blocked + HREF="node11.html#SECTION000116000000000000000">9.6 Using queue statistics + + HREF="node11.html#SECTION000116800000000000000">9.6.8 qsq_wait_time
  • 9.6 Probe point identification -
  • 9.6.1 pp + HREF="node11.html#SECTION000117000000000000000">9.7 Probe point identification + + HREF="node11.html#SECTION000117200000000000000">9.7.2 probefunc
  • 9.7 Formatting functions -
  • 9.7.1 ctime + HREF="node11.html#SECTION000118000000000000000">9.8 Formatting functions + + HREF="node11.html#SECTION000118400000000000000">9.8.4 thread_indent
  • 9.8 String functions -
  • 9.8.1 isinstr + HREF="node11.html#SECTION000119000000000000000">9.9 String functions + + HREF="node11.html#SECTION000119600000000000000">9.9.6 text_strn
  • 9.9 Timestamps -
  • 9.9.1 get_cycles + HREF="node11.html#SECTION0001110000000000000000">9.10 Timestamps + + HREF="node11.html#SECTION0001110400000000000000">9.10.4 gettimeofday_s
  • 9.10 Miscellaneous tapset functions -
  • 9.10.1 addr_to_node + HREF="node11.html#SECTION0001111000000000000000">9.11 Miscellaneous tapset functions +
    -
  • 10 For Further Reference
  • Index + HREF="node12.html">10 For Further Reference
  • Index +
  • About this document ... diff --git a/langref/labels.pl b/langref/labels.pl index 56e0bd10..a47092fc 100644 --- a/langref/labels.pl +++ b/langref/labels.pl @@ -126,7 +126,7 @@ $external_latex_labels{$key} = q|3.2|; $noresave{$key} = "$nosave"; $key = q/sub:user_string/; -$external_latex_labels{$key} = q|9.3.2|; +$external_latex_labels{$key} = q|9.4.2|; $noresave{$key} = "$nosave"; $key = q/sub:Optional-probe-points/; diff --git a/langref/langref.html b/langref/langref.html index ce23f9f2..d998af8f 100644 --- a/langref/langref.html +++ b/langref/langref.html @@ -370,7 +370,7 @@ Fifth Floor, Boston, MA 02110-1301, USA. HREF="node11.html#SECTION0001111100000000000000">9.1.11 warn
  • 9.2 Task context at the probe point + HREF="node11.html#SECTION000112000000000000000">9.2 Context at the probe point
  • 9.2.23 task_cpu + HREF="node11.html#SECTION000113000000000000000">9.3 Task data + + HREF="node11.html#SECTION0001131400000000000000">9.3.14 task_open_file_handles
  • 9.3 Accessing string data at a probe point -
  • 9.3.1 kernel_string + HREF="node11.html#SECTION000114000000000000000">9.4 Accessing string data at a probe point + + HREF="node11.html#SECTION000114400000000000000">9.4.4 user_string_warn
  • 9.4 Initializing queue statistics -
  • 9.4.1 qs_wait + HREF="node11.html#SECTION000115000000000000000">9.5 Initializing queue statistics + + HREF="node11.html#SECTION000115200000000000000">9.5.2 qs_run
  • 9.5 Using queue statistics -
  • 9.5.1 qsq_blocked + HREF="node11.html#SECTION000116000000000000000">9.6 Using queue statistics + + HREF="node11.html#SECTION000116800000000000000">9.6.8 qsq_wait_time
  • 9.6 Probe point identification -
  • 9.6.1 pp + HREF="node11.html#SECTION000117000000000000000">9.7 Probe point identification + + HREF="node11.html#SECTION000117200000000000000">9.7.2 probefunc
  • 9.7 Formatting functions -
  • 9.7.1 ctime + HREF="node11.html#SECTION000118000000000000000">9.8 Formatting functions + + HREF="node11.html#SECTION000118400000000000000">9.8.4 thread_indent
  • 9.8 String functions -
  • 9.8.1 isinstr + HREF="node11.html#SECTION000119000000000000000">9.9 String functions + + HREF="node11.html#SECTION000119600000000000000">9.9.6 text_strn
  • 9.9 Timestamps -
  • 9.9.1 get_cycles + HREF="node11.html#SECTION0001110000000000000000">9.10 Timestamps + + HREF="node11.html#SECTION0001110400000000000000">9.10.4 gettimeofday_s
  • 9.10 Miscellaneous tapset functions -
  • 9.10.1 addr_to_node + HREF="node11.html#SECTION0001111000000000000000">9.11 Miscellaneous tapset functions +
    -
  • 10 For Further Reference
  • Index + HREF="node12.html">10 For Further Reference
  • Index +
  • About this document ... diff --git a/langref/node1.html b/langref/node1.html index ac6f2fbd..2b4f1cf5 100644 --- a/langref/node1.html +++ b/langref/node1.html @@ -26,26 +26,26 @@ original version by: Nikos Drakos, CBLU, University of Leeds - next - up - previous - index
    - Next: Next: List of Tables - Up: Up: SystemTap Language Reference - Previous: Previous: SystemTap Language Reference -   Index

    @@ -58,170 +58,172 @@ Contents diff --git a/langref/node10.html b/langref/node10.html index 0c54cf2f..ec52ec38 100644 --- a/langref/node10.html +++ b/langref/node10.html @@ -26,31 +26,31 @@ original version by: Nikos Drakos, CBLU, University of Leeds - next - up - previous - contents - index
    - Next: Next: 9 Predefined functions - Up: Up: SystemTap Language Reference - Previous: Previous: 7 Associative arrays -   Contents   Contents +   Index

    @@ -59,31 +59,31 @@ original version by: Nikos Drakos, CBLU, University of Leeds Subsections @@ -105,7 +105,7 @@ individually or as elements of an array.

    8.1 The aggregation (< < <) operator

    - + The aggregation operator is ``< < <'', and its effect is similar to an assignment or a C++ output streaming operation. The left operand specifies a scalar or array-index l-value, which @@ -135,7 +135,7 @@ For each instance of a distinct extraction function operating on a given identifier, the translator computes a set of statistics. With each execution of an extraction function, the aggregation is computed for that moment across all processors. The first argument of each function is the same style of -l-value as used on the left side of the accumulate operation. +l-value as used on the left side of the aggregation operation.

    @@ -144,7 +144,7 @@ l-value as used on the left side of the accumulate operation.

    -The following functions give methods to extract information about integer +The following functions provide methods to extract information about integer values.

    @@ -199,7 +199,7 @@ This statement returns the average of all values accumulated into s.
    8.4 Histogram extractors -The following functions give methods to extract histogram information. +The following functions provide methods to extract histogram information.

    @@ -209,8 +209,27 @@ The following functions give methods to extract histogram information. 8.4.1 @hist_linear The statement @hist_linear(v,L,H,W) represents a linear histogram -v whose low, high, and width parameters are given by the following -three literal numbers L, H, W. +v, where L and H represent the lower and upper end of +a range of values and W represents the width (or size) of each bucket +within the range. The low and high values can be negative, but the overall +difference (high minus low) must be positive. The width parameter must also +be positive. + +

    +In the output, a range of consecutive empty buckets may be replaced with a tilde +(~) character. This can be controlled on the command line +with -DHIST_ELISION=< num> , +where < num> specifies how many +empty buckets at the top and bottom of the range to print. +The default is 2. A < num> of 0 +removes all empty buckets. A negative < num> +turns off bucket removal all together. + +

    +For example, if you specify -DHIST_ELISION=3 and the histogram has 10 +consecutive empty buckets, the first 3 and last 3 empty buckets will +be printed and the middle 4 empty buckets will be represented by a +tilde (~).

    The following is an example. @@ -237,28 +256,34 @@ probe end { 

     value |-------------------------------------------------- count
-    0 |                                                    258
-  200 |                                                      3
+    0 |@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 1650
+  200 |                                                      8
   400 |                                                      0
-  600 |                                                      1
-  800 |                                                      2
- 1000 |                                                      4
- 1200 |                                                      1
- 1400 |@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ 16685
+  600 |                                                      0
+      ~
+ 1000 |                                                      0
+ 1200 |                                                      0
+ 1400 |                                                      1
  1600 |                                                      0
  1800 |                                                      0
    - +This shows that 1650 network reads were of a size between 0 and 200 bytes, +8 reads were between 200 and 400 bytes, and 1 read was between +1200 and 1400 bytes. The tilde (~) character indicates +buckets 700, 800 and 900 were removed because they were empty. +Empty buckets at the upper end were also removed. +

    - +
    8.4.2 @hist_log

    -The statement @hist_log(v,N) represents a base-2 logarithmic histogram -with the given number of buckets. N may be omitted, and defaults to 64. +The statement @hist_log(v) represents a base-2 logarithmic +histogram. Empty buckets are replaced with a tilde (~) +character in the same way as @hist_linear() (see above).

    The following is an example. @@ -301,31 +326,31 @@ value |-------------------------------------------------- count

    - next - up - previous - contents - index
    - Next: Next: 9 Predefined functions - Up: Up: SystemTap Language Reference - Previous: Previous: 7 Associative arrays -   Contents   Contents +   Index diff --git a/langref/node11.html b/langref/node11.html index 8aaa7c06..0edf8d43 100644 --- a/langref/node11.html +++ b/langref/node11.html @@ -26,31 +26,31 @@ original version by: Nikos Drakos, CBLU, University of Leeds - next - up - previous - contents - index
    - Next: Next: 10 For Further Reference - Up: Up: SystemTap Language Reference - Previous: Previous: 8 Statistics (aggregates) -   Contents   Contents +   Index

    @@ -59,230 +59,235 @@ original version by: Nikos Drakos, CBLU, University of Leeds Subsections