From ee205b29f7a2bb92aeef55ca88fccc8c91f22ec0 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Mon, 19 Sep 2011 15:36:08 +0200 Subject: Correct XML files --- lib/kernel/doc/src/app.xml | 4 +- lib/kernel/doc/src/code.xml | 4 +- lib/kernel/doc/src/disk_log.xml | 3 +- lib/kernel/doc/src/erl_ddll.xml | 2 +- lib/kernel/doc/src/file.xml | 20 +++++----- lib/kernel/doc/src/gen_sctp.xml | 77 ++++++++++++--------------------------- lib/kernel/doc/src/net_kernel.xml | 8 +--- 7 files changed, 39 insertions(+), 79 deletions(-) (limited to 'lib/kernel') diff --git a/lib/kernel/doc/src/app.xml b/lib/kernel/doc/src/app.xml index ef1f5985f4..ff8a12fe97 100644 --- a/lib/kernel/doc/src/app.xml +++ b/lib/kernel/doc/src/app.xml @@ -4,7 +4,7 @@
- 19972009 + 19972011 Ericsson AB. All Rights Reserved. @@ -170,7 +170,6 @@ Phases [{Phase,PhaseArgs}] undefined start phase defined by the start_phases key, and only after this extended start procedure will application:start(Application) return.

-

Start phases may be used to synchronize startup of an application and its included applications. In this case, the mod key must be specified as:

@@ -182,7 +181,6 @@ Phases [{Phase,PhaseArgs}] undefined for the primary application) both for the primary application and for each of its included application, for which the start phase is defined.

-

This implies that for an included application, the set of start phases must be a subset of the set of phases defined for the primary application. Refer to OTP Design Principles for more information.

diff --git a/lib/kernel/doc/src/code.xml b/lib/kernel/doc/src/code.xml index 98cdd416b0..6b89711924 100644 --- a/lib/kernel/doc/src/code.xml +++ b/lib/kernel/doc/src/code.xml @@ -177,9 +177,9 @@ archives. But the functions in erl_prim_loader may also be used by other applications to read files from archives. For example, the call - erl_prim_loader:list_dir("/otp/root/lib/mnesia-4.4.7.ez/mnesia-4.4.7/examples/bench)" + 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 diff --git a/lib/kernel/doc/src/disk_log.xml b/lib/kernel/doc/src/disk_log.xml index 9721907162..d278d54d93 100644 --- a/lib/kernel/doc/src/disk_log.xml +++ b/lib/kernel/doc/src/disk_log.xml @@ -475,8 +475,7 @@ Close a disk log. -

-The function close/1 closes a +

The function close/1 closes a local or distributed disk log properly. An internally formatted log must be closed before the Erlang system is stopped, otherwise the log is regarded as unclosed and the diff --git a/lib/kernel/doc/src/erl_ddll.xml b/lib/kernel/doc/src/erl_ddll.xml index f9514dda2f..1911fb628e 100644 --- a/lib/kernel/doc/src/erl_ddll.xml +++ b/lib/kernel/doc/src/erl_ddll.xml @@ -989,7 +989,7 @@ {ok, pending_driver} or {ok, pending_process}.

-

The pending_driverMonitorOption is by far +

The pending_driver MonitorOption is by far the most useful and it has to be used to ensure that the driver has really been unloaded and the ports closed whenever the kill_ports option is used or the diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml index 861c582211..7db20e6343 100644 --- a/lib/kernel/doc/src/file.xml +++ b/lib/kernel/doc/src/file.xml @@ -60,11 +60,13 @@ converted, why the Unicode mode for file names is not default on systems having completely transparent file naming.

- As of R14B01, the most basic file handling modules - (file, prim_file, filelib and - filename) accept raw file names, but the rest of OTP is not - guaranteed to handle them, why Unicode file naming on systems - where it is not default is still considered experimental. + +

As of R14B01, the most basic file handling modules + (file, prim_file, filelib and + filename) accept raw file names, but the rest of OTP is not + guaranteed to handle them, why Unicode file naming on systems + where it is not default is still considered experimental.

+

Raw file names is a new feature in OTP R14B01, which allows the user to supply completely uninterpreted file names to the @@ -249,11 +251,9 @@

Example:

- -f.txt: {person, "kalle", 25}. +f.txt: {person, "kalle", 25}. {person, "pelle", 30}. - 
-1> file:consult("f.txt").
+
1> file:consult("f.txt").
 {ok,[{person,"kalle",25},{person,"pelle",30}]}

       
     
@@ -362,7 +362,6 @@ f.txt:  {person, "kalle", 25}.
           
In a future release, a bad type for the
             Filename argument will probably generate
             an exception.

-          

         
       
     
@@ -1523,7 +1522,6 @@ f.txt:  {person, "kalle", 25}.
           
In a future release, a bad type for the
             Dir
             argument will probably generate an exception.

-          

         
       
     
diff --git a/lib/kernel/doc/src/gen_sctp.xml b/lib/kernel/doc/src/gen_sctp.xml
index cc49090386..688cd0f78f 100644
--- a/lib/kernel/doc/src/gen_sctp.xml
+++ b/lib/kernel/doc/src/gen_sctp.xml
@@ -47,8 +47,7 @@
       SUSE Linux Enterprise Server 10 Service Pack 1 (x86_64)
       kernel 2.6.16.54-0.2.3-smp with lksctp-tools-1.0.7.

     
Record definitions for the gen_sctp module can be found using:

-    
-  -include_lib("kernel/include/inet_sctp.hrl").    

+
  -include_lib("kernel/include/inet_sctp.hrl").    

     
These record definitions use the "new" spelling 'adaptation',
       not the deprecated 'adaption', regardless of which
       spelling the underlying C API uses.

@@ -152,8 +151,7 @@
           The result of connect/* is an #sctp_assoc_change{}
           event which contains, in particular, the new 
           Association ID.

-        
-  #sctp_assoc_change{
+
   #sctp_assoc_change{
         state             = atom(),
         error             = atom(),
         outbound_streams  = integer(),
@@ -163,8 +161,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
@@ -340,8 +337,7 @@
             
#sctp_assoc_change{};

           
           
-            
-  #sctp_paddr_change{
+
  #sctp_paddr_change{
         addr      = {ip_address(),port()},
         state     = atom(),
         error     = integer(),
@@ -378,8 +374,7 @@
               converted into a string using error_string/1.

           
           
-            
-  #sctp_send_failed{
+
  #sctp_send_failed{
         flags     = true | false,
         error     = integer(),
         info      = #sctp_sndrcvinfo{},
@@ -399,8 +394,7 @@
               returned by recv/*.

           
           
-            
-  #sctp_adaptation_event{
+
  #sctp_adaptation_event{
         adaptation_ind = integer(),
         assoc_id       = assoc_id()
   }            

@@ -411,8 +405,7 @@
               the Erlang/SCTP binding, this event is disabled by default.

           
           
-            
-  #sctp_pdapi_event{
+
  #sctp_pdapi_event{
         indication = sctp_partial_delivery_aborted,
         assoc_id   = assoc_id()
   }            

@@ -469,7 +462,7 @@
     
     
     
-      {mode, list|binary}or just list or binary.
+      {mode, list|binary} or just list or binary
       
         
Determines the type of data returned from gen_sctp:recv/1,2.

         
@@ -562,8 +555,7 @@
       
       {sctp_rtoinfo, #sctp_rtoinfo{}}
       
-        
-  #sctp_rtoinfo{
+
  #sctp_rtoinfo{
         assoc_id = assoc_id(),
         initial  = integer(),
         max      = integer(),
@@ -577,8 +569,7 @@
       
       {sctp_associnfo, #sctp_assocparams{}}
       
-        
-  #sctp_assocparams{
+
  #sctp_assocparams{
         assoc_id                 = assoc_id(),
         asocmaxrxt               = integer(),
         number_peer_destinations = integer(),
@@ -593,8 +584,7 @@
       
       {sctp_initmsg, #sctp_initmsg{}}
       
-        
-  #sctp_initmsg{
+
  #sctp_initmsg{
        num_ostreams   = integer(),
        max_instreams  = integer(),
        max_attempts   = integer(),
@@ -622,7 +612,6 @@
               for establishing an association.

           
         
-        

       
       {sctp_autoclose, integer() >= 0}
       
@@ -657,8 +646,7 @@
       
       {sctp_primary_addr, #sctp_prim{}}
       
-        
-  #sctp_prim{
+
  #sctp_prim{
         assoc_id = assoc_id(),
         addr     = {IP, Port}
   }
@@ -671,8 +659,7 @@
       
       {sctp_set_peer_primary_addr, #sctp_setpeerprim{}}
       
-        
-  #sctp_setpeerprim{
+
  #sctp_setpeerprim{
         assoc_id = assoc_id(),
         addr     = {IP, Port}
   }
@@ -686,8 +673,7 @@
       {sctp_adaptation_layer, #sctp_setadaptation{}}
       
         
-        
-  #sctp_setadaptation{
+
  #sctp_setadaptation{
         adaptation_ind = integer()
   }        

         
When set, requests that the local endpoint uses the value given by
@@ -698,8 +684,7 @@
       
       {sctp_peer_addr_params, #sctp_paddrparams{}}
       
-        
-  #sctp_paddrparams{
+
  #sctp_paddrparams{
         assoc_id   = assoc_id(),
         address    = {IP, Port},
         hbinterval = integer(),
@@ -756,16 +741,13 @@
                 
sackdelay_disable: disable SAC delay.

               
             
-            

           
         
-        

       
       {sctp_default_send_param, #sctp_sndrcvinfo{}}
       
         
-        
-  #sctp_sndrcvinfo{
+
  #sctp_sndrcvinfo{
         stream     = integer(),
         ssn        = integer(),
         flags      = list(),
@@ -807,20 +789,17 @@
                   association, with flushing of unsent data.

               
             
-            

             
Other fields are rarely used. See 
               RFC2960 and 
               Sockets API Extensions for SCTP for full information.

           
         
-        

         
       
       {sctp_events, #sctp_event_subscribe{}}
       
         
-        
-  #sctp_event_subscribe{
+
  #sctp_event_subscribe{
           data_io_event          = true | false,
           association_event      = true | false,
           address_event          = true | false,
@@ -845,8 +824,7 @@
       
       {sctp_delayed_ack_time, #sctp_assoc_value{}}
       
-        
-  #sctp_assoc_value{
+
  #sctp_assoc_value{
         assoc_id    = assoc_id(),
         assoc_value = integer()
   }        

@@ -857,8 +835,7 @@
       
       {sctp_status, #sctp_status{}}
       
-        
-  #sctp_status{
+
  #sctp_status{
         assoc_id            = assoc_id(),
         state               = atom(),
         rwnd                = integer(),
@@ -930,14 +907,12 @@
               address (see below for the format of #sctp_paddrinfo{}).

           
         
-        

         
       
       {sctp_get_peer_addr_info, #sctp_paddrinfo{}}
       
         
-        
-  #sctp_paddrinfo{
+
  #sctp_paddrinfo{
         assoc_id  = assoc_id(),
         address   = {IP, Port},
         state     = inactive | active,
@@ -968,8 +943,7 @@
       
         
Example of an Erlang SCTP Server which receives SCTP messages and
           prints them on the standard output:

-        
-  -module(sctp_server).
+
  -module(sctp_server).
   
   -export([server/0,server/1,server/2]).
   -include_lib("kernel/include/inet.hrl").
@@ -998,7 +972,6 @@
           io:format("Received: ~p~n", [Data])
       end,
       server_loop(S).        

-        

       
       
         
Example of an Erlang SCTP Client which interacts with the above Server.
@@ -1008,8 +981,7 @@
           over Stream 5 fails. The client then aborts the association,
           which results in the corresponding Event being received on
           the Server side.

-        
-  -module(sctp_client).
+
  -module(sctp_client).
   
   -export([client/0, client/1, client/2]).
   -include_lib("kernel/include/inet.hrl").
@@ -1042,13 +1014,11 @@
       
       timer:sleep(1000),
       gen_sctp:close(S).        

-        

       
       
         
A very simple Erlang SCTP Client which uses the
           connect_init API.

-        
--module(ex3).
+
-module(ex3).
 
 -export([client/4]).
 -include_lib("kernel/include/inet.hrl").
@@ -1101,7 +1071,6 @@ client_loop(S, Peer1, Port1, AssocId1, Peer2, Port2, AssocId2) ->
             ok
     end.
 

-        

       
     
   
diff --git a/lib/kernel/doc/src/net_kernel.xml b/lib/kernel/doc/src/net_kernel.xml
index 96e2aa665d..3b7a710664 100644
--- a/lib/kernel/doc/src/net_kernel.xml
+++ b/lib/kernel/doc/src/net_kernel.xml
@@ -37,13 +37,10 @@
       monitoring of the network.

     
An Erlang node is started using the command line flag
       -name or -sname:

-    
-$ erl -sname foobar

+
$ erl -sname foobar

     
It is also possible to call net_kernel:start([foobar])
       directly from the normal Erlang shell prompt:

-    

-    
-1> net_kernel:start([foobar, shortnames]).
+
1> net_kernel:start([foobar, shortnames]).
 {ok,<0.64.0>}
 (foobar@gringotts)2>

     
If the node is started with the command line flag -sname,
@@ -226,7 +223,6 @@ $ erl -sname foobar

           NetTicktime seconds. TransitionPeriod defaults
           to 60.

         
Some definitions:

-        

         
           The minimum transition traffic interval (MTTI)
           
-- 
cgit v1.2.3