diff options
Diffstat (limited to 'lib/stdlib/doc/src')
| -rw-r--r-- | lib/stdlib/doc/src/c.xml | 12 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/gen_event.xml | 6 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/gen_server.xml | 4 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/gen_statem.xml | 4 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/notes.xml | 163 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/proc_lib.xml | 6 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/shell_docs.xml | 18 | ||||
| -rw-r--r-- | lib/stdlib/doc/src/uri_string.xml | 4 |
8 files changed, 190 insertions, 27 deletions
diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index 04dad1a472..977c819114 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -120,7 +120,7 @@ </func> <func> - <name name="h" arity="1" since="OTP @OTP-16222@"/> + <name name="h" arity="1" since="OTP 23.0"/> <fsummary>Module help information</fsummary> <type name="h_return"/> <desc> @@ -129,7 +129,7 @@ </func> <func> - <name name="h" arity="2" since="OTP @OTP-16222@"/> + <name name="h" arity="2" since="OTP 23.0"/> <fsummary>Function help information</fsummary> <type name="h_return"/> <type name="hf_return"/> @@ -139,7 +139,7 @@ </func> <func> - <name name="h" arity="3" since="OTP @OTP-16222@"/> + <name name="h" arity="3" since="OTP 23.0"/> <fsummary>Function help information</fsummary> <type name="h_return"/> <type name="hf_return"/> @@ -149,7 +149,7 @@ </func> <func> - <name name="ht" arity="1" since="OTP @OTP-16222@"/> + <name name="ht" arity="1" since="OTP 23.0"/> <fsummary>Type help information</fsummary> <type name="h_return"/> <desc> @@ -158,7 +158,7 @@ </func> <func> - <name name="ht" arity="2" since="OTP @OTP-16222@"/> + <name name="ht" arity="2" since="OTP 23.0"/> <fsummary>Type help information</fsummary> <type name="h_return"/> <type name="ht_return"/> @@ -168,7 +168,7 @@ </func> <func> - <name name="ht" arity="3" since="OTP @OTP-16222@"/> + <name name="ht" arity="3" since="OTP 23.0"/> <fsummary>Type help information</fsummary> <type name="h_return"/> <type name="ht_return"/> diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index f9db5ba2a8..eabce3057b 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -524,9 +524,9 @@ gen_event:stop -----> Module:terminate/2 </func> <func> - <name since="OTP @OTP-16120@">start_monitor() -> Result</name> - <name since="OTP @OTP-16120@">start_monitor(EventMgrName | Options) -> Result</name> - <name since="OTP @OTP-16120@">start_monitor(EventMgrName, Options) -> Result</name> + <name since="OTP 23.0">start_monitor() -> Result</name> + <name since="OTP 23.0">start_monitor(EventMgrName | Options) -> Result</name> + <name since="OTP 23.0">start_monitor(EventMgrName, Options) -> Result</name> <fsummary>Create a stand-alone event manager process.</fsummary> <type> <v>EventMgrName = {local,Name} | {global,GlobalName} | {via,Module,ViaName}</v> diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml index 0221319dcc..0ac6715bb0 100644 --- a/lib/stdlib/doc/src/gen_server.xml +++ b/lib/stdlib/doc/src/gen_server.xml @@ -551,8 +551,8 @@ gen_server:abcast -----> Module:handle_cast/2 </func> <func> - <name since="OTP @OTP-16120@">start_monitor(Module, Args, Options) -> Result</name> - <name since="OTP @OTP-16120@">start_monitor(ServerName, Module, Args, Options) -> Result</name> + <name since="OTP 23.0">start_monitor(Module, Args, Options) -> Result</name> + <name since="OTP 23.0">start_monitor(ServerName, Module, Args, Options) -> Result</name> <fsummary>Create a standalone <c>gen_server</c> process.</fsummary> <type> <v>ServerName = {local,Name} | {global,GlobalName}</v> diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml index 466eea6964..6393368e96 100644 --- a/lib/stdlib/doc/src/gen_statem.xml +++ b/lib/stdlib/doc/src/gen_statem.xml @@ -2019,8 +2019,8 @@ handle_event(_, _, State, Data) -> </func> <func> - <name name="start_monitor" arity="3" since="OTP @OTP-16120@"/> - <name name="start_monitor" arity="4" since="OTP @OTP-16120@"/> + <name name="start_monitor" arity="3" since="OTP 23.0"/> + <name name="start_monitor" arity="4" since="OTP 23.0"/> <fsummary>Create a standalone <c>gen_statem</c> process.</fsummary> <desc> <p> diff --git a/lib/stdlib/doc/src/notes.xml b/lib/stdlib/doc/src/notes.xml index 3df13cee27..d5ac48a011 100644 --- a/lib/stdlib/doc/src/notes.xml +++ b/lib/stdlib/doc/src/notes.xml @@ -31,6 +31,169 @@ </header> <p>This document describes the changes made to the STDLIB application.</p> +<section><title>STDLIB 3.12</title> + + <section><title>Improvements and New Features</title> + <list> + <item> + <p> + Improved the printout of single line logger events for + most of the OTP behaviours in STDLIB and Kernel. This + includes <c>proc_lib</c>, <c>gen_server</c>, + <c>gen_event</c>, <c>gen_statem</c>, <c>gen_fsm</c>, + <c>supervisor</c>, <c>supervisor_bridge</c> and + <c>application</c>.</p> + <p> + Improved the <seealso + marker="kernel:logger_formatter#chars_limit"><c>chars_limit</c></seealso> + and <seealso + marker="kernel:logger_formatter#depth"><c>depth</c></seealso> + handling in <c>proc_lib</c> and when formatting of + exceptions.</p> + <p> + Own Id: OTP-15299</p> + </item> + <item> + <p> + Remove usage and documentation of old requests of the + I/O-protocol.</p> + <p> + Own Id: OTP-15695</p> + </item> + <item> + <p>Improved ETS scalability of concurrent calls that + change the size of a table, like <c>ets:insert/2</c> and + <c>ets:delete/2</c>.</p> <p>This performance feature was + implemented for <c>ordered_set</c> in OTP 22.0 and does + now apply for all ETS table types.</p> <p>The improved + scalability may come at the cost of longer latency of + <c>ets:info(T,size)</c> and <c>ets:info(T,memory)</c>. A + new table option <c>decentralized_counters</c> has + therefore been added. It is default <c>true</c> for + <c>ordered_set</c> with <c>write_concurrency</c> enabled + and default <c>false</c> for all other table types.</p> + <p> + Own Id: OTP-15744 Aux Id: OTP-15623, PR-2229 </p> + </item> + <item> + <p> Handle Unicode filenames in the <c>zip</c> module. + </p> + <p> + Own Id: OTP-16005 Aux Id: ERL-1003, ERL-1150 </p> + </item> + <item> + <p> + Unicode support was updated to the Unicode 12.1 standard.</p> + <p> + Own Id: OTP-16073 Aux Id: PR-2339 </p> + </item> + <item> + <p> + All of the modules <seealso + marker="stdlib:proc_lib#start_monitor/3"><c>proc_lib</c></seealso>, + <seealso + marker="stdlib:gen_server#start_monitor/3"><c>gen_server</c></seealso>, + <seealso + marker="stdlib:gen_statem#start_monitor/3"><c>gen_statem</c></seealso>, + and <seealso + marker="stdlib:gen_event#start_monitor/0"><c>gen_event</c></seealso> + have been extended with a <c>start_monitor()</c> + function. For more information, see the documentation of + <c>start_monitor()</c> for these modules.</p> + <p> + Own Id: OTP-16120 Aux Id: ERIERL-402, PR-2427 </p> + </item> + <item> + <p> + Updates for new <c>erlang:term_to_iovec()</c> BIF.</p> + <p> + Own Id: OTP-16128 Aux Id: OTP-15618 </p> + </item> + <item> + <p>Documented a quirk regarding extraction from file + descriptors in <c>erl_tar</c>.</p> + <p> + Own Id: OTP-16171 Aux Id: ERL-1057 </p> + </item> + <item> + <p> + Added <c>ok</c> as return value to + <c>gen_server:reply/2</c></p> + <p> + Own Id: OTP-16210 Aux Id: PR-2411 </p> + </item> + <item> + <p>New functions have been added to <seealso + marker="c"><c>c(3)</c></seealso> for printing embedded + documentation for Erlang modules. The functions are:</p> + <taglist> <tag>h/1,2,3</tag> <item>Print the + documentation for a Module:Function/Arity.</item> + <tag>ht/1,2,3</tag> <item>Print the type documentation + for a Module:Type/Arity.</item> </taglist> <p>The + embedded documentation is created when building the + Erlang/OTP documentation.</p> + <p> + Own Id: OTP-16222</p> + </item> + <item> + <p> Add <c>indent</c> and <c>linewidth</c> to the options + of the <c>erl_pp</c> module's functions. </p> + <p> + Own Id: OTP-16276 Aux Id: PR-2443 </p> + </item> + <item> + <p> + Minor updates due to the new spawn improvements made.</p> + <p> + Own Id: OTP-16368 Aux Id: OTP-15251 </p> + </item> + <item> + <p>Refactored the internal handling of deprecated and + removed functions.</p> + <p> + Own Id: OTP-16469</p> + </item> + <item> + <p> Extend <c>erl_parse:abstract/1,2</c> to handle + external fun expressions (<c>fun M:F/A</c>). </p> + <p> + Own Id: OTP-16480</p> + </item> + <item> + <p>Added <c>filelib:safe_relative_path/2</c> to replace + <c>filename:safe_relative_path/1</c>, which did not + safely handle symbolic links.</p> + <p><c>filename:safe_relative_path/1</c> has been + deprecated.</p> + <p> + Own Id: OTP-16483 Aux Id: PR-2542 </p> + </item> + <item> + <p> + The module <c>shell_docs</c> has been added. The module + contains functions for rendering, validating and + normalizing embedded documentation.</p> + <p> + Own Id: OTP-16500</p> + </item> + <item> + <p> + Module and function auto-completion in the shell now + looks at all available modules instead of only those + loaded. A module is considered available if it either is + loaded already or would be loaded if called.</p> + <p> + The auto-completion has also been expanded to work in the + new <c>h/1,2,3</c> function in <c>c(3)</c>.</p> + <p> + Own Id: OTP-16501 Aux Id: OTP-16494, OTP-16222, + OTP-16406, OTP-16499, OTP-16500, PR-2545, ERL-708 </p> + </item> + </list> + </section> + +</section> + <section><title>STDLIB 3.11.2</title> <section><title>Fixed Bugs and Malfunctions</title> diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml index b5a78ae9f1..b631a04090 100644 --- a/lib/stdlib/doc/src/proc_lib.xml +++ b/lib/stdlib/doc/src/proc_lib.xml @@ -360,9 +360,9 @@ init(Parent) -> </func> <func> - <name name="start_monitor" arity="3" since="OTP @OTP-16120@"/> - <name name="start_monitor" arity="4" since="OTP @OTP-16120@"/> - <name name="start_monitor" arity="5" since="OTP @OTP-16120@"/> + <name name="start_monitor" arity="3" since="OTP 23.0"/> + <name name="start_monitor" arity="4" since="OTP 23.0"/> + <name name="start_monitor" arity="5" since="OTP 23.0"/> <fsummary>Start a new process synchronously.</fsummary> <desc> <p> diff --git a/lib/stdlib/doc/src/shell_docs.xml b/lib/stdlib/doc/src/shell_docs.xml index a3b6f128c3..894f8a5d06 100644 --- a/lib/stdlib/doc/src/shell_docs.xml +++ b/lib/stdlib/doc/src/shell_docs.xml @@ -32,7 +32,7 @@ <rev>A</rev> <file>shell_docs.xml</file> </header> - <module since="OTP @OTP-16222@">shell_docs</module> + <module since="OTP 23.0">shell_docs</module> <modulesummary>Functions used to render documentation for a shell.</modulesummary> <description> <p>This module can be used to render function and type documentation @@ -68,30 +68,30 @@ <funcs> <func> - <name name="render" arity="2" since="OTP @OTP-16222@"/> + <name name="render" arity="2" since="OTP 23.0"/> <fsummary>Render the documentation for a module.</fsummary> <desc> <p>Render the documentation for a module.</p> </desc> </func> <func> - <name name="render" arity="3" since="OTP @OTP-16222@"/> - <name name="render" arity="4" since="OTP @OTP-16222@"/> + <name name="render" arity="3" since="OTP 23.0"/> + <name name="render" arity="4" since="OTP 23.0"/> <fsummary>Render the documentation for a function.</fsummary> <desc> <p>Render the documentation for a function.</p> </desc> </func> <func> - <name name="render_type" arity="2" since="OTP @OTP-16222@"/> + <name name="render_type" arity="2" since="OTP 23.0"/> <fsummary>Render a list of all available types in a module.</fsummary> <desc> <p>Render a list of all available types in a module.</p> </desc> </func> <func> - <name name="render_type" arity="3" since="OTP @OTP-16222@"/> - <name name="render_type" arity="4" since="OTP @OTP-16222@"/> + <name name="render_type" arity="3" since="OTP 23.0"/> + <name name="render_type" arity="4" since="OTP 23.0"/> <fsummary>Render the documentation of a type in a module.</fsummary> <desc> <p>Render the documentation of a type in a module.</p> @@ -99,7 +99,7 @@ </func> <func> - <name name="validate" arity="1" since="OTP @OTP-16222@"/> + <name name="validate" arity="1" since="OTP 23.0"/> <fsummary>Validate the documentation</fsummary> <desc> <p>This function can be used to do a basic validation of @@ -108,7 +108,7 @@ </func> <func> - <name name="normalize" arity="1" since="OTP @OTP-16222@"/> + <name name="normalize" arity="1" since="OTP 23.0"/> <fsummary>Normalize the documentation</fsummary> <desc> <p>This function can be used to do whitespace normalization diff --git a/lib/stdlib/doc/src/uri_string.xml b/lib/stdlib/doc/src/uri_string.xml index cc4186e5ef..21423d4828 100644 --- a/lib/stdlib/doc/src/uri_string.xml +++ b/lib/stdlib/doc/src/uri_string.xml @@ -332,7 +332,7 @@ </func> <func> - <name name="resolve" arity="2" since="OTP @OTP-16321@"/> + <name name="resolve" arity="2" since="OTP 23.0"/> <fsummary>Relative resolution.</fsummary> <desc> <p>Convert a <c><anno>RefURI</anno></c> reference that might be relative @@ -353,7 +353,7 @@ </func> <func> - <name name="resolve" arity="3" since="OTP @OTP-16321@"/> + <name name="resolve" arity="3" since="OTP 23.0"/> <fsummary>Relative resolution.</fsummary> <desc> <p>Same as <c>resolve/2</c> but with an additional |