From nobody@FreeBSD.org  Sun Jan 10 15:41:30 2010
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id C425F1065672
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 10 Jan 2010 15:41:30 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id A841B8FC1B
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 10 Jan 2010 15:41:30 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id o0AFfU5t037671
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 10 Jan 2010 15:41:30 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id o0AFfUxe037663;
	Sun, 10 Jan 2010 15:41:30 GMT
	(envelope-from nobody)
Message-Id: <201001101541.o0AFfUxe037663@www.freebsd.org>
Date: Sun, 10 Jan 2010 15:41:30 GMT
From: Bruce Cran <bruce@cran.org.uk>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] fix mistakes in "errors" section of sctp manual pages
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         142573
>Category:       docs
>Synopsis:       [patch] fix mistakes in "errors" section of sctp manual pages
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    brueffer
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Jan 10 15:50:02 UTC 2010
>Closed-Date:    Tue Jan 19 18:11:17 CET 2010
>Last-Modified:  Tue Jan 19 18:11:17 CET 2010
>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 ERRORS section of the sctp manual pages contains a few mistakes in the first sentence. The attached patch corrects them.
>How-To-Repeat:
man sctp_bindx
man sctp_connectx
man sctp_getaddrlen
man sctp_getassocid
man sctp_getpaddrs
man sctp_opt_info
man sctp_send
man sctp_sendmsg
>Fix:


Patch attached with submission follows:

--- /usr/src/lib/libc/net/sctp_bindx.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_bindx.3	2010-01-10 15:27:26.000000000 +0000
@@ -90,7 +90,7 @@
 .Sh ERRORS
 The
 .Fn sctp_bindx
-can return the following errors.
+function can return the following errors:
 .Bl -tag -width Er
 .It Bq Er EINVAL
 This value is returned if the
--- /usr/src/lib/libc/net/sctp_connectx.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_connectx.3	2010-01-10 15:27:45.000000000 +0000
@@ -84,7 +84,7 @@
 .Sh ERRORS
 The
 .Fn sctp_connectx
-can return the following errors.
+function can return the following errors:
 .Bl -tag -width Er
 .It Bq Er EINVAL
 An address listed has an invalid family or no
--- /usr/src/lib/libc/net/sctp_getaddrlen.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_getaddrlen.3	2010-01-10 15:28:30.000000000 +0000
@@ -76,7 +76,7 @@
 .Sh ERRORS
 The
 .Fn sctp_getaddrlen
-function can return the following errors.
+function can return the following errors:
 .Bl -tag -width Er
 .It Bq Er EINVAL
 The address family specified does NOT exist.
--- /usr/src/lib/libc/net/sctp_getassocid.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_getassocid.3	2010-01-10 15:28:46.000000000 +0000
@@ -58,7 +58,7 @@
 .Sh ERRORS
 The
 .Fn sctp_getassocid
-function can return the following errors.
+function can return the following errors:
 .Bl -tag -width Er
 .It Bq Er ENOENT
 The address does not have an association setup to it.
--- /usr/src/lib/libc/net/sctp_getpaddrs.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_getpaddrs.3	2010-01-10 15:29:29.000000000 +0000
@@ -76,7 +76,7 @@
 .Fa addrs
 upon success.
 .Sh ERRORS
-The functions can return the following errors.
+The functions can return the following errors:
 .Bl -tag -width Er
 .It Bq Er EINVAL
 An address listed has an invalid family or no
--- /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:29:42.000000000 +0000
@@ -90,7 +90,7 @@
 .Sh ERRORS
 The
 .Fn sctp_opt_info
-function can return the following errors.
+function can return the following errors:
 .Bl -tag -width Er
 .It Bq Er EINVAL
 The argument
--- /usr/src/lib/libc/net/sctp_send.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_send.3	2010-01-10 15:30:20.000000000 +0000
@@ -294,7 +294,7 @@
 The
 .Fn sctp_send
 system call
