← Back to branch summary

~rdoering/ubuntu/karmic/erlang/fix-535090

« back to all changes in this revision

Viewing changes to lib/dialyzer/README

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-02-15 16:42:52 UTC
  • mfrom: (1.1.13 upstream)
  • mto: (3.3.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: james.westby@ubuntu.com-20090215164252-dxpjjuq108nz4noa
Upload to unstable after lenny is released.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/dialyzer/README
41
41
 
42
42
        dialyzer [--help] [--version] [--shell] [--quiet] [--verbose]
43
43
                 [-pa dir]* [--plt plt] [-Ddefine]* [-I include_dir]* 
44
 
                 [--old_style] [--output_plt file] [-Wwarn]* 
45
 
                 [--no_warn_on_inline] [--src] [-c applications] 
46
 
                 [-r applications] [-o outfile]
47
 
                 [--dataflow] [--succ_typings]
 
44
                 [--output_plt file] [-Wwarn]* [--src] 
 
45
                 [-c applications] [-r applications] [-o outfile]
 
46
                 [--build_plt] [--add_to_plt] [--remove_from_plt] [--check_plt]
 
47
                 [--plt_info] [--get_warnings]
48
48
 
49
 
Use "./dialyzer --help" to see an explanation of these options.
 
49
Use "dialyzer --help" to see an explanation of these options as well as
 
50
a description of the various options to turn on or suppress certain types
 
51
of warnings (for the latter only type "dialyzer -Whelp").
50
52
 
51
53
 
52
54
The Persistent Lookup Table
53
55
===========================
54
 
Dialyzer comes with a Persistent Lookup Table containing type information
55
 
for functions in some of the Erlang/OTP standard libraries. This table is
56
 
the starting point for later analyses. At each startup of Dialyzer the
57
 
validity of this PLT is checked, and if something has changed in the OTP
58
 
libraries, a new PLT will be constructed.
59
 
 
60
 
It is possible to setup user-specified PLTs.
 
56
Most Dialyzer uses require information about functions in the Erlang/OTP
 
57
standard libraries.  This information is stored in a Persistent Lookup
 
58
Table (PLT) and is the starting point for later analyses.  Before the
 
59
first use of Dialyzer, the PLT needs to be built explicitly by the user
 
60
using a command of the form:
 
61
 
 
62
  dialyzer --build_plt -r lib/kernel/ebin lib/stdlib/ebin ... OTHER LIBS
 
63
 
 
64
At each subsequent startup of Dialyzer the validity of this PLT is checked,
 
65
and if something has changed in the libraries and applications that were
 
66
included in it when the PLT was initially created, the PLT will be rebuilt.
 
67
 
 
68
It is possible to have multiple PLTs and select dynamically among them.
 
69
It is also possible to build PLTs incrementally.  For more information
 
70
refer to the documentation of the relevant options.
61
71
 
62
72
 
63
73
-----------------------------------------------