"Fossies" - the Fresh Open Source Software Archive

Member "otp_src_22.0/lib/dialyzer/RELEASE_NOTES" (13 May 2019, 19718 Bytes) of package /linux/misc/otp_src_22.0.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 ==============================================================================
    2 	Major features, additions and changes between Dialyzer versions
    3 		(in reversed chronological order)
    4 ==============================================================================
    5 
    6 Version 2.4.2 (in Erlang/OTP R14B02)
    7 ------------------------------------
    8  - Added --fullpath option to display files with warnings with their full
    9    file names (thanks to Magnus Henoch for the original patch).
   10  - Better handling of 'and'/'or'/'not' guards that generate warnings
   11    (thanks to Stavros Aronis).
   12  - Better blame assignment for cases when a function's spec is erroneous
   13    (thanks to Stavros Aronis).
   14  - More descriptive warnings when a tuple/record pattern contains subterms
   15    that violate the declared types of record fields (thanks to Matthias Lang
   16    for the test case and for Stavros Aronis for the actual fix).
   17 
   18 Version 2.4.0 (in Erlang/OTP R14B01)
   19 ------------------------------------
   20  - Added ability to supply multiple PLTs for the analysis (option --plts).
   21    Currently these PLTs must be independent (i.e., no module appears in more
   22    than one PLT) and there must not include files with module name clashes.
   23  - Strengthened and streamlined hard-coded type information for some BIFs
   24    and key library functions.
   25  - Fixed pretty rare infinite loop when refining the types of an SCC whose
   26    functions all returned none() (thanks to Stavros Aronis).
   27  - Fixed pretty rare crash when taking the infimum of two tuple_sets.
   28  - Fixed pretty rare crash when using parameterized types containing unbound
   29    variables (thanks to Nicolas Trangez for reporting it).
   30  - Deeper unfolding of recursive types (thanks to Maria Christakis).
   31  - Fixed some incomplete and erroneous specs in modules of kernel and stdlib.
   32  - Fixed problems in the handling of remote types in records used as types
   33    (thanks to Nico Kruber for the report and to Maria Christakis for the fix).
   34  - Fixed handling of nested opaque types (thanks to Thorsten Schuett for
   35    reporting it and to Maria Christakis for fixing it).
   36 
   37 Version 2.3.1 (in Erlang/OTP R14B)
   38 ----------------------------------
   39  - Eliminated warnings for auto-imported BIF clashes.
   40 
   41 Version 2.3.0 (in Erlang/OTP R14A)
   42 ----------------------------------
   43  - Dialyzer properly supports the new attribute -export_type and checks
   44    that remote types only refer to exported types. A warning is produced
   45    if some files/applications refer to types defined in modules which are
   46    neither in the PLT nor in the analyzed applications.
   47  - Support for detecting data races involving whereis/1 and unregister/1.
   48  - More precise identification of the reason(s) why a record construction
   49    violates the types declared for its fields.
   50  - Fixed bug in the handling of the 'or' guard.
   51  - Better handling of the erlang:element/2 BIF.
   52  - Complete handling of Erlang BIFs.
   53 
   54 Version 2.2.0 (in Erlang/OTP R13B04)
   55 ------------------------------------
   56  - Much better support for opaque types (thanks to Manouk Manoukian).
   57  - Added support for recursive types (experimental).
   58  - Added support for parameterized modules.
   59  - Dialyzer now warns when -specs state that a function returns some type
   60    when in fact it does not.
   61  - Added --no_native (-nn) option so that the user can bypass the native code
   62    compilation that dialyzer heuristically performs when dialyzing many files.
   63  - Fixed minor bug in the dialyzer script allowing the --wx option to bring
   64    up the wx-based GUI regardless of its placement in the options list.
   65  - Options --apps and -Wrace_conditions, which were added in the previous
   66    version, are now properly documented in the manual.
   67 
   68 Version 2.1.0 (in Erlang/OTP R13B03)
   69 ------------------------------------
   70  - Dialyzer can statically detect some kinds of data races in Erlang programs.
   71    Use the new option -Wrace_conditions to enable the race analysis.
   72    The static analysis technique is described in a paper available at:
   73      http://www.it.uu.se/research/group/hipe/dialyzer/publications/races.pdf
   74  - Added support for packages (thanks to Maria Christakis).
   75  - There has been a major change in the default mode of Dialyzer.
   76    Previously, the default mode was the GUI, while now it is the command
   77    line. As a result of this change, it is now possible to analyze a set of
   78    files/dirs with the command:
   79 	dialyzer file1 ... fileN
   80    In other words, the -c (--command-line) option is no longer necessary,
   81    though it will be retained for some time for backwards compatibility.
   82    To start dialyzer's GUI use either of the following commands:
   83 	dialyzer --gui         %% for the old gs-based GUI
   84 	dialyzer --wx          %% for the new wx-based GUI (where available)
   85  - There is a new option --apps which allows the user to easily refer to
   86    Erlang/OTP applications and include them in the analysis or in the
   87    building of the PLT.  For example, we recommend building the PLT with:
   88 	dialyzer --build_plt --apps erts kernel stdlib mnesia ...
   89    The new option can also take absolute file names as well as applications.
   90    Note that the application versions that will be included in the PLT are
   91    those that correspond to the Erlang/OTP system which is used.
   92  - Dialyzer has a new wxWidgets based GUI (thanks to Elli Fragkaki)
   93    for platforms where the wx application is available.
   94 
   95 Version 2.0.0 (in Erlang/OTP R13B02)
   96 ------------------------------------
   97  - There is a major addition to the capabilities of dialyzer, worthy
   98    of bumping the version number. Starting with this version, dialyzer
   99    not only accepts but also properly processes remote types (i.e.,
  100    types of the form ModuleName:TypeName()). Previous dialyzer
  101    versions only accepted this notation in -type and -spec
  102    declarations, but effectively ignored its information by mapping
  103    remote types to the type any(). In contrast, starting with this
  104    version, remote types are used in the analysis and are also stored
  105    in the PLTs. (This addition changes the format of PLTs and requires
  106    rebuilding any PLTs created by an older dialyzer version.)
  107    Note that dialyzer will complain and abort the analysis of a set of
  108    modules if it needs to process a remote type without a definition
  109    (either because the module does not include a definition of the
  110    type or the module is not included in the analysis). We may relax
  111    this restriction in a future version.
  112  - Fixed minor issue with dialyzer:run/1 crashing (upon its return)
  113    when used for adding type information to an existing PLT.
  114  - Fixed minor but quite annoying issues in dialyzer's GUI.
  115 
  116 Version 1.9.2 (in Erlang/OTP R13B01)
  117 ------------------------------------
  118  - Fixed problem with type inference going into an infinite loop when
  119    analyzing a strongly connected component of functions that do not
  120    return but also contain an erroneous call which makes them fail and
  121    be assigned the type none() instead of the type unit().
  122  - More accurate type information for some BIFs and library files.
  123  - Introduced boolean() as the `official' name for the type which was so
  124    far known as bool(). The latter is still accepted as well as boolean()
  125    but results in a warning from the compiler; converting the code to use
  126    the new name is strongly encouraged.
  127 
  128 Version 1.9.1 (in Erlang/OTP R13B)
  129 ----------------------------------
  130  - Contains the changes described below (R13A) but also:
  131     - Has better handling of opaque types.
  132     - The handling of UFT segments of bitstreams has been significantly
  133       strengthened and revised.  In all probability, now it is correct.
  134 
  135 Version 1.9.0 (in Erlang/OTP R13A)
  136 ----------------------------------
  137  - The analysis accepts opaque type declarations and detects violations of
  138    opacity of terms of such types.  Starting with R13, many Erlang/OTP
  139    standard libraries (array, dict, digraph, ets, gb_sets, gb_trees, queue,
  140    and sets) contain opaque type declarations of their main data types.
  141    Dialyzer will spit out warnings in code that explicitly depends on the
  142    structure of these terms.
  143  - Added support for handling UTF segments in bitstreams and for detecting
  144    obvious type errors in these segments.
  145    Warning: This code is not terribly tested -- not surprising since this is
  146    a new language feature of R13.
  147  - Strengthened the discrepancy identification when testing for equality and
  148    matching between terms of different types.  This detects more bugs in code.
  149  - Added warning for M:F(...) calls where M is not a module term and F is not
  150    an atom.  Previously, such calls where found to fail but the reason for
  151    the failure was not reported.
  152  - Added a convenient shorthand for the --no_check_plt option (-n).
  153  - Added the --dump_callgraph option for dumping the callgraph of all files
  154    that are analyzed into a specified file.  The callgraph either be dumped
  155    in raw format, in .dot format, or converted to a .ps (postscript) file.
  156    Note that in large callgraphs the generated postscript file might not be
  157    interpretable by Ghostview.
  158    (Thanks to Ilya Khlopotov for the initial version of this functionality.)
  159 
  160 Version 1.8.3 (in Erlang/OTP R12B-5)
  161 ------------------------------------
  162  - Added the --no_check_plt option that makes the startup time faster
  163    when working with PLTs that are known not to change.
  164  - Changed the phrasing of some warnings so that they do not cause confusion
  165    to some users and correspond better to reality.
  166 
  167 Version 1.8.2 (in Erlang/OTP R12B-4)
  168 ------------------------------------
  169  - The return type of the Erlang interface dialyzer:run/1 has changed
  170    to only return a list of warnings. If something goes wrong dialyzer
  171    dies with an exception.
  172  - The handling of the PLT has changed. Please consult the manual for
  173    the changes.
  174 
  175 Version 1.8.0 (in Erlang/OTP R12B-2)
  176 ------------------------------------
  177  - Dialyzer's analysis is from now on exclusively based on success typings.
  178    In particular, support for options --old_style and --dataflow has been
  179    discontinued.
  180  - Better and more aggressive handling of type information in records.
  181  - Dialyzer has a new warning option -Wunmatched_returns which warns for
  182    function calls that ignore the return value.
  183    This catches many common programming errors (e.g. calling file:close/1
  184    and not checking for the absence of errors), interface discrepancies
  185    (e.g. a function returning multiple values when in reality the function
  186    is void and only called for its side-effects), calling the wrong function
  187    (e.g. io_lib:format/1 instead of io:format/1), and even possible
  188    performance defects (e.g. unnecessarily constructing a list using a list
  189    comprehension instead of using lists:foreach/2).
  190    Whenever a function returns a single atomic value (e.g. 'ok' or pid()),
  191    the warning is suppressed. This allows for "void" functions (returning
  192    a single atom like 'ok') or for calls to certain builtins like spawn.
  193    Because not all calls which ignore the return value are discrepancies,
  194    the option is off by default and has to be explicitly requested by the user.
  195    But we recommend it nevertheless.
  196  - Some warning options (-Wno_comp, -Wno_guards, -Wno_unsafe_beam, etc.)
  197    which could be used when analyzing bytecode produced by an old BEAM
  198    compiler have been removed.
  199 
  200 Version 1.7.2 (in Erlang/OTP R12B-1)
  201 ------------------------------------
  202  - The Erlang interface of Dialyzer returns warnings tagged by their type.
  203 
  204 Version 1.7.1 (in Erlang/OTP R12B-0)
  205 ------------------------------------
  206  - Use of success typings is now default, is robust and detects significantly
  207    more errors than in previous versions.
  208  - Dialyzer accepts and takes into account type information in record
  209    declarations and in contracts -- see related paper in Erlang'07 workshop.
  210    Various OTP applications (e.g. stdlib and kernel) are partially annotated
  211    with appropriate contracts specifying types information for their functions.
  212  - The type previously known as unit() has been renamed to no_return().
  213    Its use in a contract as the return type of a function now silences off
  214    the "function has no local return" dialyzer warning without use of the
  215    corresponding option.
  216 
  217 Version 1.7.0 (in Erlang/OTP R11B-5)
  218 ------------------------------------ 
  219  - Dialyzer can now use success typings to find discrepancies. As a
  220    consequence significantly more discrepancies are detected. The downside
  221    is that the analysis takes about 2 to 2.5 times longer than in previous
  222    versions, and may also result in some warnings that might be harder to
  223    interpret even though they are correct. This has been a major change, 
  224    worth of increasing the version number.
  225    New command-line options:
  226    --succ_typings                        Use the success typings analysis.
  227    --dataflow     (default)              Use the previous analysis.   
  228  - The new type unit() has been introduced to handle the return type of
  229    non-terminating functions such as servers.
  230  - Dialyzer's code server uses a compressed representation and the analysis
  231    requires significantly less memory than in previous versions.
  232 
  233 Version 1.6.0 (in Erlang/OTP R11B-4)
  234 ------------------------------------
  235  - Dialyzer (in the modes where either source or BEAM code which contains
  236    debug_info is analyzed) spits out line information for all discrepancies.
  237    This has been a major change, worth of increasing the version number.
  238      We warn users that *considerably* more discrepancies are identified 
  239      by this version of Dialyzer compared with previous ones.  If warnings
  240      generated by previous versions of Dialyzer are preferable for some
  241      applications, the command line option --old_style can be employed.
  242  - Dialyzer handles term comparison operators more precisely and is able to
  243    identify more discrepancies in 'if' or 'case' statements with comparisons.
  244  - Dialyzer has more precise type information for many standard OTP functions.
  245 
  246 Version 1.5.1 (in Erlang/OTP R11B-3)
  247 ------------------------------------
  248  - Added the option --check_init_plt that can be used to force the re-building 
  249    of the initial plt for installed systems.
  250  - Fixed some bugs in the handling of guards in the dataflow analysis after
  251    a report from Fredrik Thulin.
  252  - Cleaned up the error handling and the interface and now Dialyzer has an 
  253    Erlang interface.
  254  - Building the PLT using success typings is considerably faster than in 1.5.0.
  255  - Added option --verbose which makes Dialyzer a bit more verbose.
  256 
  257 Version 1.5.0 (in Erlang/OTP R11B-2)
  258 ------------------------------------
  259  - Dialyzer's building of PLT is based on a different type inference algorithm.
  260    More specifically, Dialyzer uses inferrence of refined success typings to
  261    infer function prototypes.  As a result, Dialyzer bases its analysis on a
  262    significantly more powerful basis and thus is able to detect more
  263    discrepancies.  The downside is that building the PLT is a considerably
  264    slower process.  We will work on improving that.
  265  - Dialyzer takes into account the BEAM compiler directive
  266 	-compile({nowarn_unused_function, {F,A}}).
  267    and then suppresses the warning that function F/A will never be called.
  268  - Dialyzer's default initial PLT now also includes "mnesia".
  269 
  270 Version 1.4.2 (in Erlang/OTP R11B-1)
  271 ------------------------------------
  272  - Speed up changes and small bug fixes.
  273 
  274 Version 1.4.1 (in Erlang/OTP R11B-0)
  275 ------------------------------------
  276  - Dialyzer is officially part of Erlang/OTP as a library application.
  277  - Instead of being a shell script, "dialyzer" is an executable (generated
  278    by a C program -- thanks to Bjorn Gustavsson), and works similarly to "erlc".
  279    As a side-effect of this change, Dialyzer now also works on Windows.
  280 
  281 Version 1.4.0
  282 -------------
  283  - Changes for Dialyzer to work with Erlang/OTP R10B-10
  284  - Dialyzer's analysis is significantly faster as it uses a global function
  285    call-graph for obtaining type signatures for all analyzed functions
  286  - ...
  287  - Many more other changes; in fact too many to mention here.
  288 
  289 Version 1.3.1 (mostly internal)
  290 -------------
  291  - Small changes for Dialyzer to work with Erlang/OTP R10B-5.
  292  - Modified setup script for execution under Cygwin (patch by Vlad Dumitrescu)
  293  - Added command line option --no_warn_on_inline
  294  - Fixed a small buglet in the analysis; this affected one of HiPE's files
  295  - Dialyzer now explicitly warns when modules with the same name
  296    but from different dirs are being analyzed (contribution by Ulf Wiger)
  297 
  298 Version 1.3.0
  299 -------------
  300  - Requires the presence of an Erlang/OTP R10B-4 system.
  301  - Dialyzer is significantly (approx 40%) faster since it now uses 'ets'
  302    rather than 'dets' for its PLT.
  303  - Slightly improved the precision of the analysis.
  304  - Fixed a number of false positives that Dialyzer 1.2.0 was spitting out.
  305  - In the GUI version, Dialyzer now reports the list of modules that should
  306    be included in the modules to analyze in order to possibly improve
  307    the accuracy of the reported results.
  308  - Some more information is displayed when calling a function or closure
  309    with arguments of the wrong type.
  310  - The record guard now allows discrepancies involving tuples that are known
  311    to be records to be displayed as #rec{} rather than {'rec',_,...,_}
  312  - Added -q option which makes the command-line version of Dialyzer
  313    a bit more silent.
  314 
  315 Version 1.2.0
  316 -------------
  317  - Dialyzer works with the open source and commercial versions of Erlang/OTP
  318    R10B-2 on all platforms (i.e., HiPE support is not a prerequisite anymore).
  319  - Whenever a .beam file contains abstract code (i.e., has been compiled
  320    with the +debug_info option), the analysis starts from this code rather
  321    than from BEAM bytecode -- this makes the results identical to those
  322    obtained by analysis starting from source code.
  323    (This is a contribution from Bjorn Gustavsson - Thanks!)
  324  - Added -pa command line option for easier handling of -include_lib()
  325    directives in source code.
  326  - Includes all changes added in v1.1.1; see below.  The "Add Recursively"
  327    functionality is also available in the command-line mode (-r option).
  328 
  329 Version 1.1.1 (internal, not released to the masses :-)
  330 -------------
  331  - The command-line mode of Dialyzer spits discrepancies in stdout
  332    by default and returns a numeric value indicating its exit status.
  333  - Fixed problems using the shell script on Solaris machines.
  334  - Fixed small inconsistencies in Dialyzer's documentation and help.
  335  - Added "Add Recursively" button contributed by Martin Bjorklund (thanks!).
  336 
  337 Version 1.1.0
  338 -------------
  339  - Dialyzer works with the open source version of Erlang/OTP R10B-1 (on
  340    platforms where HiPE support is available) and it does not require
  341    installation of a customized Erlang/OTP system anymore.
  342  - Dialyzer comes with an extensive command-line interface, in addition
  343    to an enhanced GUI.
  344  - Analysis can start from source code (through Core Erlang) as well as
  345    from BEAM bytecode.
  346  - Dialyzer finds considerably more discrepancies in Erlang code than
  347    previous versions.
  348  - Added ability to selectively turn on/off different warning categories.
  349 
  350 Version 1.0.1
  351 -------------
  352  - Fixed major bug of v1.0.0 which caused the analysis to stop prematurely
  353    (i.e., without properly reaching fixpoint) when analyzing more than one
  354    module.  This did not affect correctness of the results, but lost many
  355    opportunities to detect discrepancies.
  356  - Performance improvements in the analysis.
  357 
  358 Version 1.0.0
  359 -------------
  360  Initial Dialyzer version: Analysis starts from BEAM bytecode only and 
  361  only a GUI version is available. Dialyzer reports discrepancies in the
  362  use of the "sequential" part of Erlang. To be used, Dialyzer requires
  363  the presence of a specific snapshot of Erlang/OTP which can be obtained
  364  from Dialyzer's homepage.