summaryrefslogtreecommitdiffstats
path: root/doc/SystemTap_Beginners_Guide
diff options
context:
space:
mode:
authorddomingo <ddomingo@redhat.com>2008-10-01 09:29:07 +1000
committerddomingo <ddomingo@redhat.com>2008-10-01 09:29:07 +1000
commitc7415f95827be9b6bee3e635d0118231cdd8b638 (patch)
tree9cc7b1124b60fed81d5816aa487274c3ecc82e04 /doc/SystemTap_Beginners_Guide
parent338e2309ef67c7b0d1ac3df852502e55bc316c8a (diff)
downloadsystemtap-steved-c7415f95827be9b6bee3e635d0118231cdd8b638.tar.gz
systemtap-steved-c7415f95827be9b6bee3e635d0118231cdd8b638.tar.xz
systemtap-steved-c7415f95827be9b6bee3e635d0118231cdd8b638.zip
removed brackets in replaceables, my mistake
Diffstat (limited to 'doc/SystemTap_Beginners_Guide')
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml6
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Scripts.xml32
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml16
3 files changed, 27 insertions, 27 deletions
diff --git a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
index cf57f5b2..07280100 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
@@ -113,9 +113,9 @@ enabled=1
<para>To build the <emphasis>instrumentation module</emphasis>, run the following command on the <emphasis>host system</emphasis> (be sure to specify the appropriate values):</para>
-<para><command>stap -r <replaceable>[kernel version]</replaceable> <replaceable>[script]</replaceable> -m <replaceable>[module name]</replaceable></command></para>
+<para><command>stap -r <replaceable>kernel version</replaceable> <replaceable>script</replaceable> -m <replaceable>module name</replaceable></command></para>
-<para>Here, <command><replaceable>[kernel version]</replaceable></command> refers to the version of <emphasis>target kernel</emphasis> (including the architecture notation), <command><replaceable>[script]</replaceable></command> refers to the script to be converted into an <emphasis>instrumentation module</emphasis>, and <command><replaceable>[instrumentation name]</replaceable></command> is the desired name of the <emphasis>instrumentation module</emphasis>.</para>
+<para>Here, <command><replaceable>kernel version</replaceable></command> refers to the version of <emphasis>target kernel</emphasis> (including the architecture notation), <command><replaceable>script</replaceable></command> refers to the script to be converted into an <emphasis>instrumentation module</emphasis>, and <command><replaceable>instrumentation name</replaceable></command> is the desired name of the <emphasis>instrumentation module</emphasis>.</para>
<note>
<title>Note</title>
@@ -124,7 +124,7 @@ enabled=1
<para>Once the the <emphasis>instrumentation module</emphasis>is compiled, copy it to the <emphasis>target system</emphasis> and load it using:</para>
-<para><command>staprun <replaceable>[instrumentation]</replaceable></command></para>
+<para><command>staprun <replaceable>instrumentation</replaceable></command></para>
<para>
For example, to create the <emphasis>instrumentation module</emphasis> <filename>module.ko</filename> from the SystemTap script <filename>script.stp</filename> for the <emphasis>target kernel</emphasis> 2.6.25.9-76.fc9 (on i686 architecture), use the following command:
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
index 160597bf..fec9aee7 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml
@@ -36,11 +36,11 @@
</para>
</formalpara>
<programlisting>
-probe <replaceable>[event]</replaceable>,
-<replaceable>[another event]</replaceable>
+probe <replaceable>event</replaceable>,
+<replaceable>another event</replaceable>
{
- <replaceable>[handler]</replaceable>
+ <replaceable>handler</replaceable>
exit()
}
@@ -66,7 +66,7 @@ probe <replaceable>[event]</replaceable>,
<variablelist>
<varlistentry>
- <term>kernel.function("<replaceable>[function]</replaceable>")</term>
+ <term>kernel.function("<replaceable>function</replaceable>")</term>
<listitem>
<para>The entry to the kernel function <replaceable>function</replaceable>. For example, <command>kernel.function("sys_open")</command> refers to the "event" that occurs when the kernel function <command>sys_open</command> is called by any thread in the system. To specify the <emphasis>return</emphasis> of the kernel function <command>sys_open</command>, append the <command>return</command> string to the event statement; i.e. <command>kernel.function("sys_open").return</command>.</para>
@@ -83,16 +83,16 @@ probe kernel.function("*@net/socket.c").return { }
</varlistentry>
<varlistentry>
- <term>syscall.<replaceable>[system_call]</replaceable></term>
+ <term>syscall.<replaceable>system_call</replaceable></term>
<listitem>
- <para>The entry to the system call <replaceable>[system_call]</replaceable>. Similar to <command>kernel.function</command>, appending a <command>return</command> to the statement specifies the exit of the system call. For example, to specify the entry of the system call <command>close</command>, use <command>syscall.close.return</command>.</para>
+ <para>The entry to the system call <replaceable>system_call</replaceable>. Similar to <command>kernel.function</command>, appending a <command>return</command> to the statement specifies the exit of the system call. For example, to specify the entry of the system call <command>close</command>, use <command>syscall.close.return</command>.</para>
<para>To identify what system calls are made by a specific program/command, use <command>strace <replaceable>command</replaceable></command>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>module("<replaceable>[module]</replaceable>").function("<replaceable>[function]</replaceable>")</term>
+ <term>module("<replaceable>module</replaceable>").function("<replaceable>function</replaceable>")</term>
<listitem>
<para>Allows you to probe functions within modules. For example:</para>
@@ -108,7 +108,7 @@ probe kernel.function("*@net/socket.c").return { }
</para>
<para>
- A system's loaded modules are typically located in <filename>/lib/modules/<replaceable>[kernel version]</replaceable></filename>, where <replaceable>kernel version</replaceable> refers to the currently loaded kernel. Modules use the filename extension <filename>.ko</filename>.
+ A system's loaded modules are typically located in <filename>/lib/modules/<replaceable>kernel version</replaceable></filename>, where <replaceable>kernel version</replaceable> refers to the currently loaded kernel. Modules use the filename extension <filename>.ko</filename>.
</para>
</listitem>
@@ -160,15 +160,15 @@ probe timer.ms(4000)
</para>
<itemizedlist>
-<listitem><para><command>timer.s(<replaceable>[seconds]</replaceable>)</command></para></listitem>
+<listitem><para><command>timer.s(<replaceable>seconds</replaceable>)</command></para></listitem>
-<listitem><para><command>timer.us(<replaceable>[microseconds]</replaceable>)</command></para></listitem>
+<listitem><para><command>timer.us(<replaceable>microseconds</replaceable>)</command></para></listitem>
-<listitem><para><command>timer.ns(<replaceable>[nanoseconds]</replaceable>)</command></para></listitem>
+<listitem><para><command>timer.ns(<replaceable>nanoseconds</replaceable>)</command></para></listitem>
-<listitem><para><command>timer.hz(<replaceable>[hertz]</replaceable>)</command></para></listitem>
+<listitem><para><command>timer.hz(<replaceable>hertz</replaceable>)</command></para></listitem>
-<listitem><para><command>timer.jiffies(<replaceable>[jiffies]</replaceable>)</command></para></listitem>
+<listitem><para><command>timer.jiffies(<replaceable>jiffies</replaceable>)</command></para></listitem>
</itemizedlist>
<para>
@@ -238,11 +238,11 @@ probe begin
<programlisting>
-printf ("<replaceable>[format string]</replaceable>\n", <replaceable>[argument]</replaceable>)
+printf ("<replaceable>format string</replaceable>\n", <replaceable>argument</replaceable>)
</programlisting>
<para>
- The <replaceable>[format string]</replaceable> region specifies how <replaceable>[argument]</replaceable> should be displayed. The format string of <xref linkend="helloworld"/> simply instructs SystemTap to print <command>hello world</command>, and contains no arguments.
+ The <replaceable>format string</replaceable> region specifies how <replaceable>argument</replaceable> should be displayed. The format string of <xref linkend="helloworld"/> simply instructs SystemTap to print <command>hello world</command>, and contains no arguments.
</para>
<para>
@@ -411,7 +411,7 @@ probe kernel.function("*@net/socket.c").return
<!--
<para>
- <replaceable>[variable]</replaceable> can be either <command>%s</command> for strings, or <command>%d</command> for numbers, depending on the <replaceable>[handler function]</replaceable> used. Each <command>printf ()</command> statement can contain multiple <replaceable>[variable]</replaceable>s, with each one corresponding to a matching <replaceable>[handler function]</replaceable>. Multiple <replaceable>[handler function]</replaceable>s are delimited by comma (<command>,</command>).
+ <replaceable>variable</replaceable> can be either <command>%s</command> for strings, or <command>%d</command> for numbers, depending on the <replaceable>handler function</replaceable> used. Each <command>printf ()</command> statement can contain multiple <replaceable>variable</replaceable>s, with each one corresponding to a matching <replaceable>handler function</replaceable>. Multiple <replaceable>handler function</replaceable>s are delimited by comma (<command>,</command>).
</para>
<command>printf ()</command> is a SystemTap-supported C statement, and can also trap data using a wide variety
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml b/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml
index 01e30fc7..8b851a49 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml
@@ -28,7 +28,7 @@
<formalpara>
<title>Preparing For Installation</title>
<para>
- To view what kernels and kernel versions are installed on your system, check the contents of <filename>/boot</filename>. Each installed kernel/kernel version has a corresponding <filename>vmlinuz-<replaceable>[kernel version]</replaceable></filename> there.
+ To view what kernels and kernel versions are installed on your system, check the contents of <filename>/boot</filename>. Each installed kernel/kernel version has a corresponding <filename>vmlinuz-<replaceable>kernel version</replaceable></filename> there.
</para>
</formalpara>
<para>
@@ -86,7 +86,7 @@ uname -r
</step>
<step>
- <para>Install the debugging RPMs using <command>rpm -ivh <replaceable>[RPM]</replaceable></command> or <command>yum localinstall <replaceable>[RPM]</replaceable></command>.</para>
+ <para>Install the debugging RPMs using <command>rpm -ivh <replaceable>RPM</replaceable></command> or <command>yum localinstall <replaceable>RPM</replaceable></command>.</para>
</step>
<step>
@@ -133,23 +133,23 @@ uname -r
</varlistentry>
<varlistentry>
- <term>-I <replaceable>[directory]</replaceable></term>
+ <term>-I <replaceable>directory</replaceable></term>
<listitem>
- <para>Check the script against additional tapsets found in <command><replaceable>[directory]</replaceable></command>. This is useful if you have additional tapsets that are not included in <filename>/usr/share/systemtap/tapset/</filename>; for more information about tapsets, refer to <xref linkend="understanding-tapsets"/>.</para>
+ <para>Check the script against additional tapsets found in <command><replaceable>directory</replaceable></command>. This is useful if you have additional tapsets that are not included in <filename>/usr/share/systemtap/tapset/</filename>; for more information about tapsets, refer to <xref linkend="understanding-tapsets"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-o <replaceable>[filename]</replaceable></term>
+ <term>-o <replaceable>filename</replaceable></term>
<listitem>
- <para>Sends the standard output to file (<replaceable>[filename]</replaceable>).</para>
+ <para>Sends the standard output to file (<replaceable>filename</replaceable>).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>-e "<replaceable>[script]</replaceable></term>
+ <term>-e "<replaceable>script</replaceable></term>
<listitem>
- <para>Run given <command><replaceable>[script]</replaceable></command>.</para>
+ <para>Run given <command><replaceable>script</replaceable></command>.</para>
</listitem>
</varlistentry>