From 02aca536aec93edd799d67615e47bdb7b5babf4a Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Fri, 9 Oct 2015 13:02:25 +0200 Subject: [kernel] Correct documentation Fix mistakes found by 'xmllint'. --- lib/kernel/doc/src/app.xml | 2 +- lib/kernel/doc/src/application.xml | 5 +++-- lib/kernel/doc/src/auth.xml | 8 ++++---- lib/kernel/doc/src/code.xml | 4 ++-- lib/kernel/doc/src/disk_log.xml | 12 ++++++------ lib/kernel/doc/src/erl_ddll.xml | 22 +++++++++++----------- lib/kernel/doc/src/error_logger.xml | 2 +- lib/kernel/doc/src/file.xml | 25 ++++++++++++------------- lib/kernel/doc/src/gen_sctp.xml | 14 ++++++++------ lib/kernel/doc/src/gen_tcp.xml | 5 +++-- lib/kernel/doc/src/gen_udp.xml | 4 ++-- lib/kernel/doc/src/inet.xml | 30 +++++++++++++++--------------- lib/kernel/doc/src/inet_res.xml | 31 ++++++++++++++++++++----------- lib/kernel/doc/src/net_adm.xml | 4 ++-- lib/kernel/doc/src/notes.xml | 7 +++---- lib/kernel/doc/src/os.xml | 4 ++-- 16 files changed, 95 insertions(+), 84 deletions(-) (limited to 'lib') diff --git a/lib/kernel/doc/src/app.xml b/lib/kernel/doc/src/app.xml index 1591d589af..d6d6167923 100644 --- a/lib/kernel/doc/src/app.xml +++ b/lib/kernel/doc/src/app.xml @@ -191,7 +191,7 @@ RTDeps [ApplicationVersion] [] start phases must be a subset of the set of phases defined for the primary application. Refer to OTP Design Principles for more information.

- runtime_dependencies + runtime_dependencies

A list of application versions that the application depends on. An example of such an application version is "kernel-3.0". Application versions specified as runtime diff --git a/lib/kernel/doc/src/application.xml b/lib/kernel/doc/src/application.xml index 0fe774a73f..4d8e6ce94b 100644 --- a/lib/kernel/doc/src/application.xml +++ b/lib/kernel/doc/src/application.xml @@ -60,8 +60,9 @@ - tuple_of(T) -

A tuple where the elements are of type T.

+ tuple_of(T) +

+ A tuple where the elements are of type T.

 diff --git a/lib/kernel/doc/src/auth.xml b/lib/kernel/doc/src/auth.xml index 9ebc6f8f1a..71b1863e96 100644 --- a/lib/kernel/doc/src/auth.xml +++ b/lib/kernel/doc/src/auth.xml @@ -50,7 +50,7 @@ be established in this case. Returns no if Node does not exist or communication is not authorized (it has another cookie than auth thinks it has).

-

Use net_adm:ping(Node) +

Use net_adm:ping(Node) instead.

@@ -71,7 +71,7 @@

Use - erlang:set_cookie(node(), Cookie) + erlang:set_cookie(node(), Cookie) instead.

 @@ -94,8 +94,8 @@

Sets the magic cookie of Node to Cookie, and verifies the status of the authorization. Equivalent to calling - erlang:set_cookie(Node, Cookie), followed by - auth:is_auth(Node).

