path: root/lib/debugger/doc/src/notes.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2004</year><year>2016</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at
 
          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    </legalnotice>

    <title>Debugger Release Notes</title>
    <prepared>otp_appnotes</prepared>
    <docno>nil</docno>
    <date>nil</date>
    <rev>nil</rev>
    <file>notes.xml</file>
  </header>
  
  <p>This document describes the changes made to the Debugger
    application.</p>

<section><title>Debugger 4.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>When the debugger searches for source files, it will
	    also use the location of the source in the compilation
	    information part of the BEAM file.</p>
          <p>
	    Own Id: OTP-13375</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 4.1.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Documentation corrections.</p>
          <p>
	    Own Id: OTP-12994</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 4.1.1</title>
    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fix crash when starting a quick debugging session. Thanks
	    Alan Duffield.</p>
          <p>
	    Own Id: OTP-12911 Aux Id: seq12906 </p>
        </item>
      </list>
    </section>

</section>


<section><title>Debugger 4.1</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Support variables as Map keys in expressions and patterns</p>
	    <p>Erlang will accept any expression as keys in Map
	    expressions and it will accept literals or bound
	    variables as keys in Map patterns.</p>
          <p>
	    Own Id: OTP-12218</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 4.0.3</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fix save state which did not work on Mac.</p>
          <p>
	    Own Id: OTP-12378</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 4.0.2</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Make sure to install .hrl files when needed</p>
          <p>
	    Own Id: OTP-12197</p>
        </item>
        <item>
          <p>
	    Invoking debugger functions <c>ia/1</c> and <c>iaa/1</c>
	    crashed, when it tried to invoke the old and removed gs
	    based gui functions.</p>
          <p>
	    Own Id: OTP-12357</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 4.0.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fix evaluation of map updates in the debugger and
	    erl_eval</p>
          <p>
	    Reported-by: José Valim</p>
          <p>
	    Own Id: OTP-11922</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 4.0</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    The debugger now correctly evaluates code such as '<c>X =
	    true andalso X</c>'. (Thanks to Anthony Ramine.)</p>
          <p>
	    Own Id: OTP-11553</p>
        </item>
        <item>
          <p>
	    A few subtle bugs in the evaluation of code in the
	    debugger has been corrected. (Thanks to Anthony Ramine.)</p>
          <p>
	    Own Id: OTP-11676</p>
        </item>
        <item>
          <p>
	    Application upgrade (appup) files are corrected for the
	    following applications: </p>
          <p>
	    <c>asn1, common_test, compiler, crypto, debugger,
	    dialyzer, edoc, eldap, erl_docgen, et, eunit, gs, hipe,
	    inets, observer, odbc, os_mon, otp_mibs, parsetools,
	    percept, public_key, reltool, runtime_tools, ssh,
	    syntax_tools, test_server, tools, typer, webtool, wx,
	    xmerl</c></p>
          <p>
	    A new test utility for testing appup files is added to
	    test_server. This is now used by most applications in
	    OTP.</p>
          <p>
	    (Thanks to Tobias Schlager)</p>
          <p>
	    Own Id: OTP-11744</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Removed gs based applications and gs based backends. The
	    <c>observer</c> application replaces the removed
	    applications.</p>
          <p>
	    *** POTENTIAL INCOMPATIBILITY ***</p>
          <p>
	    Own Id: OTP-10915</p>
        </item>
        <item>
          <p>
	    Support Maps syntax in debugger (Thanks to Anthony
	    Ramine).</p>
          <p>
	    Own Id: OTP-11673</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.12</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Fix matching of floating point middle-endian machines.
	    Thanks to Johannes Weissl.</p>
          <p>
	    Own Id: OTP-11201</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.11</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p> A new checkbox has been added. When it is checked,
	    the range set by the <c>erl</c> flag <c>+pc</c> is used
	    for determining when to print lists of integers as
	    strings. When it is unchecked, integer lists are never
	    printed as strings. </p> <p>A minor incompatibility:
	    settings saved by Erlang R16B01 or later cannot be read
	    by Erlang R16B or earlier.</p>
          <p>
	    Own Id: OTP-10899</p>
        </item>
        <item>
	    <p>Erlang source files with non-ASCII characters are now
	    encoded in UTF-8 (instead of latin1).</p>
          <p>
	    Own Id: OTP-11041 Aux Id: OTP-10907 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.10</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The +pc flag to erl can be used to set the range of
	    characters considered printable. This affects how the
	    shell and io:format("~tp",...) functionality does
	    heuristic string detection. More can be read in STDLIB
	    users guide.</p>
          <p>
	    Own Id: OTP-10884</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.9</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fix Debugger settings dialog due to changed behavior in
	    wxFileDialog (Thanks to Håkan Mattsson)</p>
          <p>
	    Own Id: OTP-10621</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p> Support for Unicode has been implemented. </p>
          <p>
	    Own Id: OTP-10302</p>
        </item>
        <item>
	    <p>Where necessary a comment stating encoding has been
	    added to Erlang files. The comment is meant to be removed
	    in Erlang/OTP R17B when UTF-8 becomes the default
	    encoding. </p>
          <p>
	    Own Id: OTP-10630</p>
        </item>
        <item>
          <p>
	    Integer lists and utf-8 binaries in variables are now
	    displayed as strings.</p>
          <p>
	    Own Id: OTP-10679</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.8</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fixed disappearing breakpoints bug, reported by Ricardo
	    Catalinas Jiménez.</p>
          <p>
	    Own Id: OTP-9950</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.7</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fix "OK" spelling in debugger messages and variables</p>
          <p>
	    Simple code refactor in the debugger: renames all the
	    occurrences of "Ok" to "OK" in the code, variable names
	    and strings. This improves the consistency of the code
	    and follows the GTK UI where "OK" is always used.(Thanks
	    to Ricardo Catalinas Jiménez)</p>
          <p>
	    Own Id: OTP-9699</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>Variables are now now allowed in '<c>fun M:F/A</c>' as
	    suggested by Richard O'Keefe in EEP-23.</p>
	    <p>The representation of '<c>fun M:F/A</c>' in the
	    abstract format has been changed in an incompatible way.
	    Tools that directly read or manipulate the abstract
	    format (such as parse transforms) may need to be updated.
	    The compiler can handle both the new and the old format
	    (i.e. extracting the abstract format from a pre-R15 BEAM
	    file and compiling it using compile:forms/1,2 will work).
	    The <c>syntax_tools</c> application can also handle both
	    formats.</p>
          <p>
	    *** POTENTIAL INCOMPATIBILITY ***</p>
          <p>
	    Own Id: OTP-9643</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.6</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Fix issues reported by dialyzer.</p>
          <p>
	    Own Id: OTP-9107</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.5</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>Miscellaneous updates</p>
          <p>
	    Own Id: OTP-8976</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.4</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Type specs have been added/cleaned up. (Thanks to Kostis
	    Sagonas.)</p>
          <p>
	    Own Id: OTP-8757</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.3</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Warnings due to new autoimported BIFs removed</p>
          <p>
	    Own Id: OTP-8674 Aux Id: OTP-8579 </p>
        </item>
        <item>
          <p>
	    The predefined builtin type tid() has been removed.
	    Instead, ets:tid() should be used.</p>
          <p>
	    *** POTENTIAL INCOMPATIBILITY ***</p>
          <p>
	    Own Id: OTP-8687</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.2</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
            Bugs have been fixed in the evaluation of comprehensions
            and short-circuit expressions in guards.</p>
          <p>
	    Own Id: OTP-8310</p>
        </item>
      </list>
    </section>

    <section><title>Improvements and New Features</title>
      <list>
	<item>
          <p>
	    Miscellaneous corrections of the WX version of the
	    debugger.</p>
          <p>
	    Own Id: OTP-8346</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2.1</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The documentation is now built with open source tools
	    (xsltproc and fop) that exists on most platforms. One
	    visible change is that the frames are removed.</p>
          <p>
	    Own Id: OTP-8201</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Added a new gui, start with debugger:start(gs) for old
	    gui.</p>
          <p>
	    Own Id: OTP-7366</p>
        </item>
        <item>
          <p>
	    The undocumented, unsupported, and deprecated guard BIF
	    <c>is_constant/1</c> has been removed.</p>
          <p>
	    *** INCOMPATIBILITY with R12B ***</p>
          <p>
	    Own Id: OTP-7673</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.1.1.4</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    There is now experimental support for loading of code
	    from archive files. See the documentation of <c>code</c>,
	    <c>init</c>, <c>erl_prim_loader </c> and <c>escript</c>
	    for more info.</p>
          <p>
	    The error handling of <c>escripts</c> has been improved.</p>
          <p>
	    An <c>escript</c> may now set explicit arguments to the
	    emulator, such as <c>-smp enabled</c>.</p>
          <p>
	    An <c>escript</c> may now contain a precompiled beam
	    file.</p>
          <p>
	    An <c>escript</c> may now contain an archive file
	    containing one or more applications (experimental).</p>
          <p>
	    The internal module <c>code_aux</c> has been removed.</p>
          <p>
	    Own Id: OTP-7548 Aux Id: otp-6622 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.1.1.3</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Minor changes.</p>
          <p>
	    Own Id: OTP-7388</p>
        </item>
      </list>
    </section>

</section>

<section><title>Debugger 3.1.1.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>The documentation has been updated so as to reflect
	    the last updates of the Erlang shell as well as the minor
	    modifications of the control sequence <c>p</c> of the
	    <c>io_lib</c> module.</p> <p>Superfluous empty lines have
	    been removed from code examples and from Erlang shell
	    examples.</p>
          <p>
	    Own Id: OTP-6944 Aux Id: OTP-6554, OTP-6911 </p>
        </item>
      </list>
    </section>

</section>

  <section><title>Debugger 3.1.1.1</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Minor Makefile changes.</p>
          <p>
	    Own Id: OTP-6689</p>
        </item>
        <item>
          <p>
	    Obsolete guard tests (such as list()) have been replaced
	    with the modern guard tests (such as is_list()).</p>
          <p>
	    Own Id: OTP-6725</p>
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 3.1.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
            Removed some dead code from <c>dbg_ieval</c>.</p>
          <p>
            Own Id: OTP-6552</p>
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 3.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
            The interpreter could not handle the case where an
            expression that should evaluate to a fun referred to
            uninterpreted code.</p>
          <p>
            Own Id: OTP-6061 Aux Id: seq10295</p>
        </item>
	<item>
	  <p>
	    Timeout for <c>gen_server</c> calls within Debugger is
	    now set to <c>infinity</c>.</p>
	  <p>
	    Own Id: OTP-6103</p>
	</item>
      </list>
    </section>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
            Notification windows are now centered over a parent
            window.</p>
          <p>
            Own Id: OTP-6011 Aux Id: OTP-5987</p>
        </item>
        <item>
          <p>
            When interpreting a module, it is now checked that the
            module does not belong to the Kernel, STDLIB, GS or
            Debugger application, as interpreting a module used by
            the debugger/interpreter itself will lead to a deadlock
            or emulator crash.</p>
          <p>
            Also <c>int:interpretable(Mod)</c> has been extended to
            return <c>{error,{app,App}}</c> if <c>Mod</c> belongs to
            one of the above applications.</p>
          <p>
            Own Id: OTP-6020</p>
        </item>
        <item>
          <p>
            <c>andalso</c>/<c>orelse</c> is now supported.</p>
          <p>
            Own Id: OTP-6021 Aux Id: OTP-5894</p>
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 3.0.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
            When evaluating a guard expression for a fun function
            clause, the environment variable bindings were not taken
            into account.</p>
          <p>
            Own Id: OTP-5837</p>
        </item>
      </list>
    </section>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>A number of smaller improvements to the GUI:</p>
	  <list>
	    <item>Multiple choices now possible in Function Break
	      Dialog Window.</item>
	    <item>Right-clicking the Module entry in a Break Dialog
	      Window will open a popup menu from which the appropriate
	      (interpreted) module can be selected.</item>
	    <item>Auto Attach options can now be changed using
	      the buttons in the left part of the Monitor Window, not
	      only by the corresponding menu buttons.</item>
	    <item>Buttons for enabling and disabling all breakpoints
	      have been added.</item>
	    <item>View Module Window keyboard shortcuts corrected.
	    </item>
	  </list>
            Own Id: OTP-4284
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 3.0</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
            Debugger can now handle <c>try-catch</c>. This meant
            large parts of the interpreter had to be rewritten. Also,
            some small changes to the GUI have been made.</p>
          <p>
            Own Id: OTP-5730</p>
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 2.3.3</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
            <p>It is now possible to encrypt the debug information in
            Beam files, to help keep the source code secret. See the
            documentation for compile on how to provide the key for
            encrypting, and the documentation for beam_lib on how to
            provide the key for decryption so that tools such as the
            Debugger, Xref, or Cover can be used.</p>
            <p>The <c>beam_lib:chunks/2</c> functions now accepts an
            additional chunk type '<c>compile_info</c>' to retrieve
            the compilation information directly as a term. (Thanks
            to Tobias Lindahl.)</p>
          <p>
            Own Id: OTP-5460 Aux Id: seq9787</p>
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 2.3.2</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
            The graphic applications now search for HTML
            documentation in the correct place.</p>
          <p>
            Own Id: OTP-5381</p>
        </item>
      </list>
    </section>
  </section>

  <section><title>Debugger 2.3.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Package support has been added to the debugger. Thanks to
	    Richard Carlsson in the HiPE project.</p>
          <p>
	    Own Id: OTP-5255</p>
        </item>
      </list>
    </section>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Updated to handle the latest version of the compiler.</p>
          <p>
	    Own Id: OTP-5265</p>
        </item>
      </list>
    </section>
  </section>
</chapter>