OpenSolaris

Printable Version Enter a New Search
Bug ID 6451295
Synopsis S10U2: doc bugs in DTRCUG (819-5488-10)
State 6-Fix Understood (Fix is known)
Category:Subcategory doc:dtrace
Keywords DTRCUG | SOL10U2ja
Responsible Engineer Paul Echeverri
Reported Against
Duplicate Of
Introduced In
Commit to Fix s10u6_fcs
Fixed In
Release Fixed
Related Bugs
Submit Date 21-July-2006
Last Update Date 28-July-2008
Description
Reporting doc bugs in DTrace User Guide (819-5488-10)

[DTRCUG.book]
1.
The incorrect <programlisting> with <emphasis role="strong"> tags 
are used for many examples of user input in Chapter 2, 3 and 4. 
They should be changed to the <screen> with <userinput> tags like 
Example 2-14 or 3-3. 
The difference of both tags is apparent on docs.sun.com, not on PDF.

For example:
----------------------------------------------------------
<programlisting># <emphasis role="strong">dtrace -l</emphasis>
	...
</programlisting>
----------------------------------------------------------
This should be:
----------------------------------------------------------
<screen># <userinput>dtrace -l</userinput>
	...
</screen>
----------------------------------------------------------

2.
In "DTrace Action Basics" in Chapter 2, the olink definition is 
incomplete in the following sentence.
----------------------------------------------------------
For a complete list of the built-in variables of 
the D scripting language, see <olink>Variables</olink>. 
----------------------------------------------------------

3.
In the section "Data Recording Actions" of Chapter 2,
some description of the "The tracemem() function" is not clear.

Syntax:
----------------------------------------------------------
void tracemem(address, size_t nbytes)
----------------------------------------------------------

----------------------------------------------------------
The address that the data is copied from is specified 
in addr as a D expression.
----------------------------------------------------------
--> "addr" seems to be "address" in accordance with the syntax.

----------------------------------------------------------
The buffer that the data is copied to is specified 
in buf.
----------------------------------------------------------
--> cannot find the "buf" in the syntax
Work Around
N/A
Comments
N/A