summaryrefslogtreecommitdiffstats
path: root/doc/SystemTap_Beginners_Guide/en-US
diff options
context:
space:
mode:
authorWilliam Cohen <wcohen@redhat.com>2008-11-04 16:53:01 -0500
committerWilliam Cohen <wcohen@redhat.com>2008-11-04 16:53:01 -0500
commitf207b82a4ffcba90a35ae5b8cf07a1bd19e2be69 (patch)
tree210e5c2dd301b12d8d412b5d15835dfe4bd700c3 /doc/SystemTap_Beginners_Guide/en-US
parentca8bf77efd8ec9de7b8cf746d3ecd14c91a1346c (diff)
downloadsystemtap-steved-f207b82a4ffcba90a35ae5b8cf07a1bd19e2be69.tar.gz
systemtap-steved-f207b82a4ffcba90a35ae5b8cf07a1bd19e2be69.tar.xz
systemtap-steved-f207b82a4ffcba90a35ae5b8cf07a1bd19e2be69.zip
Edit install and cross compile sections. Include scripts to find rpms with yum.
Diffstat (limited to 'doc/SystemTap_Beginners_Guide/en-US')
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml9
-rw-r--r--doc/SystemTap_Beginners_Guide/en-US/Installation.xml68
2 files changed, 48 insertions, 29 deletions
diff --git a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
index 6a91beab..a16e4f48 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
@@ -29,7 +29,7 @@
deploy SystemTap on <emphasis>all</emphasis> those systems. In some cases,
this may be neither feasible nor desired to fully deploy SystemTap on those
systems. For instance corporate policy may prohibit an administrator from
- installing RPMs that proved debug information or compilers on specific
+ installing RPMs that provide compilers or debug information on specific
machines, which will prevent the deployment of SystemTap.
</para>
@@ -37,7 +37,7 @@
To work around this, you can resort to
<firstterm>cross-instrumentation</firstterm>. Cross-instrumentation is the
process of generating SystemTap instrumentation module from a SystemTap
- script on one computer to be used on another machine. This process offers
+ script on one computer to be used on another computer. This process offers
the following benefits:
</para>
@@ -146,7 +146,7 @@
<para>
Determine the kernel running on each <emphasis>target system</emphasis>
by running the by running <command>uname -r</command> on each
- <emphasis>target system</emphasis>:
+ <emphasis>target system</emphasis>.
</para>
</step>
@@ -187,8 +187,7 @@
</para>
<para>
- <command>stap -r <replaceable>kernel_version</replaceable>
- <replaceable>script</replaceable> -m
+ <command>stap -r <replaceable>kernel_version</replaceable> <replaceable>script</replaceable> -m
<replaceable>module_name</replaceable></command>
</para>
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
index 2d5eb98b..f2c0cd92 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
@@ -29,8 +29,8 @@
<title>Important</title> <para>Many users confuse
<filename>-debuginfo</filename> with <filename>-debug</filename>. Remember
that the deployment of SystemTap requires the installation of the
- <filename>-debuginfo</filename> version of the kernel, not the
- <filename>-debug</filename> version. </para>
+ <filename>-debuginfo</filename> package of the kernel, not the
+ <filename>-debug</filename> version of the kernel. </para>
</important>
<section id="installproper">
@@ -46,7 +46,8 @@
</itemizedlist>
<para>Assuming that the computer system has been configured to use Red Hat
- Network (RHN), the two rpms can be installed with <command>yum install
+ Network (RHN) or <command>yum</command> is available,
+ the two rpms can be installed with <command>yum install
systemtap systemtap-runtime</command>. Before you use SystemTap the
additional kernel information will need to be installed as described in
the following section.
@@ -79,7 +80,8 @@
</screen>
<para>For example, if you wish to use SystemTap on kernel version
- <filename>2.6.18-53.el5</filename>, then you would need to download and
+ <filename>2.6.18-53.el5</filename> on an i686 machine,
+ then you would need to download and
install the following RPMs:
</para>
@@ -89,6 +91,17 @@
<listitem><para><filename>kernel-devel-2.6.18-53.1.13.el5.i686.rpm</filename></para></listitem>
</itemizedlist>
+ <important>
+ <title>Important</title>
+
+ <para>
+ The version and architecture of the <filename>-devel</filename>,
+ <filename>-debuginfo</filename> and
+ <filename>-debuginfo-common</filename> packages must match the kernel
+ you wish to probe with SystemTap <emphasis>exactly</emphasis>.
+ </para>
+ </important>
+
<para> The script <xref linkend="stapprep"/> can be used by normal users to
determine what supporting kernel RPMs need to be installed on the
machine to use SystemTap with a particular kernel. The script run
@@ -108,8 +121,9 @@
</formalpara>
<para>
- If the computer has access to Red Hat Network (RHN) and the yum-utils
- package is installed, the <command>stapprep.sh</command> script can be run
+ If the yum-utils package is installed on the computer and has access to
+ the <command>yum</command> repositories,
+ the <command>stapprep.sh</command> script can be run
by root to download and install the needed kernel packages via
<command>yum</command> and <command>rpm</command> commands. Thus, the
system administrator should be able to install the needed RPMs with the
@@ -123,21 +137,10 @@
<filename>rhel-debuginfo</filename>, but this could be changed. One could
search the /etc/yum.repo.d/ directory for debuginfo repositories -->
- <important>
- <title>Important</title>
-
- <para>
- The version and architecture of the <filename>-devel</filename>,
- <filename>-debuginfo</filename> and
- <filename>-debuginfo-common</filename> packages must match the kernel
- you wish to probe with SystemTap <emphasis>exactly</emphasis>.
- </para>
- </important>
-
<para>
- If the <command>yum</command> repsitories are not accessible from the
- machine, the following lines of bash script will generate the URL for
- the Red Hat Enterprise Linux 5 debuginfo RPM directory:
+ If <command>yum</command> is not available on a Red Hat Enterprise Linux
+ 5 machine, the following lines of bash script will generate the URL for
+ the debuginfo RPM directory:
</para>
<screen>
@@ -148,10 +151,27 @@ echo "ftp://ftp.redhat.com/pub/redhat/linux/enterprise/$releasever/en/os/$base"
</screen>
<para>
- The package RPMs can be downloaded on another machine then copied to the
- machine. Once you have downloaded the packages and copied them to the
- machine, install the RPMs by running <command>rpm -ivh
- <replaceable>package names</replaceable></command>.
+ If <command>yum</command> in not available on a Fedora system, the
+ following lines of bash script will generate the URL for the location to
+ find the needed kernel RPMs:
+ </para>
+
+<screen>
+echo -n "Enter nvr of kernel-debuginfo (e.g. 2.6.25-14.fc9.x86_64) " ; \
+read NVR; \
+BASE=`uname -m` ; \
+NVR=`echo $NVR | sed s/.$BASE//` ; \
+VERSION=`echo $NVR | awk -F- '{print $1}'` ; \
+RELEASE=`echo $NVR | awk -F- '{print $2}'` ; \
+echo "http://kojipkgs.fedoraproject.org/\
+packages/kernel/$VERSION/$RELEASE/$BASE/"
+</screen>
+
+ <para>
+ The package RPMs can be manually downloaded and copied to the
+ machine. Once you have manually copied the packages to the
+ machine, install the RPMs by running <command>rpm --force -ivh
+ <replaceable>package_names</replaceable></command>.
</para>
</section>