Date: Sun, 10 Jan 2010 16:45:46 GMT From: Bruce Cran <bruce@cran.org.uk> To: freebsd-gnats-submit@FreeBSD.org Subject: docs/142576: [patch] fix typos and missing params in the sctp man pages Message-ID: <201001101645.o0AGjkVd005073@www.freebsd.org> Resent-Message-ID: <201001101650.o0AGo1Y3010537@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 142576 >Category: docs >Synopsis: [patch] fix typos and missing params in the sctp man pages >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: sw-bug >Submitter-Id: current-users >Arrival-Date: Sun Jan 10 16:50:00 UTC 2010 >Closed-Date: >Last-Modified: >Originator: Bruce Cran >Release: 8.0-STABLE >Organization: >Environment: FreeBSD router.draftnet 8.0-STABLE FreeBSD 8.0-STABLE #0: Sun Jan 3 23:30:01 GMT 2010 brucec@router.draftnet:/usr/obj/usr/src/sys/ROUTER i386 >Description: The sctp manual pages contain a few mistakes including missing words, markup errors and missing parameter names. The attached patch fixes them. >How-To-Repeat: man sctp_connectx man sctp_getpaddrs man sctp_opt_info man sctp_recvmsg man sctp_sendmsg >Fix: Patch attached with submission follows: --- /usr/src/lib/libc/net/sctp_recvmsg.3 2009-08-03 09:13:06.000000000 +0100 +++ sctp_recvmsg.3 2010-01-10 16:27:20.000000000 +0000 @@ -160,7 +160,7 @@ .Pp The .Fa sinfo->sinfo_ppid -is an opaque 32 bit value that is passed transparently +field is an opaque 32 bit value that is passed transparently through the stack from the peer endpoint. Note that the stack passes this value without regard to byte order. @@ -180,12 +180,13 @@ When this flag is absent the message was delivered in order within the stream it was received. .Pp +The .Fa sinfo->sinfo_stream -is the SCTP stream that the message was received on. +field is the SCTP stream that the message was received on. Streams in SCTP are reliable (or partially reliable) flows of ordered messages. .Pp -The +The .Fa sinfo->sinfo_context field is used only if the local application set an association level context with the @@ -197,7 +198,7 @@ .Pp The .Fa sinfo->sinfo_ssn -will hold the stream sequence number assigned +field will hold the stream sequence number assigned by the peer endpoint if the message is .Em not unordered. @@ -205,7 +206,7 @@ .Pp The .Fa sinfo->sinfo_tsn -holds a transport sequence number (TSN) that was assigned +field holds a transport sequence number (TSN) that was assigned to this message by the peer endpoint. For messages that fit in or less than the path MTU this will be the only TSN assigned. @@ -215,14 +216,14 @@ .Pp The .Fa sinfo->sinfo_cumtsn -holds the current cumulative acknowledgment point of +field holds the current cumulative acknowledgment point of the transport association. Note that this may be larger or smaller than the TSN assigned to the message itself. .Pp -The +The .Fa sinfo->sinfo_assoc_id -is the unique association identification that was assigned +field is the unique association identification that was assigned to the association. For one-to-many (SOCK_SEQPACKET) type sockets this value can be used to send data to the peer without @@ -232,10 +233,10 @@ (see .Xr sctp 4 ) . .Pp -The +The .Fa sinfo->info_timetolive field is not used by -.Fa sctp_recvmsg . +.Fn sctp_recvmsg . .Sh RETURN VALUES The call returns the number of characters sent, or -1 if an error occurred. --- /usr/src/lib/libc/net/sctp_opt_info.3 2009-08-03 09:13:06.000000000 +0100 +++ sctp_opt_info.3 2010-01-10 15:56:26.000000000 +0000 @@ -45,7 +45,7 @@ .In sys/socket.h .In netinet/sctp.h .Ft int -.Fn sctp_opt_info "int s" "sctp_assoc_t" "int opt" "void *arg" "socklen_t *size" +.Fn sctp_opt_info "int s" "sctp_assoc_t asocid" "int opt" "void *arg" "socklen_t *size" .Sh DESCRIPTION The .Fn sctp_opt_info --- /usr/src/lib/libc/net/sctp_getpaddrs.3 2009-08-03 09:13:06.000000000 +0100 +++ sctp_getpaddrs.3 2010-01-10 16:00:48.000000000 +0000 @@ -64,7 +64,7 @@ .Fa addrs upon success. .Pp -After the caller is through the function +After the caller is finished, the function .Fn sctp_freepaddrs or .Fn sctp_freeladdrs --- /usr/src/lib/libc/net/sctp_connectx.3 2009-08-03 09:13:06.000000000 +0100 +++ sctp_connectx.3 2010-01-10 16:32:28.000000000 +0000 @@ -44,7 +44,7 @@ .In sys/socket.h .In netinet/sctp.h .Ft int -.Fn sctp_connectx "int s" "struct sockaddr *" "int addrcnt" "sctp_assoc_t *" +.Fn sctp_connectx "int s" "struct sockaddr *addrs" "int addrcnt" "sctp_assoc_t *asocid" .Sh DESCRIPTION The .Fn sctp_connectx --- /usr/src/lib/libc/net/sctp_sendmsg.3 2009-08-03 09:13:06.000000000 +0100 +++ sctp_sendmsg.3 2010-01-10 16:42:58.000000000 +0000 @@ -324,7 +324,7 @@ .Xr sendmsg 3 , .Xr sctp 4 .Sh BUGS -Because in the one-to-many style socket the +Because in the one-to-many style socket .Fn sctp_sendmsg or .Fn sctp_sendmsgx >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201001101645.o0AGjkVd005073>