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/gen_sctp.xml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'lib/kernel/doc/src/gen_sctp.xml') 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 -- cgit v1.2.3