← Back to branch summary

~clint-fewbar/ubuntu/precise/erlang/merge-15b

« back to all changes in this revision

Viewing changes to lib/stdlib/doc/src/log_mf_h.xml

  • Committer: Package Import Robot
  • Author(s): Sergei Golovan
  • Date: 2011-12-15 19:20:10 UTC
  • mfrom: (1.1.18) (3.5.15 sid)
  • mto: (3.5.16 sid)
  • mto: This revision was merged to the branch mainline in revision 33.
  • Revision ID: package-import@ubuntu.com-20111215192010-jnxcfe3tbrpp0big
Tags: 1:15.b-dfsg-1
* New upstream release.
* Upload to experimental because this release breaks external drivers
  API along with ABI, so several applications are to be fixed.
* Removed SSL patch because the old SSL implementation is removed from
  the upstream distribution.
* Removed never used patch which added native code to erlang beam files.
* Removed the erlang-docbuilder binary package because the docbuilder
  application was dropped by upstream.
* Documented dropping ${erlang-docbuilder:Depends} substvar in
  erlang-depends(1) manpage.
* Made erlang-base and erlang-base-hipe provide virtual package
  erlang-abi-15.b (the number means the first erlang version, which
  provides current ABI).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/stdlib/doc/src/log_mf_h.xml
5
5
  <header>
6
6
    <copyright>
7
7
      <year>1996</year>
8
 
      <year>2007</year>
 
8
      <year>2011</year>
9
9
      <holder>Ericsson AB, All Rights Reserved</holder>
10
10
    </copyright>
11
11
    <legalnotice>
43
43
      report files <c>1, 2, ....</c>.
44
44
      </p>
45
45
  </description>
 
46
  <datatypes>
 
47
    <datatype>
 
48
      <name name="args"/>
 
49
      <desc><p>Term to be sent to <seealso marker="gen_event#add_handler/3">
 
50
        gen_event:add_handler/3</seealso>.</p></desc>
 
51
    </datatype>
 
52
  </datatypes>
46
53
  <funcs>
47
54
    <func>
48
 
      <name>init(Dir, MaxBytes, MaxFiles)</name>
49
 
      <name>init(Dir, MaxBytes, MaxFiles, Pred) -> Args</name>
 
55
      <name name="init" arity="3"/>
 
56
      <name name="init" arity="4"/>
50
57
      <fsummary>Initiate the event handler</fsummary>
51
 
      <type>
52
 
        <v>Dir = string()</v>
53
 
        <v>MaxBytes = integer()</v>
54
 
        <v>MaxFiles = 0 &lt; integer() &lt; 256</v>
55
 
        <v>Pred = fun(Event) -> boolean()</v>
56
 
        <v>Event = term()</v>
57
 
        <v>Args = args()</v>
58
 
      </type>
59
58
      <desc>
60
59
        <p>Initiates the event handler. This function returns
61
 
          <c>Args</c>, which should be used in a call to
62
 
          <c>gen_event:add_handler(EventMgr, log_mf_h, Args)</c>.
 
60
          <c><anno>Args</anno></c>, which should be used in a call to
 
61
          <c>gen_event:add_handler(EventMgr, log_mf_h, <anno>Args</anno>)</c>.
63
62
          </p>
64
 
        <p><c>Dir</c> specifies which directory to use for the log
65
 
          files. <c>MaxBytes</c> specifies the size of each individual
66
 
          file. <c>MaxFiles</c> specifies how many files are
67
 
          used. <c>Pred</c> is a predicate function used to filter the
 
63
        <p><c><anno>Dir</anno></c> specifies which directory to use for the log
 
64
          files. <c><anno>MaxBytes</anno></c> specifies the size of each individual
 
65
          file. <c><anno>MaxFiles</anno></c> specifies how many files are
 
66
          used. <c><anno>Pred</anno></c> is a predicate function used to filter the
68
67
          events. If no predicate function is specified, all events are
69
68
          logged.</p>
70
69
      </desc>