← 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_selector.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_selector.xml
4
4
<erlref>
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>et_selector</title>
29
29
    <checked></checked>
30
30
    <date></date>
31
31
    <rev>%VSN%</rev>
 
32
    <file>et_selector.xml</file>
32
33
  </header>
33
34
  <module>et_selector</module>
34
35
  <modulesummary>Define event transforms and trace patterns</modulesummary>
35
36
  <description>
36
37
    <p></p>
37
38
  </description>
 
39
  
38
40
  <funcs>
39
41
    <func>
40
42
      <name>make_pattern(RawPattern) -> TracePattern</name>
41
43
      <fsummary>Makes a trace pattern suitable to feed change_pattern/1</fsummary>
 
44
 
42
45
      <type>
43
46
        <v>RawPattern = detail_level()</v>
44
47
        <v>TracePattern = erlang_trace_pattern_match_spec()</v>
45
 
        <v>detail_level() = min | max | integer(X) when X =&lt; 0, X >= 100</v>
 
48
        <v>detail_level() = min | max | integer(X) when X &gt;= 0, X =&lt; 100</v>
46
49
      </type>
 
50
 
47
51
      <desc>
48
52
        <p>Makes a trace pattern suitable to feed change_pattern/1</p>
49
 
        <p>Min detail level deactivates tracing of calls to phone_home/4,5</p>
50
 
        <p>Max detail level activates tracing of all calls to phone_home/4,5</p>
 
53
        <p>Min detail level deactivates tracing of calls to <c>et:trace_me/4,5</c></p>
 
54
        <p>Max detail level activates tracing of all calls to <c>et:trace_me/4,5</c></p>
51
55
        <p>integer(X) detail level activates tracing of all calls to
52
 
          phone_home/4,5 whose detail level argument is lesser than X.</p>
53
 
        <p>See also erlang:trace_pattern/2 for more info about its match_spec()</p>
 
56
        <c>et:trace_me/4,5</c> whose detail level argument is lesser than
 
57
        X.</p>
 
58
        <p>See also <c>erlang:trace_pattern/2</c> for more info about its <c>match_spec()</c></p>
54
59
      </desc>
55
60
    </func>
 
61
 
56
62
    <func>
57
63
      <name>change_pattern(Pattern) -> ok</name>
 
64
 
58
65
      <fsummary>Activates/deactivates tracing by changing the current trace pattern</fsummary>
 
66
 
59
67
      <type>
60
68
        <v>Pattern = detail_level() | empty_match_spec() | erlang_trace_pattern_match_spec()</v>
61
 
        <v>detail_level() = min | max | integer(X) when X =&lt;0, X >= 100</v>
 
69
        <v>detail_level() = min | max | integer(X) when  X &gt;= 0, X =&lt; 100</v>
62
70
        <v>empty_match_spec() = [] </v>
63
71
      </type>
 
72
 
64
73
      <desc>
65
74
        <p>Activates/deactivates tracing by changing the current trace pattern.</p>
66
 
        <p>Min detail level deactivates tracing of calls to phone_home/4,5</p>
67
 
        <p>Max detail level activates tracing of all calls to phone_home/4,5</p>
68
 
        <p>integer(X) detail level activates tracing of all calls to
69
 
          phone_home/4,5 whose detail level argument is lesser than X.</p>
70
 
        <p>An empty match spec deactivates tracing of calls to phone_home/4,5</p>
71
 
        <p>Other match specs activates tracing of calls to phone_home/4,5
72
 
          accordingly with erlang:trace_pattern/2.</p>
 
75
        <p><c>min</c> detail level deactivates tracing of calls to <c>et:trace_me/4,5</c></p>
 
76
        <p><c>max</c> detail level activates tracing of all calls to <c>et:trace_me/4,5</c></p>
 
77
        <p><c>integer(X)</c> detail level activates tracing of all
 
78
        calls to <c>et:trace_me/4,5</c> whose detail level argument is
 
79
        lesser than <c>X</c>.</p>
 
80
        <p>An empty match spec deactivates tracing of calls to <c>et:trace_me/4,5</c></p>
 
81
        <p>Other match specs activates tracing of calls to
 
82
        <c>et:trace_me/4,5</c> accordingly with
 
