docs/142573: [patch] fix mistakes in "errors" section of sctp manual pages

Bruce Cran bruce at cran.org.uk
Sun Jan 10 15:50:02 UTC 2010


>Number:         142573
>Category:       docs
>Synopsis:       [patch] fix mistakes in "errors" section of sctp manual 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 15:50:02 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 at 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:
>Unformatted:



More information about the freebsd-doc mailing list