← Back to branch summary

~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

Viewing changes to lib/et/doc/src/et_intro.xml

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2011-05-05 15:48:43 UTC
  • mfrom: (3.5.13 sid)
  • Revision ID: james.westby@ubuntu.com-20110505154843-0om6ekzg6m7ugj27
Tags: 1:14.b.2-dfsg-3ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Drop libwxgtk2.8-dev build dependency. Wx isn't in main, and not
    supposed to.
  - Drop erlang-wx binary.
  - Drop erlang-wx dependency from -megaco, -common-test, and -reltool, they
    do not really need wx. Also drop it from -debugger; the GUI needs wx,
    but it apparently has CLI bits as well, and is also needed by -megaco,
    so let's keep the package for now.
  - debian/patches/series: Do what I meant, and enable build-options.patch
    instead.
* Additional changes:
  - Drop erlang-wx from -et
* Dropped Changes:
  - patches/pcre-crash.patch: CVE-2008-2371: outer level option with
    alternatives caused crash. (Applied Upstream)
  - fix for ssl certificate verification in newSSL: 
    ssl_cacertfile_fix.patch (Applied Upstream)
  - debian/patches/series: Enable native.patch again, to get stripped beam
    files and reduce the package size again. (build-options is what
    actually accomplished this)
  - Remove build-options.patch on advice from upstream and because it caused
    odd build failures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/et/doc/src/et_intro.xml
4
4
<chapter>
5
5
  <header>
6
6
    <copyright>
7
 
      <year>2002</year><year>2009</year>
 
7
      <year>2002</year><year>2010</year>
8
8
      <holder>Ericsson AB. All Rights Reserved.</holder>
9
9
    </copyright>
10
10
    <legalnotice>
13
13
      compliance with the License. You should have received a copy of the
14
14
      Erlang Public License along with this software. If not, it can be
15
15
      retrieved online at http://www.erlang.org/.
16
 
    
 
16
 
17
17
      Software distributed under the License is distributed on an "AS IS"
18
18
      basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
19
19
      the License for the specific language governing rights and limitations
20
20
      under the License.
21
 
    
 
21
 
22
22
    </legalnotice>
23
23
 
24
24
    <title>Introduction</title>
31
31
    <rev>%VSN%</rev>
32
32
    <file>et_intro.xml</file>
33
33
  </header>
34
 
  <p>The Event Tracer (ET) uses the built-in trace mechanism in Erlang
35
 
    and provides tools for collection and graphical viewing of trace
36
 
    data.</p>
37
 
  <p>The viewed trace data is normally collected from Erlang trace ports
38
 
    or files.</p>
 
34
 
 
35
  <p>The <c>Event Tracer (ET)</c> uses the built-in trace mechanism in
 
36
  Erlang and provides tools for collection and graphical viewing of
 
37
  trace data.</p>
 
38
 
 
39
  <p>The viewed trace data is normally collected from Erlang trace
 
40
  ports or files.</p>
39
41
 
40
42
  <section>
41
 
    <title>Scope and Purpose</title>
42
 
    <p>This manual describes the Event Tracer (ET) application, as a component
43
 
      of the Erlang/Open Telecom Platform development environment. It
44
 
      is assumed that the reader is familiar with the Erlang
45
 
      Development Environment, which is described in a separate User's
46
 
      Guide.</p>
 
43
    <title>Scope and Purpose</title>'
 
44
    
 
45
    <p>This manual describes the <c>Event Tracer (ET)</c> application,
 
46
    as a component of the Erlang/Open Telecom Platform development
 
47
    environment. It is assumed that the reader is familiar with the
 
48
    Erlang Development Environment, which is described in a separate
 
49
    User's Guide.</p>
47
50
  </section>
48
51
 
49
52
  <section>
50
53
    <title>Prerequisites</title>
 
54
 
51
55
    <p>The following prerequisites is required for understanding the
52
 
      material in the Event Tracer (ET) User's Guide:</p>
 
56
    material in the <c>Event Tracer (ET)</c> User's Guide:</p>
 
57
 
53
58
    <list type="bulleted">
54
59
      <item>
55
 
        <p>familiarity with the Erlang system and Erlang programming in
56
 
          general and the especially the art of Erlang tracing.</p>
 
60
        <p>familiarity with the Erlang system and Erlang programming
 
61
        in general and the especially the art of Erlang tracing.</p>
57
62
      </item>
58
63
    </list>
59
 
    <p>The application requires Erlang/OTP release R7B or later.</p>
 
64
 
 
65
    <p>The application requires Erlang/OTP release R13BB or later. If
 
66
    you use the old <c>GS</c> based GUI it does suffice with R7B.</p>
 
67
 
60
68
  </section>
61
69
 
62
70
  <section>
63
71
    <title>About This Manual</title>
64
 
    <p>In addition to this introductory chapter, the Megaco User's
65
 
      Guide contains the following chapters:</p>
 
72
 
 
73
    <p>In addition to this introductory chapter, the <c>Event
 
74
    Tracers</c> User's Guide contains the following chapters:</p>
 
75
 
66
76
    <list type="bulleted">
67
77
      <item>
68
 
        <p>Chapter 2: "Usage" describes the architecture
69
 
          and typical usage of the application.</p>
70
 
      </item>
71
 
      <item>
72
 
        <p>Chapter 3: "Examples" gives some usage examples</p>
 
78
        <p>Chapter 2: "Tutorial" provides a walk-through of the
 
79
        various parts of the application. The tutorial is based on
 
80
        <c>Jayson Vantuyl's</c> article
 
81
        <c>http://souja.net/2009/04/making-sense-of-erlangs-event-tracer.html</c>.</p>
 
82
      </item>
 
83
 
 
84
      <item>
 
85
        <p>Chapter 3: "Description" describes the architecture and typical
 
86
        usage of the application.</p>
 
87
      </item>
 
88
 
 
89
      <item>
 
90
        <p>Chapter 4: "Advanced examples" gives some usage examples</p>
73
91
      </item>
74
92
    </list>
 
93
 
75
94
  </section>
76
95
 
77
96
  <section>
78
97
    <title>Where to Find More Information</title>
 
98
 
79
99
    <p>Refer to the following documentation for more information about
80
 
      Event Tracer (ET) and about the Erlang/OTP development system:</p>
 
100
    <c>Event Tracer (ET)</c> and about the Erlang/OTP development system:</p>
 
101
 
81
102
    <list type="bulleted">
82
103
      <item>
83
104
        <p>the Reference Manual of the <c>Event Tracer (ET)</c>.</p>
84
105
      </item>
 
106
 
85
107
      <item>
86
 
        <p>documentation of basic tracing in <c>erlang:trace/4</c> and 
87
 
          <c>erlang:trace_pattern/3</c> and then the utilities derived from
88
 
          these: <c>dbg</c>, <c>observer</c> and <c>et</c>.</p>
 
108
        <p>documentation of basic tracing in <c>erlang:trace/4</c> and
 
109
        <c>erlang:trace_pattern/3</c> and then the utilities derived
 
110
        from these: <c>dbg</c>, <c>observer</c>, <c>invisio</c> and
 
111
        <c>et</c>.</p>
89
112
      </item>
 
113
 
90
114
      <item>
91
 
        <p>Concurrent Programming in Erlang, 2nd Edition (1996),
92
 
          Prentice-Hall, ISBN 0-13-508301-X.</p>
 
115
        <p>Programming Erlang: Software for a Concurrent World by Joe
 
116
        Armstrong; ISBN: 978-1-93435-600-5</p>
93
117
      </item>
94
118
    </list>
95
119
  </section>