Skip to content

Commit

Permalink
Vale style checks for tuning guide
Browse files Browse the repository at this point in the history
  • Loading branch information
sounix000 committed Jul 13, 2023
1 parent 2f2b98b commit b20d609
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions xml/tuning_oprofile.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
</para>
<para>
It is not necessary to recompile or use wrapper libraries to
use &oprof;. Not even a kernel patch is needed. Usually, when
profiling an application, a small overhead is expected, depending on the
use &oprof;. Not even a kernel patch is needed. When
profiling an application, you can expect a small overhead, depending on the
workload and sampling frequency.
</para>
</abstract>
Expand Down Expand Up @@ -81,7 +81,7 @@

<para>
It is useful to install the <filename>*-debuginfo</filename> package for
the respective application you want to profile. If you want to profile
the respective application you want to profile. To profile
the kernel, you need the <filename>debuginfo</filename> package as well.
</para>
</sect1>
Expand Down Expand Up @@ -145,8 +145,7 @@
</term>
<listitem>
<para>
Converts sample database files from a foreign binary format to the
native format.
Converts sample database files from a foreign binary format to the format specific to the platform.
</para>
</listitem>
</varlistentry>
Expand All @@ -168,14 +167,14 @@
With &oprof;, you can profile both the kernel and applications. When
profiling the kernel, tell &oprof; where to find the
<filename>vmlinuz*</filename> file. Use the <option>--vmlinux</option>
option and point it to <filename>vmlinuz*</filename> (usually in
option and point it to <filename>vmlinuz*</filename> (generally available in
<filename>/boot</filename>). If you need to profile kernel modules,
&oprof; does this by default. However, make sure you read
<link xlink:href="http://oprofile.sourceforge.net/doc/kernel-profiling.html"/>.
</para>

<para>
Applications usually do not need to profile the kernel, therefore you
Most applications do not need to profile the kernel, therefore you
should use the <option>--no-vmlinux</option> option to reduce the amount
of information.
</para>
Expand All @@ -194,7 +193,7 @@
</step>
<step>
<para>
Decide if you want to profile with or without the Linux kernel:
Decide whether to profile with or without the Linux kernel:
</para>
<substeps performance="required">
<step>
Expand Down Expand Up @@ -406,7 +405,7 @@ BR_MISS_PRED_RETIRED: (counter: all))
<option>--session-dir</option>, <command>operf</command> has written its
data to <replaceable>CUR_DIR</replaceable>/oprofile_data/samples/current,
and the reporting tools <command>opreport</command> and
<command>opannotate</command> will look there by default.
<command>opannotate</command> looks there by default.
</para>

<para>
Expand All @@ -429,8 +428,8 @@ BR_MISS_PRED_RETIRED: (counter: all))

<para>
The option <option>--base-dir</option> contains a comma separated list of
paths which is stripped from debug source files. These paths were
searched prior to looking in <option>--search-dirs</option>. The
paths which is stripped from debug source files. These paths are
searched before looking in <option>--search-dirs</option>. The
<option>--search-dirs</option> option is also a comma separated list of
directories to search for source files.
</para>
Expand Down

0 comments on commit b20d609

Please sign in to comment.