aboutsummaryrefslogtreecommitdiffstats
path: root/lib/et/doc/src/et_intro.xml
diff options
context:
space:
mode:
authorHÃ¥kan Mattsson <[email protected]>2010-02-03 08:59:06 +0000
committerErlang/OTP <[email protected]>2010-02-03 08:59:06 +0000
commit43f3482adf5eee657e5ba922733dfff6600c4e14 (patch)
tree7ea7b32a171de1a7690102c403a8a946e8a382a8 /lib/et/doc/src/et_intro.xml
parent768da5a5f6312496b9b8a09cca5ea1d6b89a2c1c (diff)
downloadotp-43f3482adf5eee657e5ba922733dfff6600c4e14.tar.gz
otp-43f3482adf5eee657e5ba922733dfff6600c4e14.tar.bz2
otp-43f3482adf5eee657e5ba922733dfff6600c4e14.zip
OTP-8058 The GUI parts are rewritten to use wxWidgets. Thanks Olle
Mattsson! For the time being it is still possible to use the old GS based version of the tool, but it is deprecated. The wxWidgets based version is started by default. A new tutorial has been added to the documentation. It is based on Jayson Vantuyl's article http://souja.net/2009/04/making-sense-of-erlangs-event-tracer.htm l. The functions et:trace_me/4 and et:trace_me/5 has been introduced in order to replace the deprecated functions et:report_event/4 and et:report_event/5. Hopefully the new names makes it a little more obvious what the intended usage of the functions are. A print function has been added to the GUI, in order to enable printing of sequence charts. More functionality for hiding unwanted events has been added to the GUI. The max_events, hide_unknown and display_mode configuration parameters to et_viewer is not used any more. Now the event cache in the Viewer only contains those events that actually are displayed in the GUI.
Diffstat (limited to 'lib/et/doc/src/et_intro.xml')
-rw-r--r--lib/et/doc/src/et_intro.xml82
1 files changed, 53 insertions, 29 deletions
diff --git a/lib/et/doc/src/et_intro.xml b/lib/et/doc/src/et_intro.xml
index 8dfa678b11..0c5fb14d55 100644
--- a/lib/et/doc/src/et_intro.xml
+++ b/lib/et/doc/src/et_intro.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2002</year><year>2009</year>
+ <year>2002</year><year>2010</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -13,12 +13,12 @@
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
-
+
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
-
+
</legalnotice>
<title>Introduction</title>
@@ -31,65 +31,89 @@
<rev>%VSN%</rev>
<file>et_intro.xml</file>
</header>
- <p>The Event Tracer (ET) uses the built-in trace mechanism in Erlang
- and provides tools for collection and graphical viewing of trace
- data.</p>
- <p>The viewed trace data is normally collected from Erlang trace ports
- or files.</p>
+
+ <p>The <c>Event Tracer (ET)</c> uses the built-in trace mechanism in
+ Erlang and provides tools for collection and graphical viewing of
+ trace data.</p>
+
+ <p>The viewed trace data is normally collected from Erlang trace
+ ports or files.</p>
<section>
- <title>Scope and Purpose</title>
- <p>This manual describes the Event Tracer (ET) application, as a component
- of the Erlang/Open Telecom Platform development environment. It
- is assumed that the reader is familiar with the Erlang
- Development Environment, which is described in a separate User's
- Guide.</p>
+ <title>Scope and Purpose</title>'
+
+ <p>This manual describes the <c>Event Tracer (ET)</c> application,
+ as a component of the Erlang/Open Telecom Platform development
+ environment. It is assumed that the reader is familiar with the
+ Erlang Development Environment, which is described in a separate
+ User's Guide.</p>
</section>
<section>
<title>Prerequisites</title>
+
<p>The following prerequisites is required for understanding the
- material in the Event Tracer (ET) User's Guide:</p>
+ material in the <c>Event Tracer (ET)</c> User's Guide:</p>
+
<list type="bulleted">
<item>
- <p>familiarity with the Erlang system and Erlang programming in
- general and the especially the art of Erlang tracing.</p>
+ <p>familiarity with the Erlang system and Erlang programming
+ in general and the especially the art of Erlang tracing.</p>
</item>
</list>
- <p>The application requires Erlang/OTP release R7B or later.</p>
+
+ <p>The application requires Erlang/OTP release R13BB or later. If
+ you use the old <c>GS</c> based GUI it does suffice with R7B.</p>
+
</section>
<section>
<title>About This Manual</title>
- <p>In addition to this introductory chapter, the Megaco User's
- Guide contains the following chapters:</p>
+
+ <p>In addition to this introductory chapter, the <c>Event
+ Tracers</c> User's Guide contains the following chapters:</p>
+
<list type="bulleted">
<item>
- <p>Chapter 2: "Usage" describes the architecture
- and typical usage of the application.</p>
+ <p>Chapter 2: "Tutorial" provides a walk-through of the
+ various parts of the application. The tutorial is based on
+ <c>Jayson Vantuyl's</c> article
+ <c>http://souja.net/2009/04/making-sense-of-erlangs-event-tracer.html</c>.</p>
+ </item>
+
+ <item>
+ <p>Chapter 3: "Description" describes the architecture and typical
+ usage of the application.</p>
</item>
+
<item>
- <p>Chapter 3: "Examples" gives some usage examples</p>
+ <p>Chapter 4: "Advanced examples" gives some usage examples</p>
</item>
</list>
+
</section>
<section>
<title>Where to Find More Information</title>
+
<p>Refer to the following documentation for more information about
- Event Tracer (ET) and about the Erlang/OTP development system:</p>
+ <c>Event Tracer (ET)</c> and about the Erlang/OTP development system:</p>
+
<list type="bulleted">
<item>
<p>the Reference Manual of the <c>Event Tracer (ET)</c>.</p>
</item>
+
<item>
- <p>documentation of basic tracing in <c>erlang:trace/4</c> and
- <c>erlang:trace_pattern/3</c> and then the utilities derived from
- these: <c>dbg</c>, <c>observer</c> and <c>et</c>.</p>
+ <p>documentation of basic tracing in <c>erlang:trace/4</c> and
+ <c>erlang:trace_pattern/3</c> and then the utilities derived
+ from these: <c>dbg</c>, <c>observer</c>, <c>invisio</c> and
+ <c>et</c>.</p>
</item>
+
<item>
- <p>Concurrent Programming in Erlang, 2nd Edition (1996),
- Prentice-Hall, ISBN 0-13-508301-X.</p>
+ <p>Programming Erlang: Software for a Concurrent World by Joe
+ Armstrong; ISBN: 978-1-93435-600-5</p>
</item>
</list>
</section>