-fail if:
+fails if:
 .Bl -tag -width Er
 .It Bq Er EBADF
 An invalid descriptor was specified.
--- /usr/src/lib/libc/net/sctp_sendmsg.3	2009-08-03 09:13:06.000000000 +0100
+++ sctp_sendmsg.3	2010-01-10 15:30:31.000000000 +0000
@@ -271,7 +271,7 @@
 The
 .Fn sctp_sendmsg
 system call
-fail if:
+fails if:
 .Bl -tag -width Er
 .It Bq Er EBADF
 An invalid descriptor was specified.


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: brueffer 
State-Changed-When: Tue Jan 12 22:45:21 CET 2010 
State-Changed-Why:  
Committed, thanks! 


Responsible-Changed-From-To: freebsd-doc->brueffer 
Responsible-Changed-By: brueffer 
Responsible-Changed-When: Tue Jan 12 22:45:21 CET 2010 
Responsible-Changed-Why:  
MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=142573 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/142573: commit references a PR
Date: Tue, 12 Jan 2010 21:45:17 +0000 (UTC)

 Author: brueffer
 Date: Tue Jan 12 21:45:03 2010
 New Revision: 202176
 URL: http://svn.freebsd.org/changeset/base/202176
 
 Log:
   Miscellaneous mdoc, spelling and inconsistency fixes.
   
   PR:		142573, 142576 (mostly)
   Submitted by:	brucec
   MFC after:	1 week
 
 Modified:
   head/lib/libc/net/sctp_bindx.3
   head/lib/libc/net/sctp_connectx.3
   head/lib/libc/net/sctp_getaddrlen.3
   head/lib/libc/net/sctp_getassocid.3
   head/lib/libc/net/sctp_getpaddrs.3
   head/lib/libc/net/sctp_opt_info.3
   head/lib/libc/net/sctp_recvmsg.3
   head/lib/libc/net/sctp_send.3
   head/lib/libc/net/sctp_sendmsg.3
   head/lib/libc/sys/sctp_generic_recvmsg.2
   head/lib/libc/sys/sctp_generic_sendmsg.2
   head/lib/libc/sys/sctp_peeloff.2
 
 Modified: head/lib/libc/net/sctp_bindx.3
 ==============================================================================
 --- head/lib/libc/net/sctp_bindx.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_bindx.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -90,7 +90,7 @@ The call returns 0 on success and -1 upo
  .Sh ERRORS
  The
  .Fn sctp_bindx
 -can return the following errors.
 +function can return the following errors:
  .Bl -tag -width Er
  .It Bq Er EINVAL
  This value is returned if the
 
 Modified: head/lib/libc/net/sctp_connectx.3
 ==============================================================================
 --- head/lib/libc/net/sctp_connectx.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_connectx.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -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 sd" "struct sockaddr *addrs" "int addrcnt" "sctp_assoc_t *id"
  .Sh DESCRIPTION
  The
  .Fn sctp_connectx
 @@ -75,7 +75,7 @@ the extra addresses sent in the
  call will be silently discarded from the association.
  On
  successful completion the provided
 -.Fa "sctp_assoc_t *"
 +.Fa id
  will be
  filled in with the association identification of the newly
  forming association.
 @@ -84,7 +84,7 @@ The call returns 0 on success and -1 upo
  .Sh ERRORS
  The
  .Fn sctp_connectx
 -can return the following errors.
 +function can return the following errors:
  .Bl -tag -width Er
  .It Bq Er EINVAL
  An address listed has an invalid family or no
 
 Modified: head/lib/libc/net/sctp_getaddrlen.3
 ==============================================================================
 --- head/lib/libc/net/sctp_getaddrlen.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_getaddrlen.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -76,7 +76,7 @@ system expects for the specific address 
  .Sh ERRORS
  The
  .Fn sctp_getaddrlen
 -function can return the following errors.
 +function can return the following errors:
  .Bl -tag -width Er
  .It Bq Er EINVAL
  The address family specified does NOT exist.
 
 Modified: head/lib/libc/net/sctp_getassocid.3
 ==============================================================================
 --- head/lib/libc/net/sctp_getassocid.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_getassocid.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -58,7 +58,7 @@ The call returns the association id upon
  .Sh ERRORS
  The
  .Fn sctp_getassocid
 -function can return the following errors.
 +function can return the following errors:
  .Bl -tag -width Er
  .It Bq Er ENOENT
  The address does not have an association setup to it.
 
 Modified: head/lib/libc/net/sctp_getpaddrs.3
 ==============================================================================
 --- head/lib/libc/net/sctp_getpaddrs.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_getpaddrs.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -33,7 +33,7 @@
  .\" $FreeBSD$
  .\"
  .Dd December 15, 2006
 -.Dt SCTP_GETPADDR 3
 +.Dt SCTP_GETPADDRS 3
  .Os
  .Sh NAME
  .Nm sctp_getpaddrs ,
 @@ -64,7 +64,7 @@ array of socket addresses returned in th
  .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
 @@ -76,7 +76,7 @@ the number of addresses returned in
  .Fa addrs
  upon success.
  .Sh ERRORS
 -The functions can return the following errors.
 +The functions can return the following errors:
  .Bl -tag -width Er
  .It Bq Er EINVAL
  An address listed has an invalid family or no
 
 Modified: head/lib/libc/net/sctp_opt_info.3
 ==============================================================================
 --- head/lib/libc/net/sctp_opt_info.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_opt_info.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -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 sd" "sctp_assoc_t id" "int opt" "void *arg" "socklen_t *size"
  .Sh DESCRIPTION
  The
  .Fn sctp_opt_info
 @@ -90,7 +90,7 @@ socket options.
  .Sh ERRORS
  The
  .Fn sctp_opt_info
 -function can return the following errors.
 +function can return the following errors:
  .Bl -tag -width Er
  .It Bq Er EINVAL
  The argument
 
 Modified: head/lib/libc/net/sctp_recvmsg.3
 ==============================================================================
 --- head/lib/libc/net/sctp_recvmsg.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_recvmsg.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -160,7 +160,7 @@ struct sctp_sndrcvinfo {
  .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 @@ as soon as possible.
  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 @@ association. 
  .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 @@ For unordered messages this field holds 
  .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,12 +216,12 @@ message.
  .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
  to the association.
 @@ -232,10 +233,10 @@ setting various socket options on the sp
  (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.
 
 Modified: head/lib/libc/net/sctp_send.3
 ==============================================================================
 --- head/lib/libc/net/sctp_send.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_send.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -294,7 +294,7 @@ if an error occurred.
  The
  .Fn sctp_send
  system call
 -fail if:
 +fails if:
  .Bl -tag -width Er
  .It Bq Er EBADF
  An invalid descriptor was specified.
 
 Modified: head/lib/libc/net/sctp_sendmsg.3
 ==============================================================================
 --- head/lib/libc/net/sctp_sendmsg.3	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/net/sctp_sendmsg.3	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -271,7 +271,7 @@ if an error occurred.
  The
  .Fn sctp_sendmsg
  system call
 -fail if:
 +fails if:
  .Bl -tag -width Er
  .It Bq Er EBADF
  An invalid descriptor was specified.
 @@ -324,7 +324,7 @@ is not connected and is a one-to-one sty
  .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
 
 Modified: head/lib/libc/sys/sctp_generic_recvmsg.2
 ==============================================================================
 --- head/lib/libc/sys/sctp_generic_recvmsg.2	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/sys/sctp_generic_recvmsg.2	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -36,7 +36,7 @@
  .Os
  .Sh NAME
  .Nm sctp_generic_recvmsg
 -.Nd receive data from a peer.
 +.Nd receive data from a peer
  .Sh LIBRARY
  .Lb libc
  .Sh SYNOPSIS
 @@ -46,16 +46,20 @@
  .Ft int
  .Fn sctp_generic_recvmsg "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *from" "socklen_t *fromlen" "struct sctp_sndrcvinfo *sinfo" "int *msgflags"
  .Sh DESCRIPTION
 -The
  .Fn sctp_generic_recvmsg
 -is the true system calls used by the
 -.Fn sctp_recvmsg
 -function call. This call is more efficient since it is a
 -true system calls but it is specific to FreeBSD and
 -can be expected NOT to be present on any other Operating
 -System. For detailed useage please see either the
 -.Fn sctp_recvmsg 
 -function call. 
 +is the true system call used by the
 +.Xr sctp_recvmsg 3
 +function call.
 +This call is more efficient since it is a
 +true system call but it is specific to
 +.Fx
 +and can be expected
 +.Em not
 +to be present on any other operating
 +system.
 +For detailed usage please see the
 +.Xr sctp_recvmsg 3
 +function call.
  .Sh RETURN VALUES
  The call returns the number of bytes read on success and -1 upon failure.
  .Sh ERRORS
 
 Modified: head/lib/libc/sys/sctp_generic_sendmsg.2
 ==============================================================================
 --- head/lib/libc/sys/sctp_generic_sendmsg.2	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/sys/sctp_generic_sendmsg.2	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -37,7 +37,7 @@
  .Sh NAME
  .Nm sctp_generic_sendmsg
  .Nm sctp_generic_sendmsg_iov
 -.Nd send data to a peer.
 +.Nd send data to a peer
  .Sh LIBRARY
  .Lb libc
  .Sh SYNOPSIS
 @@ -49,21 +49,25 @@
  .Ft int
  .Fn sctp_generic_sendmsg_iov "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *to" "struct sctp_sndrcvinfo *sinfo" "int flags"
  .Sh DESCRIPTION
 -The
  .Fn sctp_generic_sendmsg
  and
  .Fn sctp_generic_sendmsg_iov
  are the true system calls used by the
 -.Fn sctp_sendmsg
 +.Xr sctp_sendmsg 3
  and 
 -.Fn sctp_send
 -function calls. These are more efficient since they are
 -true system calls but they are specific to FreeBSD and
 -can be expected NOT to be present on any other Operating
 -System. For detailed useage please see either the
 -.Fn sctp_send
 +.Xr sctp_send 3
 +function calls.
 +These are more efficient since they are
 +true system calls but they are specific to
 +.Fx
 +and can be expected
 +.Em not
 +to be present on any other operating
 +system.
 +For detailed usage please see either the
 +.Xr sctp_send 3
  or
 -.Fn sctp_sendmsg
 +.Xr sctp_sendmsg 3
  function calls. 
  .Sh RETURN VALUES
  The call returns the number of bytes written on success and -1 upon failure.
 
 Modified: head/lib/libc/sys/sctp_peeloff.2
 ==============================================================================
 --- head/lib/libc/sys/sctp_peeloff.2	Tue Jan 12 21:36:08 2010	(r202175)
 +++ head/lib/libc/sys/sctp_peeloff.2	Tue Jan 12 21:45:03 2010	(r202176)
 @@ -36,7 +36,7 @@
  .Os
  .Sh NAME
  .Nm sctp_peeloff
 -.Nd detach an association from a one-to-many socket to its on fd
 +.Nd detach an association from a one-to-many socket to its own fd
  .Sh LIBRARY
  .Lb libc
  .Sh SYNOPSIS
 @@ -58,7 +58,7 @@ upon success.
  .Sh ERRORS
  The
  .Fn sctp_peeloff
 -can return the following errors.
 +system call can return the following errors:
  .Bl -tag -width Er
  .It Bq Er ENOTCONN
  The 
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: brueffer 
State-Changed-When: Tue Jan 19 18:11:03 CET 2010 
State-Changed-Why:  
MFCs done. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=142573 
>Unformatted:
