diff options
Diffstat (limited to 'system/doc/top')
| -rw-r--r-- | system/doc/top/Makefile | 31 | ||||
| -rw-r--r-- | system/doc/top/highlights.xml | 234 | ||||
| -rw-r--r-- | system/doc/top/incompatible.xml | 418 | ||||
| -rw-r--r-- | system/doc/top/src/erl_html_tools.erl | 92 | ||||
| -rw-r--r-- | system/doc/top/src/otp_man_index.erl | 75 | ||||
| -rw-r--r-- | system/doc/top/templates/index.html.src | 4 |
6 files changed, 331 insertions, 523 deletions
diff --git a/system/doc/top/Makefile b/system/doc/top/Makefile index 154deb006b..aac90fcaa4 100644 --- a/system/doc/top/Makefile +++ b/system/doc/top/Makefile @@ -111,6 +111,10 @@ GLOSSARY = $(HTMLDIR)/glossary.html GLOSSARY_SRC = $(ERL_TOP)/system/internal_tools/doctools/src/glossary.erl GLOSSARY_SCRIPT = $(EBIN)/glossary.$(EMULATOR) +TEMPLATES = \ + templates/index.html.src \ + templates/applications.html.src + #-------------------------------------------------------------------------- $(INDEX_SCRIPT): $(INDEX_SRC) @@ -119,8 +123,14 @@ $(INDEX_SCRIPT): $(INDEX_SRC) # We don't list toc_*.html as targets because we don't know $(HTMLDIR)/index.html + $(HTMLDIR)/applications.html: $(INDEX_SCRIPT) echo "Generating index $@" - $(ERL) -noshell -pa $(EBIN) -s erl_html_tools top_index $(ERL_TOP) \ - $(HTMLDIR) $(SYSTEM_VSN) -s erlang halt +# Check if we are building the index from source or an installed release + if test "$$RELEASE_ROOT" = "" ; then \ + $(ERL) -noshell -pa $(EBIN) -s erl_html_tools top_index src $(ERL_TOP) \ + $(HTMLDIR) $(SYSTEM_VSN) -s erlang halt ;\ + else \ + $(ERL) -noshell -pa $(EBIN) -s erl_html_tools top_index rel $(RELEASE_ROOT) \ + $(HTMLDIR) $(SYSTEM_VSN) -s erlang halt ;\ + fi #-------------------------------------------------------------------------- @@ -139,8 +149,15 @@ $(MAN_INDEX_SCRIPT): $(MAN_INDEX_SRC) $(ERLC) -o$(EBIN) +warn_unused_vars $< $(MAN_INDEX): $(MAN_INDEX_SCRIPT) - $(ERL) -noshell -pa $(EBIN) -s otp_man_index gen $(ERL_TOP) $@ \ - -s erlang halt +# Check if we are building the index from source or an installed release + if test "$$RELEASE_ROOT" = "" ; then \ + $(ERL) -noshell -pa $(EBIN) -s otp_man_index gen src $(ERL_TOP) $@ \ + -s erlang halt ;\ + else \ + $(ERL) -noshell -pa $(EBIN) -s otp_man_index gen rel $(RELEASE_ROOT) $@ \ + -s erlang halt ;\ + fi + #-------------------------------------------------------------------------- @@ -226,7 +243,11 @@ release_docs_spec: docs $(INSTALL_DIR) $(RELSYSDIR)/js $(INSTALL_DATA) \ $(JAVASCRIPT) $(RELSYSDIR)/js - $(INSTALL_DATA) $(INDEX_FILES) $(MAN_INDEX) $(TOP_HTML_FILES) $(RELSYSDIR) + $(INSTALL_DATA) $(INDEX_FILES) $(MAN_INDEX) $(TOP_HTML_FILES) $(RELSYSDIR) + $(INSTALL_DIR) $(RELSYSDIR)/docbuild + $(INSTALL_DATA) $(INDEX_SCRIPT) $(MAN_INDEX_SCRIPT) $(JAVASCRIPT_BUILD_SCRIPT) \ + $(INDEX_SRC) $(MAN_INDEX_SRC) $(JAVASCRIPT_BUILD_SCRIPT_SRC) \ + $(TEMPLATES) $(RELSYSDIR)/docbuild release_spec: diff --git a/system/doc/top/highlights.xml b/system/doc/top/highlights.xml index a30742aed6..251bb1a47d 100644 --- a/system/doc/top/highlights.xml +++ b/system/doc/top/highlights.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2006</year><year>2009</year> + <year>2006</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>Highlights</title> @@ -28,133 +28,53 @@ <rev>A</rev> <file>highlights.xml</file> </header> - <p>This document lists some highlights of Erlang 5.7/OTP R13A - (unpatched), compared to the previous version Erlang 5.6/OTP R12B, - with focus on things not already released as R12B patches.</p> - <p>Note: This document was compiled at the time when R13A was released - and does not list any features introduced in R13 patches.</p> + <p>This document lists some highlights of Erlang 5.8/OTP R14A + (unpatched), compared to the previous version Erlang 5.7.1/OTP R13B, + with focus on things not already released as R13B patches.</p> + <p>Note: This document was compiled at the time when R14A was released + and does not list any features introduced in R14 patches.</p> <section> <title>Erlang Language and Run-time System</title> <section> - <title>Multi-core and SMP performance improvements</title> - <p> - There SMP performance is significantly improved and will - allow most applications to scale much better on systems with many - cores or processors. Listed below are some of the most important improvements: - </p> - <list type="bulleted"> - <item> - <p> - The runtime system with SMP support now uses <em>multiple, - scheduler specific run queues</em>, instead of one globally shared - run queue. - </p> - <p> - The lock protecting the shared run queue was heavily - contended, and the shared run queue also caused Erlang - processes to randomly migrate between schedulers with - negative cache effects as a result. - </p> - <p> - With the current scheduler specific run queue solution, lock - contention due to run queue protection has been reduced, and - Erlang processes are only migrated when needed to balance the - load between the schedulers. The reduced amount of migration - also reduce lock contention on locks protecting the scheduler - specific instances of the erts internal memory allocators. - </p> - <p> - The scheduler specific run queues are also a necessity for a - lot of future planned NUMA (Non-Uniform Memory Access) - specific optimizations. - </p> - </item> - <item> - <p> - Message passing has been further optimized for parallell execution. - This makes parallell sending to one common receiver much more efficient. - </p> - </item> - <item> - <p> - Scheduler threads can now be bound to logical processors on newer - Linux ans Solaris systems. - </p> - </item> - </list> - </section> - <section> - <title>Unicode support</title> - <p> - Support for Unicode is implemented as described in EEP10. - Formatting and reading of unicode data both from terminals - and files is supported by the <c>io</c> and <c>io_lib</c> modules. - Files - can be opened in modes with automatic translation to and from - different unicode formats. The module 'unicode' contains - functions for conversion between external and internal - unicode formats and the re module has support for unicode - data. There is also language syntax for specifying string and - character data beyond the ISO-latin-1 range. - </p> - </section> + <title>New NIF features</title> + <list type="bulleted"> + <item><p>Send messages from a NIF, or from thread created by NIF, to + any local process (enif_send)</p></item> - <section> - <title>New BIF's</title> - <p> - The BIFs <c>atom_to_binary/2</c>, <c>binary_to_atom/2</c> and - <c>binary_to_existing_atom/2</c> have been added. - </p> - </section> - - <section> - <title>Independent Erlang clusters on the same host</title> - <p> - Nodes belonging to different independent clusters can now - co-exist on the same host with the help of a new - environment variable setting <c>ERL_EPMD_PORT</c>. - The environment variable is used by Erl_interface and J_interface - as well. - </p> - </section> - </section> + <item><p>Store terms between NIF calls (enif_alloc_env, + enif_make_copy)</p></item> - <section> - <title>New Applications</title> + <item><p>Create binary terms with user defined memory management + (enif_make_resource_binary)</p></item> + <item><p>Some incompatible changes made to the API. For more + information see the warning text in erl_nif(3).</p></item> + </list> + </section> <section> - <title>Reltool</title> - - <p> - Reltool is a release management tool. - It analyses a given Erlang/OTP installation and determines - various dependencies between applications. - The graphical frontend depicts the dependencies and enables - interactive customization of a target system. - The backend provides a batch interface for generation of - customized target systems. - The application is still somewhat limited and should be regarded - as experimental in this release. The intention is that this - application will be a valuable tool for making both traditional - Erlang target systems as well as standalone components in Erlang. - </p> + <title>Receive optimizations</title> + <p>Receive statements that can only read out a newly created + reference are now specially optimized so that it will execute + in constant time regardless of the number of messages in the + receive queue for the process. That optimization will benefit + calls to gen_server:call(). (See gen:do_call/4 for an example + of a receive statement that will be optimized.)</p> </section> - <section> - <title>WxErlang</title> - <p> - wxErlang is an Erlang binding to the WxWidgets GUI library which - provides support for cross platform GUI applications. - wxErlang is still in beta status and the intention is that it shall - replace GS in a later stage. The Erlang debugger is also shipped in - a wxErlang version. - </p> + <title>Improved eprof</title> + <p>eprof has been reimplemented with support in the Erlang + virtual machine and is now both faster (i.e. slows down the + code being measured less) and scales much better. In + measurements we saw speed-ups compared to the old eprof + ranging from 6 times (for sequential code that only uses one + scheduler/core) up to 84 times (for parallel code that uses 8 + cores).</p> + + <p>Note: The API for the eprof has been cleaned up and extended. + See the documentation.</p> </section> - - </section> - <section> <title>New features in Existing Applications</title> @@ -162,77 +82,29 @@ <title>Common_test</title> <p> - A support client module for SSH and SFTP, <c>ct_ssh</c>, has - been introduced. - </p> - <p> - Test case groups have been introduced. With this feature - it's possible to execute groups (possibly nested) - of test cases. + It is now possible for the user to provide specific callback + modules that handle test configuration data, so that data on + arbitray form can be accessed (e.g. by reading files or by + communicating with a configuration server process). Two + default callback modules have been introduced in Common Test: + ct_config_plain and ct_config_xml. The former is used to + handle the traditional Common Test configuration files (with + terms on key-value tuple form) and the latter to handle + configuration data on XML representation. </p> <p> - A group definition contains a name tag, a list of - properties and a list of test cases (including possible - nested group definitions). The properties make it possible - to execute test cases in parallel, in sequence and in - shuffled order. It is also possible to repeat test cases - according to different criteria. + The run_test script has been replaced by a program (with the + same name) which can be executed without explicit + installation. The start flags are the same as for the legacy + start script. </p> </section> - - <section> - <title>Dialyzer</title> - <p> - The analysis now accepts <em>opaque type declarations</em> and - detects - violations of opaqueness of terms of such types. Starting - with R13, many Erlang/OTP standard libraries (array, dict, - digraph, ets, gb_sets, gb_trees, queue, and sets) contain - opaque type declarations of their main data types. Dialyzer - will spit out warnings in code that explicitly depends on the - structure of these terms. - </p> - <p> - Added support for handling UTF segments in bitstreams and for - detecting obvious type errors in these segments. Warning: - This code is not terribly tested though since there are very - few Erlang programs which use Unicode-based binaries - not - surprising since this is a new language feature of R13. - </p> - <p> - Strengthened the discrepancy identification when testing for - equality and matching between terms of different types. This - detects more bugs in code. - </p> - <p> - See the Dialyzer documentation and release notes for even more - enhancements. - </p> - </section> - - <section> - <title>SSL</title> - <p> - The "new_ssl" implementation is significantly improved and should be - near product status now. - The new SSL is implemented in pure Erlang except for - the crypto routines that are implemented in the crypto driver which - is an interface to libcrypto from OpenSSL. - </p> - </section> - - <section> <title>STDLIB</title> - - <p>The Erlang scanner has been augmented as to return white-space, - comments and exact location of tokens. - This means that the scanner can easily be used in tools such as editors, - pretty printers, syntax highlighters etc. - where it is important to be able recreate the original source document. + <p> + The module binary from EEP31 (and EEP9) is implemented. </p> </section> - </section> </chapter> diff --git a/system/doc/top/incompatible.xml b/system/doc/top/incompatible.xml index ce9522725b..e09fa7272f 100644 --- a/system/doc/top/incompatible.xml +++ b/system/doc/top/incompatible.xml @@ -4,7 +4,7 @@ <chapter> <header> <copyright> - <year>2006</year><year>2009</year> + <year>2006</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>Potential Incompatibilities</title> @@ -29,353 +29,241 @@ <file>incompatible.xml</file> </header> <p>This document contains a list of potential incompatibilities - between Erlang 5.7/OTP R12A and Erl 5.6.5/OTP R12B-5, + between Erlang 5.8/OTP R14A and Erl 5.7.5/OTP R13B04, and is an extract from the release notes for the respective applications.</p> <section> - <title>compiler</title> + <title>Tools</title> <list type="bulleted"> <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> - <item> - <p>The short-circuit operators <c>andalso</c> and - <c>orelse</c> no longer guarantees that their second - argument is either <c>true</c> or <c>false</c>. As a - consequence, <c>andalso</c>/<c>orelse</c> are now - tail-recursive.</p> - <p> - *** POTENTIAL INCOMPATIBILITY ***</p> + Xref has been updated to use the re module instead of the + deprecated regexp module.</p> + <p>*** INCOMPATIBILITY with R12B ***</p> <p> - Own Id: OTP-7748</p> + Own Id: OTP-8472</p> </item> <item> - <p>The compiler will refuse to a compile file where the - module name in the file differs from the output file - name.</p> - <p>When compiling using <c>erlc</c>, the current working - directory will no be included in the code path (unless - explicitly added using "-pa .").</p> - <p> - *** POTENTIAL INCOMPATIBILITY ***</p> - <p> - Own Id: OTP-7793</p> - </item> - <item> - <p>If a module contains an exported function with the - same name as an auto-imported BIF (such as - <c>length/1</c>), any calls to the BIF must have an - explicit <c>erlang:</c> prefix, or there will be a - compilation error (such calls would only generate a - warning in previous releases).</p> - <p>(The reason for the change is to avoid breaking code - in a future major release, R14 or R15, in which we plan - to make calls without a module prefix always call the - local function in the same module even if there is an - auto-imported BIF with the same name.)</p> + <p>eprof has been reimplemented with support in the Erlang + virtual machine and is now both faster (i.e. slows down the + code being measured less) and scales much better. In + measurements we saw speed-ups compared to the old eprof + ranging from 6 times (for sequential code that only uses one + scheduler/core) up to 84 times (for parallel code that uses 8 + cores).</p> + + <p>Note: The API for the eprof has been cleaned up and extended. + See the documentation.</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7873</p> + Own Id: OTP-8706</p> </item> </list> </section> <section> - <title>Erts</title> + <title>Odbc</title> <list type="bulleted"> <item> - <p>Support for Unicode is implemented as described in - EEP10. Formatting and reading of unicode data both from - terminals and files is supported by the io and io_lib - modules. Files can be opened in modes with automatic - translation to and from different unicode formats. The - module 'unicode' contains functions for conversion - between external and internal unicode formats and the re - module has support for unicode data. There is also - language syntax for specifying string and character data - beyond the ISO-latin-1 range.</p> - <p>The interactive shell will support input and output of - unicode characters when the terminal and operating system - supports it.</p> - <p>Please see the EEP and the io/io_lib manual pages as - well as the stdlib users guide for details.</p> - <p><em>I/O-protocol incompatibilities:</em></p> - <p>The io_protocol between io_Server and client is - updated to handle protocol data in unicode formats. The - updated protocol is now documented. The specification - resides in the stdlib <em>users manual</em>, which is a - new part of the manual.</p> - <p><em>io module incompatibilities:</em></p> - <p>The io:put_chars, io:get_chars and io:get_line all - handle and return unicode data. In the case where - binaries can be provided (as to io:put_chars), they shall - be encoded in UTF-8. When binaries are returned (as by - io:get_line/get_chars when the io_server is set in - <em>binary mode</em>) the returned data is also - <em>always</em> encoded as UTF-8. The file module however - still returns byte-oriented data, why file:read can be - used instead of io:get_chars to read binary data in - ISO-latin-1.</p> - <p><em>io_lib module incompatibilities:</em></p> - <p>io_lib:format can, given new format directives (i.e - "~ts" and "~tc"), return lists containing integers larger - than 255. </p> - <p> - *** POTENTIAL INCOMPATIBILITY ***</p> - <p> - Own Id: OTP-7648 Aux Id: OTP-7580 OTP-7514 OTP-7494 - OTP-7443 OTP-7181 EEP10 EEP11 </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> - <item> - <p>The short-circuit operators <c>andalso</c> and - <c>orelse</c> no longer guarantees that their second - argument is either <c>true</c> or <c>false</c>. As a - consequence, <c>andalso</c>/<c>orelse</c> are now - tail-recursive.</p> + <p> + Now supports SQL_TYPE_TIMESTAMP on the format {{YY, MM, DD}, + {HH, MM, SS}}. Thanks to Juhani Ränkimies. + </p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7748</p> + Own Id: OTP-8511</p> </item> - <item> - <p>The compiler will refuse to a compile file where the - module name in the file differs from the output file - name.</p> - <p>When compiling using <c>erlc</c>, the current working - directory will no be included in the code path (unless - explicitly added using "-pa .").</p> + </list> + </section> + + <section> + <title>Ssh</title> + <list type="bulleted"> + <item> <p> - *** POTENTIAL INCOMPATIBILITY ***</p> + The configuration parameter ip_v6_disabled is now available, + which makes it possible for the user to alter the IP version + SSH shall use.</p> <p> - Own Id: OTP-7793</p> - </item> - <item> - <p>The deprecated functions <c>erlang:fault/1</c>, - <c>erlang:fault/2</c>, and <c>file:rawopen/2</c> have - been removed.</p> + *** POTENTIAL INCOMPATIBILITY ***</p> <p> - *** POTENTIAL INCOMPATIBILITY ***</p> + Own Id: OTP-8535</p> + </item> + <item> <p> - Own Id: OTP-7812</p> - </item> - <item> - <p>The escape sequences <c>\x</c> and <c>\{</c> have been - assigned new interpretations (they used to return the - ASCII code for <c>x</c> and <c>{</c> respectively). One - or more octal characters inside curly brackets after a - leading backslash is from now on an alternative to the - existing syntax <c>\NNN</c>, but can also be used for - codes greater than 255. In a similar fashion, one or more - hexadecimal characters can be put inside curly brackets - after a leading <c>\x</c>. Furthermore, the escape - sequences <c>\xH</c> and <c>\xHH</c>, where N is a - hexadecimal character, can be used for codes less than - 256.</p> - <p>NOTE: These new escape sequences are still considered - experimental and may be changed in the R13B release.</p> + Removed deprecated modules (ssh_ssh, ssh_sshd and ssh_cm) and + functions (ssh_sftp:connect and ssh_sftp:stop).</p> <p> - *** POTENTIAL INCOMPATIBILITY ***</p> + *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7855</p> - </item> - </list> - </section> - - <section> - <title>Inets</title> - <list type="bulleted"> + Own Id: OTP-8596</p> + </item> <item> <p> - [httpc] - The inets http client will now use persistent - connections without pipelining as default and if a - pipeline timeout is set it will pipeline the requests on - the persistent connections.</p> + Aligned error message with used version (SSH_FX_FAILURE vs + SSH_FX_NOT_A_DIRECTORY, the latter introduced in version 6).</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7463</p> - </item> + Own Id: OTP-8644</p> + </item> </list> </section> <section> - <title>Jinterface</title> + <title>ERTS</title> <list> <item> - <p> - A number of fixes and improvements from the ErlIDE group; - Vlad Dumitrescu and Jakob Cederlund: JDK 1.5 is now a - minimal requirement for building Jinterface. New method: - OtpEpmd.lookupNames. OtpErlangList is now iterable. - Non-proper lists are now allowed - you have to test if a - list is proper or not. Non-proper lists can also be - created. New methods: isProper, getHead, getTail and - getNthTail. The get tail methods creates a sublist object - that re-uses the original list. OtpErlangPid is now - Comparable. Empty atoms can now be constructed, a missing - feature pointed out by Sebastien Boisgerault on - erlang-questions.</p> + <p>Some incompatible changes made to the NIF API. For more + information see the warning text in erl_nif(3).</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7832</p> + Own Id: OTP-8555</p> </item> </list> </section> <section> - <title>Kernel</title> + <title>STDLIB</title> <list type="bulleted"> <item> - <p>The deprecated functions <c>erlang:fault/1</c>, - <c>erlang:fault/2</c>, and <c>file:rawopen/2</c> have - been removed.</p> + <p>When defining macros the closing right parenthesis before the + dot is now mandatory.</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7812</p> + Own Id: OTP-8562</p> </item> </list> </section> <section> - <title>SSH</title> + <title>Compiler and STDLIB</title> <list type="bulleted"> <item> <p> - Ssh timeouts will now behave as expected i.e. defaults to - infinity. Only the user of the ssh application can know of - a reasonable timeout value for their application.</p> + Local and imported functions now override the auto-imported + BIFs when the names clash. The pre R14 behaviour was that + auto-imported BIFs would override local functions. To avoid + that old programs change behaviour, the following will + generate an error:</p> + + <list type="bulleted"> + <item>Doing a call without explicit module name to a local function + having a name clashing with the name of an auto-imported BIF + that was present (and auto-imported) before OTP R14A</item> + + <item>Explicitly importing a function having a name clashing with + the name of an autoimported BIF that was present (and + autoimported) before OTP R14A</item> + + <item>Using any form of the old compiler directive nowarn_bif_clash</item> + </list> + + <p>If the BIF was added or auto-imported in OTP R14A or later, + overriding it with an import or a local function will only + result in a warning.</p> + + <p>To resolve clashes, you can either use the explicit module + name erlang to call the BIF, or you can remove the + auto-import of that specific BIF by using the new compiler + directive -compile({no_auto_import,[F/A]})., which makes all + calls to the local or imported function without explicit + module name pass without warnings or errors.</p> + + <p>The change makes it possible to add auto-imported BIFs + without breaking or silently changing old code in the future. + However some current code ingeniously utilizing the old + behaviour or the nowarn_bif_clash compiler directive, might + need changing to be accepted by the compiler.</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7807</p> + Own Id: OTP-8579</p> </item> <item> <p> - Added the message {ssh_channel_up, ChannelId, - ConnectionManager} that shall be handled by the channel - callback handle_msg/2. This makes the function - handle_msg/2 a mandatory function for ssh channels - implementations which it was not in ssh-1.1.</p> + The recently added BIFs erlang:min/2, erlang:max/2 and + erlang:port_command/3 are now auto-imported (as they were + originally intended to be). Due to the recent compiler change + (OTP-8579), the only impact on old code defining it's own + min/2, max/2 or port_command/3 functions will be a warning, + the local functions will still be used. The warning can be + removed by using + -compile({no_auto_import,[min/2,max/2,port_command/3]}). in + the source file.</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7828</p> + Own Id: OTP-8669</p> </item> - </list> - </section> - - <section> - <title>STDLIB</title> - <list type="bulleted"> <item> - <p>The functions <c>lists:seq/1,2</c> return the empty - list in a few cases when they used to generate an - exception, for example <c>lists:seq(1, 0)</c>. See - lists(3) for details. (Thanks to Richard O'Keefe.)</p> <p> - *** POTENTIAL INCOMPATIBILITY ***</p> + Now, binary_to_term/2 is auto-imported. This will cause a + compile warning if and only if a module has got a local + function with that name.</p> <p> - Own Id: OTP-7230</p> - </item> - <item> - <p>Support for Unicode is implemented as described in - EEP10. Formatting and reading of unicode data both from - terminals and files is supported by the io and io_lib - modules. Files can be opened in modes with automatic - translation to and from different unicode formats. The - module 'unicode' contains functions for conversion - between external and internal unicode formats and the re - module has support for unicode data. There is also - language syntax for specifying string and character data - beyond the ISO-latin-1 range.</p> - <p>The interactive shell will support input and output of - unicode characters when the terminal and operating system - supports it.</p> - <p>Please see the EEP and the io/io_lib manual pages as - well as the stdlib users guide for details.</p> - <p><em>I/O-protocol incompatibilities:</em></p> - <p>The io_protocol between io_Server and client is - updated to handle protocol data in unicode formats. The - updated protocol is now documented. The specification - resides in the stdlib <em>users manual</em>, which is a - new part of the manual.</p> - <p><em>io module incompatibilities:</em></p> - <p>The io:put_chars, io:get_chars and io:get_line all - handle and return unicode data. In the case where - binaries can be provided (as to io:put_chars), they shall - be encoded in UTF-8. When binaries are returned (as by - io:get_line/get_chars when the io_server is set in - <em>binary mode</em>) the returned data is also - <em>always</em> encoded as UTF-8. The file module however - still returns byte-oriented data, why file:read can be - used instead of io:get_chars to read binary data in - ISO-latin-1.</p> - <p><em>io_lib module incompatibilities:</em></p> - <p>io_lib:format can, given new format directives (i.e - "~ts" and "~tc"), return lists containing integers larger - than 255. </p> - <p> - *** POTENTIAL INCOMPATIBILITY ***</p> - <p> - Own Id: OTP-7648 Aux Id: OTP-7580 OTP-7514 OTP-7494 - OTP-7443 OTP-7181 EEP10 EEP11 </p> - </item> - <item> - <p> - <c>filelib:fold_files/5</c> now uses the <c>re</c> module - instead of the <c>regexp</c> module for regular - expression matching. In practice, this change will not be - a problem for most regular expressions used for - <c>filelib:fold_files/5</c>. (The major difference in - regular expression is that parenthesis and curly brackets - is treated as literal characters by <c>regexp</c> but as - special characters by <c>re</c>; fortunately, those - characters are rarely used in filenames.)</p> - <p> - *** POTENTIAL INCOMPATIBILITY ***</p> + *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7819</p> + Own Id: OTP-8671</p> </item> + </list> + </section> + + <section> + <title>Erl_interface</title> + <list type="bulleted"> <item> - <p> - <c>digraph:new(Type)</c> will now cause a <c>badarg</c> - exception if <c>Type</c> is not a valid type. Similarly, - <c>digraph_utils:subgraph/2,3</c> will now cause a - <c>badarg</c> if the arguments are invalid. (Those - functions used to return error tuples if something was - wrong.)</p> + <p>Compact IEEE 754 double encoding in external binary format + for ei</p> + + <p>Implement the compact IEEE 754 double encoding in external + binary format for ei. Encoding for ei now always produces the + NEW_FLOAT_EXT format. Decoding and term printing handle both + the old ERL_FLOAT_EXT encoding and the new NEW_FLOAT_EXT + encoding.</p> + + <p>Legacy erl_interface code also handles the new encoding, but + still produces the ERL_FLOAT_EXT encoding by default.</p> + + <p>Also enable the DFLAG_NEW_FLOATS distribution flag.</p> + + <p>ei_get_type() will return ERL_FLOAT_EXT regardless if the + external format is encoded with ERL_FLOAT_EXT or + NEW_FLOAT_EXT for doubles.</p> + + <p>Reduce the number of copies of the code for encoding and + decoding doubles throughout ei and erl_interface by instead + calling the ei encoding and decoding functions wherever + possible.</p> + + <p>Restore commented-out float tests in ei_decode_SUITE and + ei_encode_SUITE in lib/erl_interface/test. Modify them to + make them match the style of other tests in the same suites.</p> + + <p>These changes are based on an ei float patch from Serge + Aleynikov originally submitted against R12B-2 in July 2008 + and reworked by Steve Vinoski May 2010.</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7824</p> + Own Id: OTP-8684</p> </item> + </list> + </section> + <section> + <title>Debugger and STDLIB</title> + <list type="bulleted"> <item> - <p>The argument passed to <c>random:uniform/1</c> must - now be an integer (as stated in the documentation). In - previous releases, a floating point number was also - allowed.</p> + <p> The predefined builtin type tid() has been removed. Instead, + ets:tid() should be used.</p> <p> *** POTENTIAL INCOMPATIBILITY ***</p> <p> - Own Id: OTP-7827</p> + Own Id: OTP-8687</p> </item> </list> </section> diff --git a/system/doc/top/src/erl_html_tools.erl b/system/doc/top/src/erl_html_tools.erl index c920245f94..599268804e 100644 --- a/system/doc/top/src/erl_html_tools.erl +++ b/system/doc/top/src/erl_html_tools.erl @@ -26,7 +26,7 @@ %%----------------------------------------------------------------- -module(erl_html_tools). --export([top_index/0,top_index/1,top_index/3,top_index_silent/3]). +-export([top_index/0,top_index/1,top_index/4,top_index_silent/3]). -include_lib("kernel/include/file.hrl"). @@ -40,7 +40,8 @@ group_order() -> {test, "Test"}, {doc, "Documentation"}, {orb, "Object Request Broker & IDL"}, - {misc, "Miscellaneous"} + {misc, "Miscellaneous"}, + {eric, "Ericsson Internal"} ]. top_index() -> @@ -49,19 +50,22 @@ top_index() -> io:format("Variable ERL_TOP is required\n",[]); Value -> {_,RelName} = init:script_id(), - top_index(Value, filename:join(Value, "doc"), RelName) + top_index(src, Value, filename:join(Value, "doc"), RelName) end. -top_index([RootDir, DestDir, OtpRel]) +top_index([src, RootDir, DestDir, OtpRel]) when is_atom(RootDir), is_atom(DestDir), is_atom(OtpRel) -> - top_index(atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel)); -top_index(RootDir) when is_atom(RootDir) -> + top_index(src, atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel)); +top_index([rel, RootDir, DestDir, OtpRel]) + when is_atom(RootDir), is_atom(DestDir), is_atom(OtpRel) -> + top_index(rel, atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel)); +top_index(RootDir) when is_atom(RootDir) -> {_,RelName} = init:script_id(), - top_index(RootDir, filename:join(RootDir, "doc"), RelName). + top_index(rel, RootDir, filename:join(RootDir, "doc"), RelName). -top_index(RootDir, DestDir, OtpRel) -> +top_index(Source, RootDir, DestDir, OtpRel) -> report("****\nRootDir: ~p", [RootDir]), report("****\nDestDir: ~p", [DestDir]), report("****\nOtpRel: ~p", [OtpRel]), @@ -72,13 +76,13 @@ top_index(RootDir, DestDir, OtpRel) -> report("****\nTemplates: ~p", [Templates]), Bases = [{"../lib/", filename:join(RootDir,"lib")}, {"../", RootDir}], - Groups = find_information(Bases), + Groups = find_information(Source, Bases), report("****\nGroups: ~p", [Groups]), process_templates(Templates, DestDir, Groups). top_index_silent(RootDir, DestDir, OtpRel) -> put(silent,true), - Result = top_index(RootDir, DestDir, OtpRel), + Result = top_index(rel, RootDir, DestDir, OtpRel), erase(silent), Result. @@ -159,8 +163,8 @@ find_templates([], AllSearchPaths) -> % This function read all application names and if present all "info" files. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -find_information(Bases) -> - Paths = find_application_paths(Bases), +find_information(Source, Bases) -> + Paths = find_application_paths(Source, Bases), % report("****\nPaths: ~p", [Paths]), Apps = find_application_infos(Paths), % report("****\nApps: ~p", [Apps]), @@ -176,35 +180,47 @@ find_information(Bases) -> % % We know URL ends in a slash. -find_application_paths([]) -> +find_application_paths(_, []) -> []; -find_application_paths([{URL, Dir} | Paths]) -> +find_application_paths(Source, [{URL, Dir} | Paths]) -> + + AppDirs = get_app_dirs(Dir), + AppPaths = get_app_paths(Source, AppDirs, URL), + AppPaths ++ find_application_paths(Source, Paths). + + +get_app_paths(src, AppDirs, URL) -> Sub1 = "doc/html/index.html", %% Sub2 = "doc/index.html", + lists:map( + fun({App, AppPath}) -> + VsnFile = filename:join(AppPath, "vsn.mk"), + VsnStr = + case file:read_file(VsnFile) of + {ok, Bin} -> + case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of + {match, [V]} -> + V; + nomatch -> + exit(io_lib:format("No VSN variable found in ~s\n", + [VsnFile])) + end; + {error, Reason} -> + exit(io_lib:format("~p : ~s\n", [Reason, VsnFile])) + end, + AppURL = URL ++ App ++ "-" ++ VsnStr, + {App, VsnStr, AppPath, AppURL ++ "/" ++ Sub1} + end, AppDirs); +get_app_paths(rel, AppDirs, URL) -> + Sub1 = "doc/html/index.html", +%% Sub2 = "doc/index.html", + lists:map( + fun({App, AppPath}) -> + [AppName, VsnStr] = string:tokens(App, "-"), + AppURL = URL ++ App, + {AppName, VsnStr, AppPath, AppURL ++ "/" ++ Sub1} + end, AppDirs). - AppDirs = get_app_dirs(Dir), - - AppPaths = - lists:map( - fun({App, AppPath}) -> - VsnFile = filename:join(AppPath, "vsn.mk"), - VsnStr = - case file:read_file(VsnFile) of - {ok, Bin} -> - case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of - {match, [V]} -> - V; - nomatch -> - exit(io_lib:format("No VSN variable found in ~s\n", - [VsnFile])) - end; - {error, Reason} -> - exit(io_lib:format("~p : ~s\n", [Reason, VsnFile])) - end, - AppURL = URL ++ App ++ "-" ++ VsnStr, - {App, VsnStr, AppPath, AppURL ++ "/" ++ Sub1} - end, AppDirs), - AppPaths ++ find_application_paths(Paths). get_app_dirs(Dir) -> {ok, Files} = file:list_dir(Dir), @@ -212,7 +228,7 @@ get_app_dirs(Dir) -> lists:map(fun(File) -> {File, filename:join([Dir, File])} end, Files), lists:zf(fun is_app_with_doc/1, AFiles). -is_app_with_doc({"." ++ ADir, _APath}) -> +is_app_with_doc({"." ++ _ADir, _APath}) -> false; is_app_with_doc({ADir, APath}) -> case file:read_file_info(filename:join([APath, "info"])) of diff --git a/system/doc/top/src/otp_man_index.erl b/system/doc/top/src/otp_man_index.erl index 0fdc531b37..4ad975c53d 100644 --- a/system/doc/top/src/otp_man_index.erl +++ b/system/doc/top/src/otp_man_index.erl @@ -27,14 +27,20 @@ -module(otp_man_index). --export([gen/1]). +-export([gen/1, gen/2]). -include_lib("kernel/include/file.hrl"). -gen([RootDir, OutFile]) when is_atom(RootDir), is_atom(OutFile)-> +gen([Source, RootDir, OutFile]) when is_atom(RootDir), is_atom(OutFile)-> + gen(Source, RootDir, OutFile). + +gen(RootDir, OutFile) -> + gen(rel, RootDir, OutFile). + +gen(Source, RootDir, OutFile) -> Bases = [{"../lib/", filename:join(RootDir, "lib")}, {"../", RootDir}], - Apps = find_application_paths(Bases), + Apps = find_application_paths(Source, Bases), RefPages = find_ref_files(Apps), gen_html(RefPages, atom_to_list(OutFile)). @@ -81,43 +87,52 @@ find_ref_files([{App, Vsn, AppPath, RelPath} |Apps], Acc) -> find_ref_files(Apps, Refs2 ++ Acc) end. -find_application_paths([]) -> +find_application_paths(_, []) -> []; -find_application_paths([{URL, Dir} | Paths]) -> - Sub1 = "doc/html", +find_application_paths(Source, [{URL, Dir} | Paths]) -> AppDirs = get_app_dirs(Dir), - - AppPaths = - lists:map( - fun({App, AppPath}) -> - VsnFile = filename:join(AppPath, "vsn.mk"), - VsnStr = - case file:read_file(VsnFile) of - {ok, Bin} -> - case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of - {match, [V]} -> - V; - nomatch -> - exit(io_lib:format("No VSN variable found in ~s\n", - [VsnFile])) - end; - {error, Reason} -> - exit(io_lib:format("~p : ~s\n", [Reason, VsnFile])) - end, - AppURL = URL ++ App ++ "-" ++ VsnStr, - {App, VsnStr, AppPath ++ "/" ++ Sub1, AppURL ++ "/" ++ Sub1} - end, AppDirs), - AppPaths ++ find_application_paths(Paths). - + AppPaths = get_app_paths(Source, AppDirs, URL), + AppPaths ++ find_application_paths(Source, Paths). +get_app_paths(src, AppDirs, URL) -> + Sub1 = "doc/html", + lists:map( + fun({App, AppPath}) -> + VsnFile = filename:join(AppPath, "vsn.mk"), + VsnStr = + case file:read_file(VsnFile) of + {ok, Bin} -> + case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of + {match, [V]} -> + V; + nomatch -> + exit(io_lib:format("No VSN variable found in ~s\n", + [VsnFile])) + end; + {error, Reason} -> + exit(io_lib:format("~p : ~s\n", [Reason, VsnFile])) + end, + AppURL = URL ++ App ++ "-" ++ VsnStr, + {App, VsnStr, AppPath ++ "/" ++ Sub1, AppURL ++ "/" ++ Sub1} + end, AppDirs); +get_app_paths(rel, AppDirs, URL) -> + Sub1 = "doc/html", + lists:map( + fun({App, AppPath}) -> + [AppName, VsnStr] = string:tokens(App, "-"), + AppURL = URL ++ App, + {AppName, VsnStr, AppPath ++ "/" ++ Sub1, AppURL ++ "/" ++ Sub1} + end, AppDirs). + + get_app_dirs(Dir) -> {ok, Files} = file:list_dir(Dir), AFiles = lists:map(fun(File) -> {File, filename:join([Dir, File])} end, Files), lists:zf(fun is_app_with_doc/1, AFiles). -is_app_with_doc({"." ++ ADir, _APath}) -> +is_app_with_doc({"." ++ _ADir, _APath}) -> false; is_app_with_doc({ADir, APath}) -> case file:read_file_info(filename:join([APath, "info"])) of diff --git a/system/doc/top/templates/index.html.src b/system/doc/top/templates/index.html.src index 88d425ac1d..655f532a5d 100644 --- a/system/doc/top/templates/index.html.src +++ b/system/doc/top/templates/index.html.src @@ -39,10 +39,6 @@ under the License. <small><a href="applications.html">Applications</a><br> <a href="man_index.html">Modules</a></small> <p/> -<small><a href="highlights.html">Release highlights</a><br/> -<a href="incompatible.html">Potential incompatibilities</a><br/> -</small> -<br> <a href="javascript:openAllFlips()">Expand All</a><br> <a href="javascript:closeAllFlips()">Contract All</a> <p/> |