Minor cleanup of Using Systemtap Chapter and factoring out scripts.

5 files changed, 36 insertions, 28 deletions

diff --git a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
index 5e29307c..3ff3c2d8 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml
@@ -23,7 +23,7 @@
   </para>
 	
   <para>
-    Normally, however, SystemTap scripts can only be run on systems where SystemTap is deployed (as in <xref linkend="installproper"/>). This could mean that if you want to run SystemTap on ten systems, you would need to deploy SystemTap on <emphasis>all</emphasis> those systems.  In some cases, this may be neither feasible nor desired. For instance, corporate policy may prohibit an administrator from installing RPMs that provide compilers or debug information on specific machines, which will prevent the deployment of SystemTap.
+    Normally, however, SystemTap scripts can only be run on systems where SystemTap is deployed (as in <xref linkend="using-setup"/>). This could mean that if you want to run SystemTap on ten systems, you would need to deploy SystemTap on <emphasis>all</emphasis> those systems.  In some cases, this may be neither feasible nor desired. For instance, corporate policy may prohibit an administrator from installing RPMs that provide compilers or debug information on specific machines, which will prevent the deployment of SystemTap.
   </para>
 	
   <para>
@@ -204,8 +204,9 @@ staprun <replaceable>module_name</replaceable>.ko
 </screen>
 
   <para>
-    For example, to create the <emphasis>instrumentation module</emphasis>
-    <filename>simple.ko</filename> from a SystemTap script named
+    For example, to create the
+    <emphasis>instrumentation module</emphasis> <filename>simple.ko</filename>
+    from a SystemTap script named
     <filename>simple.stp</filename> for the <emphasis>target kernel</emphasis>
     2.6.18-92.1.10.el5 (on x86_64 architecture), use the following command:
   </para>
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
index e5384abc..8ba7bdcf 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml
@@ -4,7 +4,7 @@
 
 	
 <section id="using-setup">
-  <title>Setup and Installation</title>
+  <title>Installation and Setup</title>
   <remark>
     required packages, installation thru yum, repos (?); possibly, a script to install all required packages
   </remark>
@@ -107,14 +107,14 @@ uname -r
     <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 without any arguments detemines the RPMs needed for the currently running kernel. The script can also accept one argument, the output <command>uname -r</command>, to determine the related RPMs required for a kernel that may not be currently running on the machine.
     </para>-->
 
-    <formalpara id="stapprep">
-      <title>stapprep.sh</title>
-      <para>
-	<programlisting>
-	  <xi:include parse="text" href="extras/stapprep.sh" xmlns:xi="http://www.w3.org/2001/XInclude" />
-	</programlisting>
-      </para>
-    </formalpara>
+<formalpara id="stapprep">
+<title>stapprep.sh</title>
+<para>
+<programlisting>
+<xi:include parse="text" href="extras/stapprep.sh" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</programlisting>
+</para>
+</formalpara>
 <!--
     <para>
 	    If the <filename>yum-utils</filename> package is installed and the <command>yum</command> repositories are set up properly, you can run the <xref linkend="stapprep"/> script as root. <xref linkend="stapprep"/> will automatically download and install the required packages via <command>yum</command> and <command>rpm</command> commands (assuming that the kernel you wish to probe is currently loaded).
@@ -129,30 +129,20 @@ search the /etc/yum.repo.d/ directory for debuginfo repositories -->
 </para>	
 	
 <formalpara condition="RedHat">
-	<title>systemtapurl.sh</title>
+<title>rheldebugurl.sh</title>
 <para>
 <programlisting>
-pkg=`grep distroverpkg /etc/yum.conf |awk -F= '{print $2}'`
-releasever=`rpm -q --qf "%{version}" $pkg`
-base=`uname -m`
-echo "ftp://ftp.redhat.com/pub/redhat/linux/enterprise/$releasever/en/os/$base"
+<xi:include parse="text" href="extras/rheldebugurl.sh" xmlns:xi="http://www.w3.org/2001/XInclude" />
 </programlisting>
 </para>
 </formalpara>
 
 
 <formalpara condition="fedora">
-	<title>systemtapurl.sh</title>
+<title>fedoradebugurl.sh</title>
 <para>
-	<programlisting>
-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/"
+<programlisting>
+<xi:include parse="text" href="extras/fedoradebugurl.sh" xmlns:xi="http://www.w3.org/2001/XInclude" />
 </programlisting>
 </para>
 </formalpara>
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml b/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml
index 7fc93e8b..f71483d7 100644
--- a/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml
+++ b/doc/SystemTap_Beginners_Guide/en-US/Using_SystemTap.xml
@@ -73,7 +73,9 @@
 <varlistentry>
 	<term>-v</term>
 	<listitem>
-		<para>Makes the output of the SystemTap session more verbose. You can repeat this option to (for example, <command>stap -vvv script.stp</command>); provide more details on the script's execution. This option is particularly useful if you encounter any errors in running the script.</para>
+		<para>Makes the output of the SystemTap session more
+		verbose. You can repeat this option (for example, <command>stap
+		-vvv script.stp</command>) to provide more details on the script's execution. This option is particularly useful if you encounter any errors in running the script.</para>
 		
 		<para>For more information about common SystemTap script errors, refer to <xref linkend="errors"/>.</para>
 	</listitem>	
diff --git a/doc/SystemTap_Beginners_Guide/en-US/extras/fedoradebugurl.sh b/doc/SystemTap_Beginners_Guide/en-US/extras/fedoradebugurl.sh
new file mode 100755
index 00000000..ac6b5251
--- /dev/null
+++ b/doc/SystemTap_Beginners_Guide/en-US/extras/fedoradebugurl.sh
@@ -0,0 +1,9 @@
+#! /bin/bash
+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/"
diff --git a/doc/SystemTap_Beginners_Guide/en-US/extras/rheldebugurl.sh b/doc/SystemTap_Beginners_Guide/en-US/extras/rheldebugurl.sh
new file mode 100755
index 00000000..72b03bcd
--- /dev/null
+++ b/doc/SystemTap_Beginners_Guide/en-US/extras/rheldebugurl.sh
@@ -0,0 +1,6 @@
+#! /bin/bash
+pkg=`grep distroverpkg /etc/yum.conf |awk -F= '{print $2}'`
+releasever=`rpm -q --qf "%{version}" $pkg`
+base=`uname -m`
+echo "ftp://ftp.redhat.com/pub/redhat/linux/\
+enterprise/$releasever/en/os/$base/Debuginfo"