+ erlang:set_cookie(Node, Cookie), followed by + auth:is_auth(Node).

 diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index 7cdedfa0ba..4e3be35079 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -180,7 +180,7 @@ example, the call erl_prim_loader:list_dir( "/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/examples/bench)" would list the contents of a directory inside an archive. - See erl_prim_loader(3)

. + See erl_prim_loader(3).

An application archive file and a regular application directory may coexist. This may be useful when there is a need of having @@ -242,7 +242,7 @@ particular useful to set the flag to relaxed when you want to elaborate with code loading from archives without editing the boot script. The default is relaxed. See init(3)

+ marker="erts:init">init(3)

diff --git a/lib/kernel/doc/src/disk_log.xml b/lib/kernel/doc/src/disk_log.xml index 32488a9f01..7d4a9687ea 100644 --- a/lib/kernel/doc/src/disk_log.xml +++ b/lib/kernel/doc/src/disk_log.xml @@ -233,11 +233,11 @@ + Asynchronously log an item onto a disk log. - Asynchronously log an item onto a disk log.

The alog/2 and balog/2 functions asynchronously append an item to a disk log. The function alog/2 is @@ -288,8 +288,8 @@ - Block a disk log. +

With a call to block/1,2 a process can block a log. If the blocking process is not an owner of the log, a temporary @@ -663,8 +663,8 @@ - Close a disk log on one node. +

The function lclose/1 closes a local log or an individual distributed log on the current node. @@ -744,6 +744,7 @@ + Open a disk log file. @@ -753,7 +754,6 @@ - Open a disk log file.

The ArgL parameter is a list of options which have the following meanings:

@@ -1043,8 +1043,8 @@ If - Flush the contents of a disk log to the disk. +

The sync/1 function ensures that the contents of the log are actually written to the disk. @@ -1086,8 +1086,8 @@ If - Unblock a disk log. +

The unblock/1 function unblocks a log. A log can only be unblocked by the blocking process. diff --git a/lib/kernel/doc/src/erl_ddll.xml b/lib/kernel/doc/src/erl_ddll.xml index d622725ba0..8d71883cf4 100644 --- a/lib/kernel/doc/src/erl_ddll.xml +++ b/lib/kernel/doc/src/erl_ddll.xml @@ -388,14 +388,14 @@ remove a monitor.

The function accepts the following parameters:

- Tag + Tag

The monitor tag is always driver as this function can only be used to create driver monitors. In the future, driver monitors will be integrated with process monitors, why this parameter has to be given for consistence.

 - Item + Item

The Item parameter specifies which driver one wants to monitor (the name of the driver) as well as @@ -642,7 +642,7 @@

The function accepts the following parameters:

- Path + Path

The filesystem path to the directory where the driver object file is situated. The filename of the object file @@ -665,7 +665,7 @@ to have only one loader of a driver one wants to upgrade in a running system!

- Name + Name

The name parameter is the name of the driver to be used in subsequent calls to open_port. The @@ -678,14 +678,14 @@ with this Name parameter, much as a beam-file's module name much correspond to its filename.

 - OptionList + OptionList

A number of options can be specified to control the loading operation. The options are given as a list of two-tuples, the tuples having the following values and meanings:

- {driver_options, DriverOptionList} + {driver_options, DriverOptionList}

This option is to provide options that will change its general behavior and will "stick" to the driver @@ -701,7 +701,7 @@ when the last user calls try_unload/2, or the last process having loaded the driver exits.

 - {monitor, MonitorOption} + {monitor, MonitorOption}

A MonitorOption tells try_load/3 to trigger a driver monitor under certain @@ -732,7 +732,7 @@ {monitor, pending_driver} in production code (see the monitor discussion above).

- {reload,ReloadOption} + {reload, ReloadOption}

This option is used when one wants to reload a driver from disk, most often in a @@ -910,13 +910,13 @@

The function accepts the following parameters:

- Name + Name

The name parameter is the name of the driver to be unloaded. The name can be specified either as an iolist() or as an atom().

- OptionList + OptionList

The OptionList argument can be used to specify certain behavior regarding ports as well as triggering @@ -934,7 +934,7 @@ unloads, one should use the driver option kill_ports when loading the driver instead.

 - {monitor, MonitorOption} + {monitor, MonitorOption}

This option creates a driver monitor if the condition given in MonitorOption is true. The valid diff --git a/lib/kernel/doc/src/error_logger.xml b/lib/kernel/doc/src/error_logger.xml index f83fe53084..92e14c2bef 100644 --- a/lib/kernel/doc/src/error_logger.xml +++ b/lib/kernel/doc/src/error_logger.xml @@ -299,12 +299,12 @@ ok + Enable or disable error printouts to a file - Enable or disable error printouts to a file

Enables or disables printout of standard events to a file.

This is done by adding or deleting the standard event handler diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml index 4954568086..9cd4cfa712 100644 --- a/lib/kernel/doc/src/file.xml +++ b/lib/kernel/doc/src/file.xml @@ -87,9 +87,10 @@ - fd() + fd() -

A file descriptor representing a file opened in + A file descriptor representing a file opened in raw mode.

 @@ -491,7 +492,7 @@ List files in a directory -

Lists all files in a directory, except files +

Lists all files in a directory, except files with "raw" names. Returns {ok, Filenames} if successful. Otherwise, it returns {error, Reason}. @@ -1307,15 +1308,15 @@

The current system access to the file.

- atime = date_time() | integer() >= 0 + atime = date_time() | integer() >= 0

The last time the file was read.

 - mtime = date_time() | integer() >= 0 + mtime = date_time() | integer() >= 0

The last time the file was written.

 - ctime = date_time() | integer() >=0 + ctime = date_time() | integer() >=0

The interpretation of this time field depends on the operating system. On Unix, it is the last time @@ -1745,7 +1746,7 @@ See gen_tcp:controlling_process/2

If the OS used does not support sendfile, an Erlang fallback using file:read and gen_tcp:send is used.

-

The option list can contain the following options: +

The option list can contain the following options:

chunk_size The chunk size used by the erlang fallback to send @@ -1760,7 +1761,6 @@ the sendfile call will return {error,einval}. Introduced in Erlang/OTP 17.0. Default is false. -

@@ -1851,22 +1851,21 @@ Type local will interpret the time set as local, universal will interpret it as universal time and posix must be seconds since or before unix time epoch which is 1970-01-01 00:00 UTC. - Default is {time, local}. + Default is {time, local}.

If the raw option is set, the file server will not be called and only informations about local files will be returned.

-

The following fields are used from the record, if they are given.

- atime = date_time() | integer() >= 0 + atime = date_time() | integer() >= 0

The last time the file was read.

 - mtime = date_time() | integer() >= 0 + mtime = date_time() | integer() >= 0

The last time the file was written.

 - ctime = date_time() | integer() >= 0 + ctime = date_time() | integer() >= 0

On Unix, any value give for this field will be ignored (the "ctime" for the file will be set to the current diff --git a/lib/kernel/doc/src/gen_sctp.xml b/lib/kernel/doc/src/gen_sctp.xml index b704d90613..456108a2fe 100644 --- a/lib/kernel/doc/src/gen_sctp.xml +++ b/lib/kernel/doc/src/gen_sctp.xml @@ -77,9 +77,10 @@ - assoc_id() + assoc_id() -

An opaque term returned in for example #sctp_paddr_change{} +

+ An opaque term returned in for example #sctp_paddr_change{} that identifies an association for an SCTP socket. The term is opaque except for the special value 0 that has a meaning such as "the whole endpoint" or "all future associations". @@ -98,9 +99,10 @@ - sctp_socket() + sctp_socket() -

Socket identifier returned from open/*.

+

+ Socket identifier returned from open/*.

@@ -146,7 +148,7 @@ Addr and Port. The Timeout, is expressed in milliseconds. A socket can be associated with multiple peers.

-

WARNING:Using a value of Timeout less than +

WARNING:Using a value of Timeout less than the maximum time taken by the OS to establish an association (around 4.5 minutes if the default values from RFC 4960 are used) can result in inconsistent or incorrect return values. This is especially @@ -170,7 +172,7 @@

The number of outbound and inbound streams can be set by giving an sctp_initmsg option to connect as in:

-
  connect(Socket, Ip, Port,
+
  connect(Socket, Ip, Port>,
         [{sctp_initmsg,#sctp_initmsg{num_ostreams=OutStreams,
                                      max_instreams=MaxInStreams}}])        

         
All options Opt are set on the socket before the
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
index 8d9f09cea7..6a19e76c4f 100644
--- a/lib/kernel/doc/src/gen_tcp.xml
+++ b/lib/kernel/doc/src/gen_tcp.xml
@@ -78,9 +78,10 @@ do_recv(Sock, Bs) ->
       
     
     
-      socket()
+      socket()
       
-        
As returned by accept/1,2 and connect/3,4.

+        

+	As returned by accept/1,2 and connect/3,4.

         
       
     
diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml
index 6f34aba43c..79cd87dcef 100644
--- a/lib/kernel/doc/src/gen_udp.xml
+++ b/lib/kernel/doc/src/gen_udp.xml
@@ -43,9 +43,9 @@
       
     
     
-      socket()
+      socket()
       
-        
As returned by open/1,2.

+        
As returned by open/1,2.

       
     
   
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index e6d418dc58..088d78c1d6 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -4,7 +4,7 @@
 
   

     
-      19972013
+      19972015
       Ericsson AB. All Rights Reserved.
     
     
@@ -117,8 +117,9 @@ fe80::204:acff:fe17:bf38
       
     
     
-      socket()
-      
See gen_tcp(3)
+      socket()
+      

+         See gen_tcp(3)
          and gen_udp(3).

       
     
@@ -222,7 +223,7 @@ fe80::204:acff:fe17:bf38
       

       

 	Do not rely too much on the order of Flag atoms or
-	Ifopt tuples. There are some rules, though:
+	Ifopt tuples. There are some rules, though:

 	
 	  
 	    Immediately after {addr,_} follows {netmask,_}
@@ -238,7 +239,6 @@ fe80::204:acff:fe17:bf38
 	    tuple concerns that address.
 	  
 	
-      

       

 	The {hwaddr,_} tuple is not returned on Solaris since the
 	hardware address historically belongs to the link layer and only
@@ -379,14 +379,14 @@ fe80::204:acff:fe17:bf38
       
       Convert IPv6 / IPV4 adress to ascii
       
-	
Parses an ip_address() and returns an IPv4 or IPv6 address string.

+	
Parses an ip_address() and returns an IPv4 or IPv6 address string.

       
     
     
       
       Parse an IPv4 address
       
-	
Parses an IPv4 address string and returns an ip4_address().
+	
Parses an IPv4 address string and returns an ip4_address().
 	 Accepts a shortened IPv4 shortened address string.

       
     
@@ -394,14 +394,14 @@ fe80::204:acff:fe17:bf38
       
       Parse an IPv4 address strict.
       
-	
Parses an IPv4 address string containing four fields, i.e not shortened, and returns an ip4_address().

+	
Parses an IPv4 address string containing four fields, i.e not shortened, and returns an ip4_address().

       
     
     
       
       Parse an IPv6 address
       
-	
Parses an IPv6 address string and returns an ip6_address().
+	
Parses an IPv6 address string and returns an ip6_address().
 	 If an IPv4 address string is passed, an IPv4-mapped IPv6 address is returned.

       
     
@@ -409,22 +409,22 @@ fe80::204:acff:fe17:bf38
       
       Parse an IPv6 address strict.
       
-	
Parses an IPv6 address string and returns an ip6_address().
-	Does not accept IPv4 adresses.

+	
Parses an IPv6 address string and returns an ip6_address().
+	Does not accept IPv4 adresses.

       
     
     
       
       Parse an IPv4 or IPv6 address.
       
-	
Parses an IPv4 or IPv6 address string and returns an ip4_address() or ip6_address(). Accepts a shortened IPv4 address string.

+	
Parses an IPv4 or IPv6 address string and returns an ip4_address() or ip6_address(). Accepts a shortened IPv4 address string.

       
     
     
       
       Parse an IPv4 or IPv6 address strict.
       
-	
Parses an IPv4 or IPv6 address string and returns an ip4_address() or ip6_address(). Does not accept a shortened IPv4 address string.

+	
Parses an IPv4 or IPv6 address string and returns an ip4_address() or ip6_address(). Does not accept a shortened IPv4 address string.

       
     
     
@@ -862,10 +862,10 @@ fe80::204:acff:fe17:bf38
 	    CAP_SYS_ADMIN according to the documentation for setns(2).
 	    However, during testing also CAP_SYS_PTRACE
 	    and CAP_DAC_READ_SEARCH has proven to be necessary.
-	    Example:
+	    Example:

 setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp
 
-            Note also that the filesystem containing the virtual machine
+            
Note also that the filesystem containing the virtual machine
 	    executable (beam.smp in the example above) has to be local,
 	    mounted without the nosetuid flag,
 	    support extended attributes and that
diff --git a/lib/kernel/doc/src/inet_res.xml b/lib/kernel/doc/src/inet_res.xml
index 6a2c9b1955..851a36aba9 100644
--- a/lib/kernel/doc/src/inet_res.xml
+++ b/lib/kernel/doc/src/inet_res.xml
@@ -4,7 +4,7 @@
 
   

     
-      20092013
+      20092015
       Ericsson AB. All Rights Reserved.
     
     
@@ -77,8 +77,11 @@
       query is tried for the alt_nameservers.
+
+ Resolver Types +

The following data types concern the resolver:

+
-

Resolver types:

@@ -88,8 +91,13 @@ - -

DNS types:

+ +
+ DNS Types +

+ The following data types concern the DNS client:

+
+

A string with no adjacent dots.

 @@ -106,7 +114,7 @@

This is the start of a hiearchy of opaque data structures that can be examined with access functions in inet_dns that return lists of {Field,Value} tuples. The arity 2 functions - just return the value for a given field. + just return the value for a given field.

 dns_msg() = DnsMsg
     inet_dns:msg(DnsMsg) ->
@@ -154,18 +162,19 @@ dns_rr() = DnsRr
                      | {version, integer()}
                      | {z, integer()}
                      | {data, dns_data()} ]
-    inet_dns:rr(DnsRr, Field) -> Value
+    inet_dns:rr(DnsRr, Field) -> Value
-There is an info function for the types above: +

There is an info function for the types above:

+
 inet_dns:record_type(dns_msg()) -> msg;
 inet_dns:record_type(dns_header()) -> header;
 inet_dns:record_type(dns_query()) -> dns_query;
 inet_dns:record_type(dns_rr()) -> rr;
-inet_dns:record_type(_) -> undefined.
+inet_dns:record_type(_) -> undefined.
-So; inet_dns:(inet_dns:record_type(X))(X) will convert -any of these data structures into a {Field,Value} list.

+

So; inet_dns:(inet_dns:record_type(X))(X) will convert +any of these data structures into a {Field,Value} list.

 @@ -272,7 +281,7 @@ any of these data structures into a {Field,Value} list.

Resolve a DNS record of the given type and class for the given name. The returned dns_msg() can be examined using access functions in inet_db as described - in DNS types. + in DNS Types.

If Name is an ip_address(), the domain name to query for is generated as the standard reverse diff --git a/lib/kernel/doc/src/net_adm.xml b/lib/kernel/doc/src/net_adm.xml index 1072be44a5..4ef9d361f6 100644 --- a/lib/kernel/doc/src/net_adm.xml +++ b/lib/kernel/doc/src/net_adm.xml @@ -89,8 +89,8 @@ - Lookup and connect to all nodes at all hosts in .hosts.erlang +

This function calls names(Host) for all hosts which are specified in the Erlang host file .hosts.erlang, @@ -110,8 +110,8 @@ - Lookup and connect to all nodes at specified hosts +

As world/0,1, but the hosts are given as argument instead of being read from .hosts.erlang.

diff --git a/lib/kernel/doc/src/notes.xml b/lib/kernel/doc/src/notes.xml index 76db0c201f..268a8404f1 100644 --- a/lib/kernel/doc/src/notes.xml +++ b/lib/kernel/doc/src/notes.xml @@ -1218,7 +1218,7 @@

Fix returned error from gen_tcp:accept/1,2 when - running out of ports + running out of ports.

The {error, enfile} return value is badly misleading and confusing for this case, since the Posix ENFILE errno @@ -1227,7 +1227,7 @@ {error, system_limit}, which is consistent with e.g. various file(3) functions. inet:format_error/1 has also been updated to support system_limit in the same manner - as file:format_error/1. (Thanks to Per Hedeland)

+ as file:format_error/1. (Thanks to Per Hedeland)

Own Id: OTP-9990

 @@ -1422,7 +1422,6 @@ Own Id: OTP-9764

-

Correct callback spec in application module

Refine warning about callback specs with extra ranges

Cleanup @@ -1433,7 +1432,7 @@ analysis

Fix crash in Dialyzer

Variable substitution was not generalizing any unknown variables.

 -

+

Own Id: OTP-9776

diff --git a/lib/kernel/doc/src/os.xml b/lib/kernel/doc/src/os.xml index 2d2a690fea..682d4a2eac 100644 --- a/lib/kernel/doc/src/os.xml +++ b/lib/kernel/doc/src/os.xml @@ -171,8 +171,8 @@ DirOut = os:cmd("dir"), % on Win32 platform - Timestamp = {MegaSecs, Secs, MicroSecs} Current OS system time on the erlang:timestamp/0 format + Timestamp = {MegaSecs, Secs, MicroSecs}

Returns current OS system time @@ -205,7 +205,7 @@ format_utc_timestamp() -> 29 Apr 2009 9:55:30.051711

OS system time can also be retreived by - os:system_time/0, + os:system_time/0, and os:system_time/1.

 -- cgit v1.2.3 From de432f4ea9a8c29c931f30dd504662be1a01464d Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Mon, 12 Oct 2015 14:28:39 +0200 Subject: [stdlib] Correct documentation Fix mistakes found by 'xmllint'. --- lib/stdlib/doc/src/array.xml | 4 +-- lib/stdlib/doc/src/assert_hrl.xml | 11 +++---- lib/stdlib/doc/src/beam_lib.xml | 4 +-- lib/stdlib/doc/src/binary.xml | 4 +-- lib/stdlib/doc/src/c.xml | 2 +- lib/stdlib/doc/src/calendar.xml | 4 +-- lib/stdlib/doc/src/dets.xml | 56 ++++++++++++++++++------------------ lib/stdlib/doc/src/digraph.xml | 6 ++-- lib/stdlib/doc/src/digraph_utils.xml | 5 ++-- lib/stdlib/doc/src/epp.xml | 2 +- lib/stdlib/doc/src/erl_anno.xml | 34 +++++++++++----------- lib/stdlib/doc/src/erl_parse.xml | 2 +- lib/stdlib/doc/src/erl_pp.xml | 4 +-- lib/stdlib/doc/src/erl_scan.xml | 36 +++++++++++------------ lib/stdlib/doc/src/erl_tar.xml | 3 +- lib/stdlib/doc/src/ets.xml | 13 +++++---- lib/stdlib/doc/src/file_sorter.xml | 52 ++++++++++++++++----------------- lib/stdlib/doc/src/gen_event.xml | 4 +-- lib/stdlib/doc/src/gen_fsm.xml | 2 +- lib/stdlib/doc/src/gen_server.xml | 2 +- lib/stdlib/doc/src/io.xml | 18 ++++++------ lib/stdlib/doc/src/lists.xml | 6 ++-- lib/stdlib/doc/src/math.xml | 2 +- lib/stdlib/doc/src/notes.xml | 53 +++++++++++++++++++--------------- lib/stdlib/doc/src/random.xml | 12 ++++++-- lib/stdlib/doc/src/re.xml | 16 +++++------ lib/stdlib/doc/src/sofs.xml | 5 ++-- lib/stdlib/doc/src/supervisor.xml | 2 +- lib/stdlib/doc/src/sys.xml | 4 +-- lib/stdlib/doc/src/timer.xml | 8 ------ lib/stdlib/doc/src/zip.xml | 2 +- 31 files changed, 192 insertions(+), 186 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/doc/src/array.xml b/lib/stdlib/doc/src/array.xml index 28b4435938..0f33e2621c 100644 --- a/lib/stdlib/doc/src/array.xml +++ b/lib/stdlib/doc/src/array.xml @@ -164,7 +164,7 @@ the default value cannot be confused with the values of set entries.

-

Equivalent to from_list(List, undefined).

+

Equivalent to from_list(List, undefined).

 @@ -184,7 +184,7 @@ the default value cannot be confused with the values of set entries.

-

Equivalent to from_orddict(Orddict, undefined).

+

Equivalent to from_orddict(Orddict, undefined).

 diff --git a/lib/stdlib/doc/src/assert_hrl.xml b/lib/stdlib/doc/src/assert_hrl.xml index b85be514d8..ef4f928e57 100644 --- a/lib/stdlib/doc/src/assert_hrl.xml +++ b/lib/stdlib/doc/src/assert_hrl.xml @@ -76,9 +76,6 @@ erlc -DNOASSERT=true *.erl -
-
-
Macros @@ -94,12 +91,12 @@ erlc -DNOASSERT=true *.erl assertMatch(GuardedPattern, Expr)

Tests that Expr completes normally yielding a value - that matches GuardedPattern. For example: + that matches GuardedPattern. For example:

- ?assertMatch({bork, _}, f())

-

Note that a guard when ... can be included: + ?assertMatch({bork, _}, f()) +

Note that a guard when ... can be included:

- ?assertMatch({bork, X} when X > 0, f())

+ ?assertMatch({bork, X} when X > 0, f()) assertNotMatch(GuardedPattern, Expr) diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index faf668735e..7c89c8b43e 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -4,7 +4,7 @@
- 20002013 + 20002015 Ericsson AB. All Rights Reserved. @@ -71,6 +71,7 @@ using strip/1, strip_files/1 and/or strip_release/1.

+
Reconstructing source code

Here is an example of how to reconstruct source code from @@ -152,7 +153,6 @@ keys.

- diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml index 063f3048e0..2682198fe5 100644 --- a/lib/stdlib/doc/src/binary.xml +++ b/lib/stdlib/doc/src/binary.xml @@ -299,8 +299,8 @@ - Searches for the first match of a pattern in a binary +

Searches for the first occurrence of Pattern in Subject and @@ -353,8 +353,8 @@ - Searches for all matches of a pattern in a binary +

Works like match/2, but the Subject is searched until diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index a0f18bd899..e5238fa7db 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -121,12 +121,12 @@ compile:file(File, Options ++ [report_errors, report_w lc(Files) -> ok + Compile a list of files Files = [File] File = file:filename() - Compile a list of files

Compiles a list of files by calling compile:file(File, [report_errors, report_warnings]) for each File in Files.

diff --git a/lib/stdlib/doc/src/calendar.xml b/lib/stdlib/doc/src/calendar.xml index a8d933dc83..853184dc0f 100644 --- a/lib/stdlib/doc/src/calendar.xml +++ b/lib/stdlib/doc/src/calendar.xml @@ -130,11 +130,11 @@ + Compute the number of days from year 0 up to the given date - Compute the number of days from year 0 up to the given date

This function computes the number of gregorian days starting with year 0 and ending at the given date.

@@ -347,11 +347,11 @@ + Check if a date is valid - Check if a date is valid

This function checks if a date is a valid.

 diff --git a/lib/stdlib/doc/src/dets.xml b/lib/stdlib/doc/src/dets.xml index 14237b6f90..a0d3f95b6a 100644 --- a/lib/stdlib/doc/src/dets.xml +++ b/lib/stdlib/doc/src/dets.xml @@ -316,20 +316,20 @@ bytes.

-

{filename, file:name()}, +

{filename, file:name()}, the name of the file where objects are stored.

 -

{keypos, keypos()} - , the position of the key.

+

{keypos, keypos() + }, the position of the key.

{size, integer() >= 0}, the number of objects stored in the table.

 -

{type, type()}, - the type of the table.

+

{type, type() + }, the type of the table.

 @@ -345,12 +345,12 @@ allowed:

-

{access, access()} - , the access mode.

+

{access, access() + }, the access mode.

 -

{auto_save, - auto_save()}, the auto save interval.

+

{auto_save, + auto_save()}, the auto save interval.

{bchunk_format, binary()}, an opaque binary @@ -730,16 +730,16 @@ ok tuples where the following values are allowed:

-

{access, - access()}. It is possible to open +

{access, + access()}. It is possible to open existing tables in read-only mode. A table which is opened in read-only mode is not subjected to the automatic file reparation algorithm if it is later opened after a crash. The default value is read_write.

 -

{auto_save, - auto_save()}, the auto save +

{auto_save, + auto_save()}, the auto save interval. If the interval is an integer Time, the table is flushed to disk whenever it is not accessed for Time milliseconds. A table that has been flushed @@ -749,18 +749,18 @@ ok is 180000 (3 minutes).

 -

{estimated_no_objects, - no_slots()}. Equivalent to the +

{estimated_no_objects, + no_slots()}. Equivalent to the min_no_slots option.

 -

{file, - file:name()}, the name of the file to be +

{file, + file:name()}, the name of the file to be opened. The default value is the name of the table.

 -

{max_no_slots, - no_slots()}, the maximum number +

{max_no_slots, + no_slots()}, the maximum number of slots that will be used. The default value as well as the maximal value is 32 M. Note that a higher value may increase the fragmentation of the table, and conversely, @@ -769,16 +769,16 @@ ok 9 tables.

 -

{min_no_slots, - no_slots()}. Application +

{min_no_slots, + no_slots()}. Application performance can be enhanced with this flag by specifying, when the table is created, the estimated number of different keys that will be stored in the table. The default value as well as the minimum value is 256.

 -

{keypos, - keypos()}, the position of the +

{keypos, + keypos()}, the position of the element of each object to be used as key. The default value is 1. The ability to explicitly state the key position is most convenient when we want to store Erlang @@ -815,12 +815,12 @@ ok already open.

 -

{type, type()}, +

{type, type()}, the type of the table. The default value is set.

 -

{version, - version()}, the version of the format +

{version, + version()}, the version of the format used for the table. The default value is 9. Tables on the format used before OTP R8 can be created by giving the value 8. A version 8 table can be converted to @@ -1036,8 +1036,8 @@ ok specification that matches all objects.

 -

{select, - match_spec()}. As for select +

{select, + match_spec()}. As for select the table is traversed by calling dets:select/3 and dets:select/1. The difference is that the match specification is explicitly given. This is how to diff --git a/lib/stdlib/doc/src/digraph.xml b/lib/stdlib/doc/src/digraph.xml index 49dc68e103..291be6c08b 100644 --- a/lib/stdlib/doc/src/digraph.xml +++ b/lib/stdlib/doc/src/digraph.xml @@ -103,13 +103,15 @@

A digraph as returned by new/0,1.

 - edge() + edge() +

- vertex() + vertex() +

diff --git a/lib/stdlib/doc/src/digraph_utils.xml b/lib/stdlib/doc/src/digraph_utils.xml index 6a4db2e963..639069543c 100644 --- a/lib/stdlib/doc/src/digraph_utils.xml +++ b/lib/stdlib/doc/src/digraph_utils.xml @@ -122,8 +122,9 @@ - digraph() -

A digraph as returned by digraph:new/0,1.

 + digraph() +

+ A digraph as returned by digraph:new/0,1.

 diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml index fe2944bbf7..8c901f57ec 100644 --- a/lib/stdlib/doc/src/epp.xml +++ b/lib/stdlib/doc/src/epp.xml @@ -39,7 +39,7 @@ by compile to preprocess macros and include files before the actual parsing takes place.

The Erlang source file encoding is selected by a + id="encoding"/>encoding is selected by a comment in one of the first two lines of the source file. The first string that matches the regular expression coding\s*[:=]\s*([-a-zA-Z0-9])+ selects the encoding. If diff --git a/lib/stdlib/doc/src/erl_anno.xml b/lib/stdlib/doc/src/erl_anno.xml index be0ffe6f4d..ddc8b8c765 100644 --- a/lib/stdlib/doc/src/erl_anno.xml +++ b/lib/stdlib/doc/src/erl_anno.xml @@ -44,7 +44,7 @@

This module implements an abstract type that is used by the Erlang Compiler and its helper modules for holding data such as column, line number, and text. The data type is a collection of - annotations as + annotations as described in the following.

The Erlang Token Scanner returns tokens with a subset of the following annotations, depending on the options:

@@ -102,8 +102,8 @@ - anno() -

A collection of annotations.

+ anno() +

A collection of annotations.

 @@ -133,8 +133,8 @@ - Return the column +

Returns the column of the annotations Anno.

@@ -142,8 +142,8 @@ - Return the end location of the text +

Returns the end location of the text of the annotations Anno. If there is no text, @@ -153,8 +153,8 @@ - Return the filename +

Returns the filename of the annotations Anno. If there is no filename, undefined is returned. @@ -180,8 +180,8 @@ - Return the generated Boolean +

Returns true if the annotations Anno has been marked as generated. The default is to return @@ -199,8 +199,8 @@ - Return the line +

Returns the line of the annotations Anno.

@@ -208,8 +208,8 @@ - Return the location +

Returns the location of the annotations Anno.

@@ -217,16 +217,16 @@ - Create a new collection of annotations +

Creates a new collection of annotations given a location.

 - Modify the filename +

Modifies the filename of the annotations Anno.

@@ -234,8 +234,8 @@ - Modify the generated marker +

Modifies the generated marker of the annotations Anno. @@ -244,8 +244,8 @@ - Modify the line +

Modifies the line of the annotations Anno.

@@ -253,8 +253,8 @@ - Modify the location +

Modifies the location of the annotations Anno.

@@ -262,8 +262,8 @@ - Modify the record marker +

Modifies the record marker of the annotations Anno.

@@ -271,8 +271,8 @@ - Modify the text +

Modifies the text of the annotations Anno.

@@ -280,8 +280,8 @@ - Return the text +

Returns the text of the annotations Anno. If there is no text, undefined is returned. diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml index fdd776b7f1..0938b5dec3 100644 --- a/lib/stdlib/doc/src/erl_parse.xml +++ b/lib/stdlib/doc/src/erl_parse.xml @@ -174,8 +174,8 @@ - Convert an Erlang term into an abstract form +

Converts the Erlang data structure Data into an abstract form of type AbsTerm.

diff --git a/lib/stdlib/doc/src/erl_pp.xml b/lib/stdlib/doc/src/erl_pp.xml index c9d9e2723d..4b8a571c81 100644 --- a/lib/stdlib/doc/src/erl_pp.xml +++ b/lib/stdlib/doc/src/erl_pp.xml @@ -48,8 +48,8 @@ -

The optional argument - HookFunction, shown in the functions described below, +

The optional argument + HookFunction, shown in the functions described below, defines a function which is called when an unknown form occurs where there should be a valid expression.

diff --git a/lib/stdlib/doc/src/erl_scan.xml b/lib/stdlib/doc/src/erl_scan.xml index 18e988e286..342f491dd0 100644 --- a/lib/stdlib/doc/src/erl_scan.xml +++ b/lib/stdlib/doc/src/erl_scan.xml @@ -181,10 +181,10 @@ + Re-entrant scanner An opaque continuation - Re-entrant scanner

This is the re-entrant scanner which scans characters until a dot ('.' followed by a white space) or @@ -324,9 +324,9 @@ + Return information about a token - Return information about a token

Returns a list containing information about the token Token. If one single @@ -345,28 +345,28 @@

The following TokenInfoTuples with corresponding TokenItems are valid:

- {category, - category()} + {category, + category()}

The category of the token.

 - {column, - column()} + {column, + column()}

The column where the token begins.

 {length, integer() > 0}

The length of the token's text.

 - {line, - line()} + {line, + line()}

The line where the token begins.

 - {location, - location()} + {location, + location()}

The line and column where the token begins, or just the line if the column unknown.

 - {symbol, - symbol()} + {symbol, + symbol()}

The token's symbol.

 {text, string()} @@ -416,19 +416,19 @@

The following AttributeInfoTuples with corresponding AttributeItems are valid:

- {column, - column()} + {column, + column()}

The column where the token begins.

 {length, integer() > 0}

The length of the token's text.

 - {line, - line()} + {line, + line()}

The line where the token begins.

 - {location, - location()} + {location, + location()}

The line and column where the token begins, or just the line if the column unknown.

 diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 0fa5a55c5b..898b55df72 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -442,7 +442,7 @@ structure like a file descriptor, a sftp channel id or such. The different Fun clauses operates on that very term.

-

The fun clauses parameter lists are: +

The fun clauses parameter lists are:

(write, {UserPrivate,DataToWrite}) Write the term DataToWrite using UserPrivate @@ -457,7 +457,6 @@ -

A complete Fun parameter for reading and writing on files using the file module could be:

diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index ee2bf96cb7..7b01109ff8 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -132,9 +132,10 @@ - continuation() + continuation() -

Opaque continuation used by +

+ Opaque continuation used by select/1,3, select_reverse/1,3, @@ -448,13 +449,13 @@ Error: fun containing local Erlang function calls {owner, pid()}

The pid of the owner of the table. - {protection, access()}

+ {protection, access()}

The table access rights. {size, integer() >= 0

The number of objects inserted in the table. - {type, type()}

+ {type, type()}

The table type. {read_concurrency, boolean()}

@@ -1626,6 +1627,7 @@ true + Update a counter object in an ETS table. @@ -1633,7 +1635,6 @@ true - Update a counter object in an ETS table.

This function provides an efficient way to update one or more counters, without the hassle of having to look up an object, update @@ -1700,11 +1701,11 @@ true + Updates the Pos:th element of the object with a given key in an ETS table. - Updates the Pos:th element of the object with a given key in an ETS table.

This function provides an efficient way to update one or more elements within an object, without the hassle of having to look up, diff --git a/lib/stdlib/doc/src/file_sorter.xml b/lib/stdlib/doc/src/file_sorter.xml index 30e09c17b0..f033eebec7 100644 --- a/lib/stdlib/doc/src/file_sorter.xml +++ b/lib/stdlib/doc/src/file_sorter.xml @@ -223,82 +223,82 @@ output(L) -> -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index 1efac1535a..c4bab45781 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -716,7 +716,7 @@ gen_event:stop -----> Module:terminate/2 the purposes described below.

This function is called by a gen_event process when:

- + One of sys:get_status/1,2 is invoked to get the gen_event status. Opt is set @@ -740,7 +740,7 @@ gen_event:stop -----> Module:terminate/2 customises the details of the current state of the event handler. Any term is allowed for Status. The gen_event module uses Status as follows:

- + When sys:get_status/1,2 is called, gen_event ensures that its return value contains Status in place of the event handler's actual state term. diff --git a/lib/stdlib/doc/src/gen_fsm.xml b/lib/stdlib/doc/src/gen_fsm.xml index a8d7fadeb4..4d594b8eb2 100644 --- a/lib/stdlib/doc/src/gen_fsm.xml +++ b/lib/stdlib/doc/src/gen_fsm.xml @@ -805,7 +805,7 @@ gen_fsm:sync_send_all_state_event -----> Module:handle_sync_event/4 module state data.

This function is called by a gen_fsm process when:

- + One of sys:get_status/1,2 is invoked to get the gen_fsm status. Opt is set to diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml index c31e869db8..6d04771cd4 100644 --- a/lib/stdlib/doc/src/gen_server.xml +++ b/lib/stdlib/doc/src/gen_server.xml @@ -673,7 +673,7 @@ gen_server:abcast -----> Module:handle_cast/2 module state.

This function is called by a gen_server process when:

- + One of sys:get_status/1,2 is invoked to get the gen_server status. Opt is set diff --git a/lib/stdlib/doc/src/io.xml b/lib/stdlib/doc/src/io.xml index edf3c51b4c..4655c8662f 100644 --- a/lib/stdlib/doc/src/io.xml +++ b/lib/stdlib/doc/src/io.xml @@ -132,8 +132,8 @@ - Read a specified number of characters +

Reads Count characters from standard input (IoDevice), prompting it with Prompt. It @@ -162,8 +162,8 @@ - Read a line +

Reads a line from the standard input (IoDevice), prompting it with Prompt. It returns:

@@ -300,8 +300,8 @@ - Read a term +

Reads a term Term from the standard input (IoDevice), prompting it with Prompt. It @@ -330,8 +330,8 @@ - Read a term +

Reads a term Term from IoDevice, prompting it with Prompt. Reading starts at location @@ -698,8 +698,8 @@ ok - Read formatted input +

Reads characters from the standard input (IoDevice), prompting it with Prompt. Interprets the characters in @@ -870,8 +870,8 @@ enter>: alan : joe - Read and tokenize Erlang expressions +

Reads data from the standard input (IoDevice), prompting it with Prompt. Reading starts at location @@ -919,8 +919,8 @@ enter>1.0er. - Read and tokenize an Erlang form +

Reads data from the standard input (IoDevice), prompting it with Prompt. Starts reading @@ -939,9 +939,9 @@ enter>1.0er. + Read, tokenize and parse Erlang expressions - Read, tokenize and parse Erlang expressions

Reads data from the standard input (IoDevice), prompting it with @@ -990,9 +990,9 @@ enter>abc("hey". + Read, tokenize and parse an Erlang form - Read, tokenize and parse an Erlang form

Reads data from the standard input (IoDevice), prompting it with Prompt. Starts reading at diff --git a/lib/stdlib/doc/src/lists.xml b/lib/stdlib/doc/src/lists.xml index 46edd9fe16..89ba5238b5 100644 --- a/lib/stdlib/doc/src/lists.xml +++ b/lib/stdlib/doc/src/lists.xml @@ -283,8 +283,8 @@ flatmap(Fun, List1) -> - 1..tuple_size(Tuple) Search for an element in a list of tuples + 1..tuple_size(Tuple)

Searches the list of tuples TupleList for a tuple whose Nth element compares equal to Key. @@ -311,8 +311,8 @@ flatmap(Fun, List1) -> - 1..tuple_size(Tuple) Test for membership of a list of tuples + 1..tuple_size(Tuple)

Returns true if there is a tuple in TupleList whose Nth element compares equal to Key, otherwise @@ -346,8 +346,8 @@ flatmap(Fun, List1) -> - 1..tuple_size(Tuple) Search for an element in a list of tuples + 1..tuple_size(Tuple)

Searches the list of tuples TupleList for a tuple whose Nth element compares equal to Key. diff --git a/lib/stdlib/doc/src/math.xml b/lib/stdlib/doc/src/math.xml index 31e838d741..aee6c3f238 100644 --- a/lib/stdlib/doc/src/math.xml +++ b/lib/stdlib/doc/src/math.xml @@ -72,9 +72,9 @@ + Diverse math functions - Diverse math functions

A collection of math functions which return floats. Arguments are numbers.

diff --git a/lib/stdlib/doc/src/notes.xml b/lib/stdlib/doc/src/notes.xml index bdd0680038..c84ca9c8ad 100644 --- a/lib/stdlib/doc/src/notes.xml +++ b/lib/stdlib/doc/src/notes.xml @@ -154,8 +154,9 @@ Correct maps module error exceptions

Bad input to maps module function will now yield the - following exceptions: {badmap,NotMap} - or, badarg

+ following exceptions:

+ {badmap, NotMap}, or badarg. +

Own Id: OTP-12657

 @@ -253,12 +254,11 @@

proc_lib:stop/1,3 is used by the following functions:

-

gen_server:stop/1,3 (new) gen_fsm:stop/1,3 (new) gen_event:stop/1,3 (modified to be synchronous) wx_object:stop/1,3 - (new)

+ (new)

Own Id: OTP-11173 Aux Id: seq12353

@@ -865,8 +865,7 @@ also implemented by the generic behaviours gen_server, gen_event and gen_fsm.

- The potential incompatibility refers to

-

+ The potential incompatibility refers to:

The previous behaviour of intercepting the system message and passing a tuple of size 2 as the last argument to sys:handle_system_msg/6 is no longer @@ -874,7 +873,7 @@ StateFun in sys:replace_state/2,3 fails is changed from being totally silent to possibly (if the callback module does not catch) throw an exception in the - client process.

+ client process.

(Thanks to James Fish and Steve Vinoski)

@@ -1036,22 +1035,28 @@

EEP43: New data type - Maps

- With Maps you may for instance: M0 = - #{ a => 1, b => 2}, % create - associations M1 = M0#{ a := 10 }, % - update values M2 = M1#{ "hi" => - "hello"}, % add new associations #{ - "hi" := V1, a := V2, b := V3} = M2. % match keys with - values

+ With Maps you may for instance:

+ + M0 = #{ a => 1, b => 2}, % create + associations + M1 = M0#{ a := 10 }, % update values + M2 = M1#{ "hi" => + "hello"}, % add new associations + #{ "hi" := V1, a := V2, b := V3} = M2. + % match keys with values +

For information on how to use Maps please see Map Expressions in the Reference Manual.

The current implementation is without the following - features: No variable keys - No single value access No map - comprehensions

+ features:

+ + No variable keys + No single value access + No map comprehensions +

Note that Maps is experimental during OTP 17.0.

@@ -1802,13 +1807,15 @@ supervisor or for the problematic child.

This introduces some incompatibilities in stdlib due to - new return values from supervisor: + new return values from supervisor:

+ restart_child/2 can now return {error,restarting} delete_child/2 can now return {error,restarting} which_children/1 returns a list of {Id,Child,Type,Mods}, where Child, in addition to the old pid() or 'undefined', now also can be - 'restarting'.

+ 'restarting'. +

*** POTENTIAL INCOMPATIBILITY ***

@@ -1824,10 +1831,10 @@ Own Id: OTP-9782 Aux Id: seq11964

-

Use universal time as base in error logger +

Use universal time as base in error logger

Previous conversion used the deprecated - calendar:local_time_to_universal_time/1

+ calendar:local_time_to_universal_time/1

Own Id: OTP-9854

 @@ -2584,10 +2591,10 @@ Own Id: OTP-8989 Aux Id: seq11741

-

Fix exception generation in the io module +

Fix exception generation in the io module

Some functions did not generate correct badarg exception - on a badarg exception.

+ on a badarg exception.

Own Id: OTP-9045

 diff --git a/lib/stdlib/doc/src/random.xml b/lib/stdlib/doc/src/random.xml index 91a4012ce9..a1bf67d332 100644 --- a/lib/stdlib/doc/src/random.xml +++ b/lib/stdlib/doc/src/random.xml @@ -76,9 +76,15 @@ dictionary, and returns the old state.

One easy way of obtaining a unique value to seed with is to:

- random:seed(erlang:phash2([node()]), - erlang:monotonic_time(), - erlang:unique_integer()) +random:seed(erlang:phash2([node()]), + erlang:monotonic_time(), + erlang:unique_integer()) +

See + erlang:phash2/1, + node/0, + erlang:monotonic_time/0, and + + erlang:unique_integer/0) for details.

 diff --git a/lib/stdlib/doc/src/re.xml b/lib/stdlib/doc/src/re.xml index 46b382a6be..8c19926b10 100644 --- a/lib/stdlib/doc/src/re.xml +++ b/lib/stdlib/doc/src/re.xml @@ -205,8 +205,8 @@ This option makes it possible to include comments inside complicated patterns. N - See compile/2 above. Match a subject against regular expression and capture subpatterns + See compile/2 above.

Executes a regexp matching, returning match/{match, @@ -881,11 +881,11 @@ nomatch - - +

PERL LIKE REGULAR EXPRESSIONS SYNTAX -

The following sections contain reference material for the +

+ The following sections contain reference material for the regular expressions used by this module. The regular expression reference is based on the PCRE documentation, with changes in cases where the re module behaves differently to the PCRE library.

@@ -2070,7 +2070,7 @@ supported, and an error is given if they are encountered.

By default, in UTF modes, characters with values greater than 255 do not match any of the POSIX character classes. However, if the PCRE_UCP option is passed -to pcre_compile(), some of the classes are changed so that Unicode +to pcre_compile(), some of the classes are changed so that Unicode character properties are used. This is achieved by replacing the POSIX classes by other sequences, as follows:

@@ -2078,10 +2078,10 @@ by other sequences, as follows:

[:alnum:] becomes \p{Xan} [:alpha:] becomes \p{L} [:blank:] becomes \h - [:digit:] becomes \p{Nd} + [:digit:] becomes \p{Nd} [:lower:] becomes \p{Ll} [:space:] becomes \p{Xps} - [:upper:] becomes \p{Lu} + [:upper:] becomes \p{Lu} [:word:] becomes \p{Xwd} @@ -3059,7 +3059,7 @@ default newline convention is in force:

abc #comment \n still comment

 -

On encountering the # character, pcre_compile() skips along, looking for +

On encountering the # character, pcre_compile() skips along, looking for a newline in the pattern. The sequence \n is still literal at this stage, so it does not terminate the comment. Only an actual character with the code value 0x0a (the default newline) does so.

diff --git a/lib/stdlib/doc/src/sofs.xml b/lib/stdlib/doc/src/sofs.xml index 5d7648d9a1..53f6ca957a 100644 --- a/lib/stdlib/doc/src/sofs.xml +++ b/lib/stdlib/doc/src/sofs.xml @@ -398,8 +398,9 @@ fun(S) -> sofs:partition(1, S) end - tuple_of(T) -

A tuple where the elements are of type T.

 + tuple_of(T) +

+ A tuple where the elements are of type T.

 diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index f08b752998..24ff251ce3 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -353,7 +353,7 @@

Dynamically adds a child specification to the supervisor SupRef which starts the corresponding child process.

-

SupRef can be:

+

SupRef can be:

the pid, Name, if the supervisor is locally registered, diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index 6ec515849e..d400f72e1d 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -238,8 +238,8 @@

These functions are intended only to help with debugging. They are provided for convenience, allowing developers to avoid having to create their own state extraction functions and also avoid having to interactively extract state from the return values of - get_status/1 or - get_status/2 while debugging.

+ get_status/1 or + get_status/2 while debugging.

The value of State varies for different types of processes. For a gen_server process, the returned State diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml index e002f519b9..7609487300 100644 --- a/lib/stdlib/doc/src/timer.xml +++ b/lib/stdlib/doc/src/timer.xml @@ -85,7 +85,6 @@ Send Messageto Pidafter a specified Time. -

send_after/3 @@ -99,7 +98,6 @@

Same as send_after(Time, self(), Message).

-

@@ -109,7 +107,6 @@ Send an exit signal with Reasonafter a specified Time. -

exit_after/3 @@ -130,7 +127,6 @@

Same as exit_after(Time, self(), kill).

-

@@ -147,7 +143,6 @@ Send Messagerepeatedly at intervals of Time. -

send_interval/3 @@ -161,7 +156,6 @@

Same as send_interval(Time, self(), Message).

-

@@ -192,7 +186,6 @@ Function, Arguments) or apply(Fun, Arguments) In microseconds -

tc/3 @@ -213,7 +206,6 @@ -

diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index 4500995c34..186c8ac724 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -126,7 +126,7 @@ -

The name of a zip file.

+

The name of a zip file.

 -- cgit v1.2.3 From 588cb79c699d304cae4ed1eb2ec305319a766331 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:01:37 +0200 Subject: [tools] Correct documentation Fix mistakes found by 'xmllint'. --- lib/tools/doc/src/eprof.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/tools/doc/src/eprof.xml b/lib/tools/doc/src/eprof.xml index 7dccd927ca..8e37d49c99 100644 --- a/lib/tools/doc/src/eprof.xml +++ b/lib/tools/doc/src/eprof.xml @@ -131,13 +131,13 @@ analyze() -> ok analyze(Type) -> ok analyze(Type,Options) -> ok + Display profiling results per process. Type = procs | total Options = [{filter, Filter} | {sort, Sort} Filter = [{calls, integer()} | {time, float()}] Sort = time | calls | mfa - Display profiling results per process.

Call this function when profiling has been stopped to display the results per process, that is:

-- cgit v1.2.3 From 3e6aa9c3e3763522eac4b4948573739429476bed Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:01:50 +0200 Subject: [test_server] Correct documentation Fix mistakes found by 'xmllint'. --- lib/test_server/doc/src/notes.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'lib') diff --git a/lib/test_server/doc/src/notes.xml b/lib/test_server/doc/src/notes.xml index 939a07dcef..da956de9ef 100644 --- a/lib/test_server/doc/src/notes.xml +++ b/lib/test_server/doc/src/notes.xml @@ -298,7 +298,7 @@ configuration function or test specification term), the affected test cases get the status user_skipped instead.

This update has meant a few changes that - may affect Common Test users in various ways: + may affect Common Test users in various ways:

The test results and statistics will be affected, which is important to know when running regression tests and comparing results to previous test runs. @@ -318,7 +318,7 @@ auto_skipped rather than user_skipped as before. The event messages that Common Test generates during test runs have been affected by this - update. For details see OTP-11524.

+ update. For details see OTP-11524.

Own Id: OTP-11305 Aux Id: OTP-11524

@@ -445,7 +445,7 @@ that were not opened with the {encoding,utf8} option. If then the argument contained unicode characters above 255, the file descriptor would crash. This has been corrected - by the following modifications: Since the + by the following modifications:

Since the 'unexpected_io' log file is used only when the test case HTML file is not available (e.g. between test cases), this file is now also a HTML file and as other @@ -467,7 +467,7 @@ path to the last run.<timestamp> directory, is now dependent on the file name mode of the VM. If file names are expected to be unicode, then the 'last_name' file is - UTF-8 encoded, else it is latin1 encoded.

+ UTF-8 encoded, else it is latin1 encoded.

Also, ~tp has been changed back to ~p unless it is somehow likely that the argument includes strings. It is @@ -615,7 +615,7 @@

- Update common test modules to handle unicode + Update common test modules to handle Unicode:

Use UTF-8 encoding for all HTML files, except the HTML version of the test suite generated with erl2html2:convert, which will have the same encoding as @@ -626,7 +626,7 @@ unicode:characters_to_list and unicode:characters_to_binary for conversion between binaries and strings instead of binary_to_list and - list_to_binary.

+ list_to_binary.
-- cgit v1.2.3 From 42eddf467f01e38502310a0f34770ed73ff74319 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:02:55 +0200 Subject: [hipe] Correct documentation Fix mistakes found by 'xmllint'. --- lib/hipe/doc/src/hipe_app.xml | 17 ++++++++--------- lib/hipe/doc/src/notes.xml | 32 ++++++++++++++++++-------------- 2 files changed, 26 insertions(+), 23 deletions(-) (limited to 'lib') diff --git a/lib/hipe/doc/src/hipe_app.xml b/lib/hipe/doc/src/hipe_app.xml index 98fec900af..bf4bdbb3b3 100644 --- a/lib/hipe/doc/src/hipe_app.xml +++ b/lib/hipe/doc/src/hipe_app.xml @@ -37,15 +37,14 @@

The normal way to native-compile an Erlang module using HiPE is to include the atom native - in the Erlang compiler options, as in: - - 1> c(my_module, [native]). - Options to the HiPE compiler are then passed as follows: - - 1> c(my_module, [native,{hipe,Options}]). - For on-line help in the Erlang shell, call hipe:help(). - Details on HiPE compiler options are given by hipe:help_options(). -

+ in the Erlang compiler options, as in:

+ 
+      1> c(my_module, [native]).
+

Options to the HiPE compiler are then passed as follows:

+ 
+      1> c(my_module, [native,{hipe,Options}]).
+

For on-line help in the Erlang shell, call hipe:help(). + Details on HiPE compiler options are given by hipe:help_options().
SEE ALSO diff --git a/lib/hipe/doc/src/notes.xml b/lib/hipe/doc/src/notes.xml index a463b421a8..e1aec698e4 100644 --- a/lib/hipe/doc/src/notes.xml +++ b/lib/hipe/doc/src/notes.xml @@ -319,22 +319,28 @@

EEP43: New data type - Maps

- With Maps you may for instance: M0 = - #{ a => 1, b => 2}, % create - associations M1 = M0#{ a := 10 }, % - update values M2 = M1#{ "hi" => - "hello"}, % add new associations #{ - "hi" := V1, a := V2, b := V3} = M2. % match keys with - values

+ With Maps you may for instance:

+ + M0 = #{ a => 1, b => 2}, % create + associations + M1 = M0#{ a := 10 }, % update values + M2 = M1#{ "hi" => + "hello"}, % add new associations + #{ "hi" := V1, a := V2, b := V3} = M2. + % match keys with values +

For information on how to use Maps please see Map Expressions in the Reference Manual.

The current implementation is without the following - features: No variable keys - No single value access No map - comprehensions

+ features:

+ + No variable keys + No single value access + No map comprehensions +

Note that Maps is experimental during OTP 17.0.

@@ -602,19 +608,17 @@

Fixed Bugs and Malfunctions -

No warnings for underspecs with remote types

Fix crash in Typer

Fix Dialyzer's warning for its own code

Fix Dialyzer's warnings in HiPE

Add file/line info in a particular Dialyzer crash

Update - inets test results

+ inets test results

Own Id: OTP-9758

-

Correct callback spec in application module

Refine warning about callback specs with extra ranges

Cleanup @@ -625,7 +629,7 @@ analysis

Fix crash in Dialyzer

Variable substitution was not generalizing any unknown variables.

 -

+

Own Id: OTP-9776

-- cgit v1.2.3 From 3d86418b496db400d795311ece53f9e632731a94 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:03:23 +0200 Subject: [dialyzer] Correct documentation Fix mistakes found by 'xmllint'. --- lib/dialyzer/doc/src/notes.xml | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) (limited to 'lib') diff --git a/lib/dialyzer/doc/src/notes.xml b/lib/dialyzer/doc/src/notes.xml index 9b3a7244f1..aa29684697 100644 --- a/lib/dialyzer/doc/src/notes.xml +++ b/lib/dialyzer/doc/src/notes.xml @@ -447,22 +447,28 @@

EEP43: New data type - Maps

- With Maps you may for instance: M0 = - #{ a => 1, b => 2}, % create - associations M1 = M0#{ a := 10 }, % - update values M2 = M1#{ "hi" => - "hello"}, % add new associations #{ - "hi" := V1, a := V2, b := V3} = M2. % match keys with - values

+ With Maps you may for instance:

+ + M0 = #{ a => 1, b => 2}, % create + associations + M1 = M0#{ a := 10 }, % update values + M2 = M1#{ "hi" => + "hello"}, % add new associations + #{ "hi" := V1, a := V2, b := V3} = M2. + % match keys with values +

For information on how to use Maps please see Map Expressions in the Reference Manual.

The current implementation is without the following - features: No variable keys - No single value access No map - comprehensions

+ features:

+ + No variable keys + No single value access + No map comprehensions +

Note that Maps is experimental during OTP 17.0.

@@ -776,19 +782,17 @@ Own Id: OTP-9731

-

No warnings for underspecs with remote types

Fix crash in Typer

Fix Dialyzer's warning for its own code

Fix Dialyzer's warnings in HiPE

Add file/line info in a particular Dialyzer crash

Update - inets test results

+ inets test results

Own Id: OTP-9758

-

Correct callback spec in application module

Refine warning about callback specs with extra ranges

Cleanup @@ -799,7 +803,7 @@ analysis

Fix crash in Dialyzer

Variable substitution was not generalizing any unknown variables.

 -

+

Own Id: OTP-9776

-- cgit v1.2.3 From 15770ab1b5587e890b7e4f557a4803291a37d2f8 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:03:12 +0200 Subject: [erl_docgen] Correct documentation Fix mistakes found by 'xmllint'. --- lib/erl_docgen/doc/src/erl_docgen_app.xml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/erl_docgen/doc/src/erl_docgen_app.xml b/lib/erl_docgen/doc/src/erl_docgen_app.xml index c2c65a0592..58c2a24f4b 100644 --- a/lib/erl_docgen/doc/src/erl_docgen_app.xml +++ b/lib/erl_docgen/doc/src/erl_docgen_app.xml @@ -32,7 +32,7 @@

- The application consists of the following parts + The application consists of the following parts:

XSL @@ -59,7 +59,6 @@

-

-- cgit v1.2.3