From f46fa047cb2a26795c91f89e3a133fe0431dead3 Mon Sep 17 00:00:00 2001 From: Souvik Sarkar Date: Thu, 13 Jul 2023 17:27:18 +0530 Subject: [PATCH] Vale style checks for tuning guide --- xml/tuning_systemtap.xml | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/xml/tuning_systemtap.xml b/xml/tuning_systemtap.xml index a75697f578..053d77a620 100644 --- a/xml/tuning_systemtap.xml +++ b/xml/tuning_systemtap.xml @@ -30,7 +30,7 @@ examine the activities of a running Linux system, particularly the kernel, in fine detail. &stap; scripts are written in the &stap; scripting language, are then compiled to C-code kernel modules and inserted into the - kernel. The scripts can be designed to extract, filter and summarize data, + kernel. The scripts can be designed to extract, filter, and summarize data, thus allowing the diagnosis of complex performance problems or functional problems. &stap; provides information similar to the output of tools like netstat, ps, @@ -144,7 +144,7 @@ to make it easier for users to define events and functions. Tapsets provide aliases for functions that users could want to specify as an event. Knowing the proper alias is often easier than remembering - specific kernel functions that might vary between kernel versions. + specific kernel functions that may vary between kernel versions. @@ -208,7 +208,7 @@ To avoid giving &rootuser; access to users solely to enable them to work with &stap;, use one of the following &stap; groups. They are not available by default on &productname;, but you can create the groups and modify the - access rights accordingly. Also adjust the permissions of the + access rights accordingly. Also adjust the permissions of the staprun command if the security implications are appropriate for your environment. @@ -274,7 +274,7 @@ - Holds several example &stap; scripts for various purposes. + Holds several example &stap; scripts for different purposes. Only available if the systemtap-docs package is installed. @@ -461,7 +461,7 @@ To get access to the man pages and to a helpful collection of example - &stap; scripts for various purposes, additionally install the + &stap; scripts for different purposes, additionally install the systemtap-docs package. @@ -1240,7 +1240,7 @@ root 4700 4160 0 18:05 ttyS0 00:00:00 grep avahi - Comments can be inserted anywhere in the &stap; script in various + Comments can be inserted anywhere in the &stap; script in different styles: using either #, /* */, or // as marker. @@ -1360,7 +1360,7 @@ root 4700 4160 0 18:05 ttyS0 00:00:00 grep avahi of the specified events occur. - In general, events can be classified into the following categories: + The events can be classified into the following categories: @@ -1454,7 +1454,7 @@ probe EVENT {FUNCTION_NAME Functions can be defined anywhere in the script. They may take any - One of the functions needed very often was already introduced in + One of the functions frequently needed is already introduced in : the printf function for printing data in a formatted way. When using the printf function, you can specify how arguments @@ -1634,8 +1634,7 @@ held(2360) open (%d). - However, by default, variables are local to the probe they are used - in: They are initialized, used and disposed of at each handler + However, by default the variables are local to the probe containing them. They are initialized, used, and disposed of at each handler evocation. To share variables between probes, declare them global anywhere in the script. To do so, use the global keyword outside of the probes: @@ -1670,7 +1669,7 @@ probe timer.ms(12345) Conditional statements There are several conditional statements that you can use in - &stap; scripts. The following are probably the most common: + &stap; scripts. The most common conditional statements are the following: @@ -1710,7 +1709,7 @@ elseSTATEMENT2 while (CONDITION)STATEMENT - As long as condition is non-zero, the statement + While condition is non-zero, the statement is executed. @@ -1869,7 +1868,7 @@ probe kernel.function("tcp_accept").return?, except itrace is supposed to work For debugging user space applications (like DTrace can do), &productname; &productnumber; supports user space probing with - &stap;: Custom probe points can be inserted in any user space + &stap;. Custom probe points can be inserted in any user space application. Thus, &stap; lets you use both kernel space and user space probes to debug the behavior of the whole system. @@ -1889,9 +1888,10 @@ probe kernel.function("tcp_accept").return?, The engines register callback functions for specific events, then attach to whichever thread they want to trace. As the callbacks are made from safe places in the kernel, this allows for great leeway in - the kinds of processing the functions can do. Various events can be - watched via utrace, for example, system call entry and exit, fork(), - signals being sent to the task, etc. More details about the utrace + the kinds of processing the functions can do. Several events can be + watched via utrace. For example, you can observe events such as system call entry and exit, + fork(), and + signals being sent to the task. More details about the utrace infrastructure are available at . @@ -1937,7 +1937,7 @@ probe kernel.function("tcp_accept").return?, - Huge collection of useful information about &stap;, ranging from + A large collection of useful information about &stap;, ranging from detailed user and developer documentation to reviews and comparisons with other tools, or Frequently Asked Questions and tips. Also contains collections of &stap; scripts, examples and usage stories