From d706e984ee8c60d278859a15c74b5a60829789f7 Mon Sep 17 00:00:00 2001 From: ddomingo Date: Wed, 5 Nov 2008 10:35:18 +1000 Subject: proofreading run 1 --- .../en-US/CrossInstrumenting.xml | 30 ++++--------- .../en-US/Installation.xml | 50 +++++++++------------- .../en-US/Introduction.xml | 9 +++- .../en-US/Useful_Scripts-inodewatch.xml | 3 ++ 4 files changed, 39 insertions(+), 53 deletions(-) (limited to 'doc') diff --git a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml index a16e4f48..8a772f15 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/CrossInstrumenting.xml @@ -23,22 +23,11 @@ - Normally, however, SystemTap scripts can only be run on systems where - SystemTap is deployed (as in ). This could - mean that if you want to run SystemTap on ten systems, you would need to - deploy SystemTap on all 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 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 ). This could mean that if you want to run SystemTap on ten systems, you would need to deploy SystemTap on all 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. - To work around this, you can resort to - cross-instrumentation. Cross-instrumentation is the - process of generating SystemTap instrumentation module from a SystemTap - script on one computer to be used on another computer. This process offers - the following benefits: + To work around this, you can resort to cross-instrumentation. Cross-instrumentation is the process of generating SystemTap instrumentation module from a SystemTap script on one computer to be used on another computer. This process offers the following benefits: @@ -186,10 +175,9 @@ appropriate values): - - stap -r kernel_version script -m - module_name - + +stap -r kernel_version script -m module_name + Here, kernel_version refers to @@ -214,9 +202,9 @@ it to the target system and load it using: - - staprun module_name.ko - + +staprun module_name.ko + For example, to create the instrumentation module @@ -249,7 +237,7 @@ The host system must be the same architecture and running the same distribution of Linux as the target - system in order for the instrumentation + system in order for the built instrumentation module to work. diff --git a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml index f2c0cd92..80ee8bd7 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Installation.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Installation.xml @@ -121,42 +121,34 @@ - If the yum-utils package is installed on the computer and has access to - the yum repositories, - the stapprep.sh script can be run - by root to download and install the needed kernel packages via - yum and rpm commands. Thus, the - system administrator should be able to install the needed RPMs with the - script on the machine: + If the yum-utils package is installed and the yum repositories are set up properly, you can run the script as root. will automatically download and install the required packages via yum and rpm commands (assuming that the kernel you wish to probe is currently loaded). - - ./stapprep.sh - - - If yum 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: - - - + + If you do not have yum installed and you are unable to install it, you will have to manually download and install the required packages. To generate the URL from which to download the required packages, use the following script: + + + + systemtapurl.sh + + 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" - + + + - - If yum 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: - - + + systemtapurl.sh + + echo -n "Enter nvr of kernel-debuginfo (e.g. 2.6.25-14.fc9.x86_64) " ; \ read NVR; \ BASE=`uname -m` ; \ @@ -165,13 +157,11 @@ VERSION=`echo $NVR | awk -F- '{print $1}'` ; \ RELEASE=`echo $NVR | awk -F- '{print $2}'` ; \ echo "http://kojipkgs.fedoraproject.org/\ packages/kernel/$VERSION/$RELEASE/$BASE/" - - + + + - 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 rpm --force -ivh - package_names. +Once you have manually downloaded the required packages to the machine, install the RPMs by running rpm --force -ivh package_names. diff --git a/doc/SystemTap_Beginners_Guide/en-US/Introduction.xml b/doc/SystemTap_Beginners_Guide/en-US/Introduction.xml index 36dd3c44..dbca02fc 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Introduction.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Introduction.xml @@ -8,11 +8,16 @@ SystemTap is a tracing and probing tool that allows users to study and monitor the activities of the operating system (particularly, the kernel) in fine detail. It provides information similar to the output of tools like netstat, ps, top, and iostat; however, SystemTap is designed to provide more filtering and analysis options for collected information. - + For system administrators, SystemTap can be used as a performance monitoring tool for ∏. It is most useful when other similar tools cannot precisely pinpoint a bottleneck in the system, requiring a deep analysis of kernel activity. In the same manner, application developers can also use SystemTap to monitor, in finer detail, how their application behaves within the Linux system. + + For system administrators, SystemTap can be used as a performance monitoring tool for &PROD2;. It is most useful when other similar tools cannot precisely pinpoint a bottleneck in the system, requiring a deep analysis of kernel activity. In the same manner, application developers can also use SystemTap to monitor, in finer detail, how their application behaves within the Linux system. + + +
Documentation Goals - SystemTap provides the infrastructure to monitor the running Linux kernel for detailed analysis. This can assist administrators and developers in identifying the underlying cause of a performance or functional problem. + SystemTap provides the infrastructure to monitor the running Linux kernel for detailed analysis. This can assist administrators and developers in identifying the underlying cause of a bug or performance problem. Without SystemTap, monitoring the activity of a running kernel would require a tedious instrument, recompile, install, and reboot sequence. SystemTap is designed to eliminate this, allowing users to gather the same information by simply running user-written SystemTap scripts. diff --git a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml index 2ac1366d..e747771b 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Useful_Scripts-inodewatch.xml @@ -27,6 +27,9 @@ no script in examples +need to add references to sources/man pages that explain how "dev_nr = $file->f_dentry->d_inode->i_sb->s_dev" and "($1 << 20 | $2)". + + takes the following information about the file as an argument: -- cgit