summaryrefslogtreecommitdiffstats
path: root/doc/SystemTap_Beginners_Guide/en-US
diff options
context:
space:
mode:
authorddomingo <ddomingo@redhat.com>2008-12-09 10:49:20 +1000
committerddomingo <ddomingo@redhat.com>2008-12-09 10:49:20 +1000
commit10f2abedd8c2569f337c248f428cef60d75d04ea (patch)
tree83e11be520d9f2d4eb43bd57296f13b2ffd643ee /doc/SystemTap_Beginners_Guide/en-US
parenta5f9c6cd906fd8079aeb427db8023913f277cac5 (diff)
downloadsystemtap-steved-10f2abedd8c2569f337c248f428cef60d75d04ea.tar.gz
systemtap-steved-10f2abedd8c2569f337c248f428cef60d75d04ea.tar.xz
systemtap-steved-10f2abedd8c2569f337c248f428cef60d75d04ea.zip
revisions as per wcohen
Diffstat (limited to 'doc/SystemTap_Beginners_Guide/en-US')
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml30
1 files changed, 27 insertions, 3 deletions
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml b/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml
index 9c5e5a9f..987e2b29 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Array-Operations.xml
@@ -173,12 +173,28 @@ foo[tid()] = gettimeofday_s()
<example id="arrayreadingvaluesfrom">
<title>Using Array Values in Simple Computations</title>
<screen>
-foo[tid()] = gettimeofday_s()
delta = gettimeofday_s() - foo[tid()]
</screen>
</example>
<para>
+ This example assumes that the array <command>foo</command> was built using the construct in
+ <xref linkend="arrays-timestampprocessname"/> (from <xref linkend="arrayops-assignvalue"/>). This
+ sets a timestamp that will serve as a <emphasis>reference point</emphasis>, to be used in
+ computing for <literal>delta</literal>.
+</para>
+
+<para>
+ The construct in <xref linkend="arrayreadingvaluesfrom"/> computes a value for the variable
+ <literal>delta</literal> by subtracting the associated value of the key <literal>tid()</literal>
+ from the current <command>gettimeofday_s()</command>. The construct does this by
+ <emphasis>reading</emphasis> the value of <literal>tid()</literal> from the array. This particular
+ construct is useful for determining the time between two events, such as the start and completion
+ of a read operation.
+</para>
+<!--
+
+<para>
In <xref linkend="arrayreadingvaluesfrom"/>, the first statement sets a timestamp associated
with the returned value of the handler function <command>tid()</command> as a
<emphasis>reference point</emphasis>.
@@ -190,6 +206,7 @@ delta = gettimeofday_s() - foo[tid()]
<command>foo[tid()]</command> is <emphasis>read</emphasis> from the array in order to compute
for <literal>delta</literal>.
</para>
+-->
<indexterm>
<primary>reading values from arrays</primary>
@@ -214,8 +231,15 @@ delta = gettimeofday_s() - foo[tid()]
<secondary>reading values from arrays</secondary>
<tertiary>array operations</tertiary>
</indexterm>
-
-<para>In this situation, if the <command><replaceable>index_expression</replaceable></command> cannot find the unique key, it returns a value of 0 (for numerical operations, such as <xref linkend="arrayreadingvaluesfrom"/>) or a null/empty string value (for string operations) by default. </para>
+<note>
+ <title>Note</title>
+<para>
+ If the <command><replaceable>index_expression</replaceable></command> cannot
+ find the unique key, it returns a value of 0 (for numerical operations, such as
+ <xref linkend="arrayreadingvaluesfrom"/>) or a null/empty string value (for string operations) by
+ default.
+</para>
+</note>
</section>
<section id="arrayops-increment">
<title>Incrementing Associated Values</title>