83
        <c>erlang:trace_pattern/2</c>.</p>
73
84
      </desc>
74
85
    </func>
75
86
    <func>
76
87
      <name>parse_event(Mod, ValidTraceData) -> false | true | {true, Event}</name>
 
88
 
77
89
      <fsummary>Transforms trace data and makes an event record out of it</fsummary>
 
90
 
78
91
      <type>
79
92
        <v>Mod = module_name() | undefined &lt;v>module_name() = atom() &lt;v>ValidTraceData = erlang_trace_data() | record(event)</v>
80
93
        <v>erlang_trace_data() = {trace, Pid, Label, Info} |  {trace, Pid, Label, Info, Extra} |  {trace_ts, Pid, Label, Info, ReportedTS} |  {trace_ts, Pid, Label, Info, Extra, ReportedTS} |  {seq_trace, Label, Info} |  {seq_trace, Label, Info, ReportedTS} |  {drop, NumberOfDroppedItems}</v>
81
94
      </type>
 
95
 
82
96
      <desc>
83
97
        <p>Transforms trace data and makes an event record out of it.</p>
84
 
        <p>See erlang:trace/3 for more info about the semantics of
85
 
          the trace data.</p>
86
 
        <p>An event record consists of the following fields:
87
 
          detail_level - Noise has a high level as opposed to essentials.
88
 
          trace_ts     - Time when the trace was generated.
89
 
          Same as event_ts if omitted in trace data.
90
 
          event_ts     - Time when the event record was created.
91
 
          from         - From actor, such as sender of a message.
92
 
          to           - To actor, such as receiver of message.
93
 
          label        - Label intended to provide a brief event summary.
94
 
          contents     - All nitty gritty details of the event.</p>
95
 
        <p>See et:phone_home/4 and et:phone_home/5 for details.</p>
96
 
        <p>Returns: 
97
 
          {true, Event} - where Event is an #event{} record representing the
98
 
          trace data
99
 
          true          - means that the trace data already is an event
100
 
          record and that it is valid as it is.
101
 
          No transformation is needed.
102
 
          false         - means that the trace data is uninteresting and
103
 
          should be dropped</p>
 
98
 
 
99
        <p>See <c>erlang:trace/3</c> for more info about the semantics of the
 
100
        trace data.</p>
 
101
 
 
102
        <p>An event record consists of the following fields:</p>
 
103
        <taglist>
 
104
          <tag><em>detail_level</em></tag>
 
105
          <item><p>Noise has a high level as opposed to essentials.</p></item>
 
106
 
 
107
 
 
108
          <tag><em>trace_ts</em></tag>
 
109
          <item><p>Time when the trace was generated.  Same as
 
110
          event_ts if omitted in trace data.</p></item>
 
111
 
 
112
          <tag><em>event_ts</em></tag>
 
113
          <item><p>Time when the event record was created.</p></item>
 
114
 
 
115
          <tag><em>from</em></tag>
 
116
          <item><p>From actor, such as sender of a message.</p></item>
 
117
 
 
118
          <tag><em>to</em></tag>
 
119
          <item><p>To actor, such as receiver of message.</p></item>
 
120
 
 
121
          <tag><em>label</em></tag>
 
122
          <item><p>Label intended to provide a brief event summary.</p></item>
 
123
 
 
124
          <tag><em>contents</em></tag>
 
125
          <item><p>All nitty gritty details of the event.</p></item>
 
126
        </taglist>
 
127
 
 
128
        <p>See <c>et:trace_me/4</c>and <c>et:trace_me/5</c> for details.</p>
 
129
 
 
130
        <p>Returns:</p>
 
131
        <taglist>
 
132
          <tag><em>{true, Event}</em></tag>
 
133
          <item><p>where Event is an #event{} record representing the
 
134
          trace data</p></item>
 
135
 
 
136
          <tag><em>true</em></tag>
 
137
          <item><p>means that the trace data already is an event
 
138
          record and that it is valid as it is. No transformation is
 
139
          needed.</p></item>
 
140
 
 
141
          <tag><em>false</em></tag>
 
142
          <item><p>means that the trace data is uninteresting and
 
143
          should be dropped</p></item>
 
144
        </taglist>
104
145
      </desc>
105
146
    </func>
106
147
  </funcs>