Fix some minor problems in DTrace chapter, found during its translation

earlier:
- CTF stands for "Compact C Type Format" and not for "Compressed" [1]
- Optimize <ulink> elements
- Correct <screen> elements
- Add a missing <acronym> markup for CTF
- Mark up read() system call with <function>

Reviewed by:	trhodes

[1] http://www.solarisinternals.com/wiki/index.php/DTrace_Topics_Features#kernel_CTF
This commit is contained in:
Gabor Pali 2008-10-10 15:37:53 +00:00
parent be00b9d372
commit 1a43757747
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=33029

View file

@ -114,7 +114,7 @@ that might make this chapter too large.
<para>There is a <literal>DDB_CTF</literal> kernel option which
is used to enable support for loading the <acronym>CTF</acronym>
data from kernel modules and the kernel itself.
<acronym>CTF</acronym> is the &solaris; Compressed C Type format
<acronym>CTF</acronym> is the &solaris; Compact C Type Format
which encapsulates a reduced form of debugging information
similar to <acronym>DWARF</acronym> and the venerable stabs.
This <acronym>CTF</acronym> data is added to the binaries by the
@ -143,8 +143,7 @@ that might make this chapter too large.
and Distribution License</literal> comes with &os;, see the
<filename>/usr/src/cddl/contrib/opensolaris/OPENSOLARIS.LICENSE</filename>
or view it online at
<ulink url="http://www.opensolaris.org/os/licensing">
http://www.opensolaris.org/os/licensing</ulink>.</para>
<ulink url="http://www.opensolaris.org/os/licensing"></ulink>.</para>
<para>This license means that a &os; kernel with the DTrace options
is still <acronym>BSD</acronym> licensed; however the
@ -172,14 +171,14 @@ options DDB_CTF</programlisting>
will be limited support for function boundary tracing.</para>
</note>
<para>All sources must be rebuilt and installed with CTF options.
<para>All sources must be rebuilt and installed with <acronym>CTF</acronym> options.
To accomplish this task, rebuild the &os; sources using:</para>
<screen>&prompt.root; <userinput>cd /usr/src</userinput>
&prompt.root; <userinput>make WITH_CTF=1 buildworld</userinput>
&prompt.root; <userinput>make WITH_CFT=1 kernel</userinput>
&prompt.root; <userinput>make WITH_CFT=1 installworld</userinput>
&prompt.root; <userinput>mergemaster -Ui</userinput></screen>
&prompt.root; <userinput>make WITH_CTF=1 buildworld</userinput>
&prompt.root; <userinput>make WITH_CFT=1 kernel</userinput>
&prompt.root; <userinput>make WITH_CFT=1 installworld</userinput>
&prompt.root; <userinput>mergemaster -Ui</userinput></screen>
<para>The system will need to be restarted.</para>
@ -194,8 +193,7 @@ options DDB_CTF</programlisting>
<para>Finally, obtain the current DTrace toolkit. The current
version is available at
<ulink url="http://www.opensolaris.org/os/community/dtrace/dtracetoolkit/">
http://www.opensolaris.org/os/community/dtrace/dtracetoolkit/</ulink>.
<ulink url="http://www.opensolaris.org/os/community/dtrace/dtracetoolkit/"></ulink>.
There is an install mechanism included; however, installation
is not required to make use of the bundled utilities.</para>
</sect1>
@ -260,7 +258,6 @@ options DDB_CTF</programlisting>
will produce output similar to the following:</para>
<screen>&prompt.root; <userinput>./hotkernel</userinput>
localhost# ./hotkernel
Sampling... Hit Ctrl-C to end.</screen>
<para>The system administrator must use the
@ -304,9 +301,7 @@ kernel`sched_idletd 137 0.3%
<para>This script will also work with kernel modules. To use this
feature, run the script with the <option>-m</option> flag:</para>
<screen>&prompt.root; <userinput>./hotkernel -m</userinput></screen>
<screen>localhost# <userinput>./hotkernel -m</userinput>
<screen>&prompt.root; <userinput>./hotkernel -m</userinput>
Sampling... Hit Ctrl-C to end.
^C
MODULE COUNT PCNT
@ -362,7 +357,7 @@ Elapsed Times for processes csh,
sigsuspend 6985124
read 3988049784</screen>
<para>As shown, the read system call seems to use the
<para>As shown, the <function>read()</function> system call seems to use the
most time in nanoseconds with the <function>getpid()</function>
system call used the least amount of time.</para>
</sect1>