Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 19 Jan 2010 17:09:18 +0000 (UTC)
From:      Christian Brueffer <brueffer@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-stable@freebsd.org, svn-src-stable-8@freebsd.org
Subject:   svn commit: r202632 - in stable/8/lib/libc: net sys
Message-ID:  <201001191709.o0JH9Ixi053970@svn.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: brueffer
Date: Tue Jan 19 17:09:18 2010
New Revision: 202632
URL: http://svn.freebsd.org/changeset/base/202632

Log:
  MFC: r202176
  
  Miscellaneous mdoc, spelling and inconsistency fixes.

Modified:
  stable/8/lib/libc/net/sctp_bindx.3
  stable/8/lib/libc/net/sctp_connectx.3
  stable/8/lib/libc/net/sctp_getaddrlen.3
  stable/8/lib/libc/net/sctp_getassocid.3
  stable/8/lib/libc/net/sctp_getpaddrs.3
  stable/8/lib/libc/net/sctp_opt_info.3
  stable/8/lib/libc/net/sctp_recvmsg.3
  stable/8/lib/libc/net/sctp_send.3
  stable/8/lib/libc/net/sctp_sendmsg.3
  stable/8/lib/libc/sys/sctp_generic_recvmsg.2
  stable/8/lib/libc/sys/sctp_generic_sendmsg.2
  stable/8/lib/libc/sys/sctp_peeloff.2
Directory Properties:
  stable/8/lib/libc/   (props changed)
  stable/8/lib/libc/stdtime/   (props changed)

Modified: stable/8/lib/libc/net/sctp_bindx.3
==============================================================================
--- stable/8/lib/libc/net/sctp_bindx.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_bindx.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_connectx.3
==============================================================================
--- stable/8/lib/libc/net/sctp_connectx.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_connectx.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_getaddrlen.3
==============================================================================
--- stable/8/lib/libc/net/sctp_getaddrlen.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_getaddrlen.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_getassocid.3
==============================================================================
--- stable/8/lib/libc/net/sctp_getassocid.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_getassocid.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_getpaddrs.3
==============================================================================
--- stable/8/lib/libc/net/sctp_getpaddrs.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_getpaddrs.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_opt_info.3
==============================================================================
--- stable/8/lib/libc/net/sctp_opt_info.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_opt_info.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_recvmsg.3
==============================================================================
--- stable/8/lib/libc/net/sctp_recvmsg.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_recvmsg.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_send.3
==============================================================================
--- stable/8/lib/libc/net/sctp_send.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_send.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/net/sctp_sendmsg.3
==============================================================================
--- stable/8/lib/libc/net/sctp_sendmsg.3	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/net/sctp_sendmsg.3	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/sys/sctp_generic_recvmsg.2
==============================================================================
--- stable/8/lib/libc/sys/sctp_generic_recvmsg.2	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/sys/sctp_generic_recvmsg.2	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/sys/sctp_generic_sendmsg.2
==============================================================================
--- stable/8/lib/libc/sys/sctp_generic_sendmsg.2	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/sys/sctp_generic_sendmsg.2	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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: stable/8/lib/libc/sys/sctp_peeloff.2
==============================================================================
--- stable/8/lib/libc/sys/sctp_peeloff.2	Tue Jan 19 16:58:50 2010	(r202631)
+++ stable/8/lib/libc/sys/sctp_peeloff.2	Tue Jan 19 17:09:18 2010	(r202632)
@@ -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 



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201001191709.o0JH9Ixi053970>