From c7415f95827be9b6bee3e635d0118231cdd8b638 Mon Sep 17 00:00:00 2001 From: ddomingo Date: Wed, 1 Oct 2008 09:29:07 +1000 Subject: removed brackets in replaceables, my mistake --- .../en-US/CrossInstrumenting.xml | 6 ++-- doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 32 +++++++++++----------- .../en-US/Using_SystemTap.xml | 16 +++++------ 3 files changed, 27 insertions(+), 27 deletions(-) (limited to 'doc/SystemTap_Beginners_Guide/en-US') 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 To build the instrumentation module, run the following command on the host system (be sure to specify the appropriate values): -stap -r [kernel version] [script] -m [module name] +stap -r kernel version script -m module name -Here, [kernel version] refers to the version of target kernel (including the architecture notation), [script] refers to the script to be converted into an instrumentation module, and [instrumentation name] is the desired name of the instrumentation module. +Here, kernel version refers to the version of target kernel (including the architecture notation), script refers to the script to be converted into an instrumentation module, and instrumentation name is the desired name of the instrumentation module. Note @@ -124,7 +124,7 @@ enabled=1 Once the the instrumentation moduleis compiled, copy it to the target system and load it using: -staprun [instrumentation] +staprun instrumentation For example, to create the instrumentation module module.ko from the SystemTap script script.stp for the target kernel 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 @@ -probe [event], -[another event] +probe event, +another event { - [handler] + handler exit() } @@ -66,7 +66,7 @@ probe [event], - kernel.function("[function]") + kernel.function("function") The entry to the kernel function function. For example, kernel.function("sys_open") refers to the "event" that occurs when the kernel function sys_open is called by any thread in the system. To specify the return of the kernel function sys_open, append the return string to the event statement; i.e. kernel.function("sys_open").return. @@ -83,16 +83,16 @@ probe kernel.function("*@net/socket.c").return { } - syscall.[system_call] + syscall.system_call - The entry to the system call [system_call]. Similar to kernel.function, appending a return to the statement specifies the exit of the system call. For example, to specify the entry of the system call close, use syscall.close.return. + The entry to the system call system_call. Similar to kernel.function, appending a return to the statement specifies the exit of the system call. For example, to specify the entry of the system call close, use syscall.close.return. To identify what system calls are made by a specific program/command, use strace command. - module("[module]").function("[function]") + module("module").function("function") Allows you to probe functions within modules. For example: @@ -108,7 +108,7 @@ probe kernel.function("*@net/socket.c").return { } - A system's loaded modules are typically located in /lib/modules/[kernel version], where kernel version refers to the currently loaded kernel. Modules use the filename extension .ko. + A system's loaded modules are typically located in /lib/modules/kernel version, where kernel version refers to the currently loaded kernel. Modules use the filename extension .ko. @@ -160,15 +160,15 @@ probe timer.ms(4000) -timer.s([seconds]) +timer.s(seconds) -timer.us([microseconds]) +timer.us(microseconds) -timer.ns([nanoseconds]) +timer.ns(nanoseconds) -timer.hz([hertz]) +timer.hz(hertz) -timer.jiffies([jiffies]) +timer.jiffies(jiffies) @@ -238,11 +238,11 @@ probe begin -printf ("[format string]\n", [argument]) +printf ("format string\n", argument) - The [format string] region specifies how [argument] should be displayed. The format string of simply instructs SystemTap to print hello world, and contains no arguments. + The format string region specifies how argument should be displayed. The format string of simply instructs SystemTap to print hello world, and contains no arguments. @@ -411,7 +411,7 @@ probe kernel.function("*@net/socket.c").return