Bug 140940

Summary: sctp manual pages contain links to pages in section 2 instead of 3
Product: Documentation Reporter: Rebecca Cran <bcran>
Component: Books & ArticlesAssignee: Daniel Gerzo <danger>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Rebecca Cran freebsd_committer freebsd_triage 2009-11-27 14:10:02 UTC
The sctp_send(3) manual page contains an embedded link to sctp_recvmsg(2). It should link to sctp_recvmsg(3).

"It will be avail-
     able on reception of a message (see sctp_recvmsg(2))."

sctp_sendmsg(3) links to sctp_sendmsg(2) instead of sctp_sendmsg(3).

"No indication of failure to deliver is implicit in a sctp_sendmsg(2)
     call."

"If no space is available at the socket to hold the message to be trans-
     mitted, then sctp_sendmsg(2) normally blocks"

There is also a wrong link to sctp_recvmsg(2): it should be sctp_recvmsg(3):

"It will be available on recep-
     tion of a message (see sctp_recvmsg(2))"

How-To-Repeat: View the sctp_send(3) and sctp_sendmsg(3) manual pages:

http://www.freebsd.org/cgi/man.cgi?query=sctp_send&apropos=0&sektion=0&manpath=FreeBSD+8.0-RELEASE&format=html

http://www.freebsd.org/cgi/man.cgi?query=sctp_sendmsg&apropos=0&sektion=0&manpath=FreeBSD+8.0-RELEASE&format=html
Comment 1 Daniel Gerzo freebsd_committer freebsd_triage 2009-11-28 11:27:51 UTC
State Changed
From-To: open->patched

- fixed in head, awaiting MFC 
- thanks for submission!
Comment 2 dfilter service freebsd_committer freebsd_triage 2009-11-28 11:27:52 UTC
Author: danger (doc committer)
Date: Sat Nov 28 11:27:37 2009
New Revision: 199873
URL: http://svn.freebsd.org/changeset/base/199873

Log:
  - correct xref sections
  
  PR:		docs/140940
  Submitted by:	Bruce Cran <bruce@cran.org.uk>
  MFC after:	1 week

Modified:
  head/lib/libc/net/sctp_send.3
  head/lib/libc/net/sctp_sendmsg.3

Modified: head/lib/libc/net/sctp_send.3
==============================================================================
--- head/lib/libc/net/sctp_send.3	Sat Nov 28 11:13:50 2009	(r199872)
+++ head/lib/libc/net/sctp_send.3	Sat Nov 28 11:27:37 2009	(r199873)
@@ -111,7 +111,7 @@ The 
 argument is an opaque 32 bit value that is passed transparently
 through the stack to the peer endpoint. It will be available on
 reception of a message (see
-.Xr sctp_recvmsg 2 ) .
+.Xr sctp_recvmsg 3 ) .
 Note that the stack passes this value without regard to byte
 order.
 .Pp

Modified: head/lib/libc/net/sctp_sendmsg.3
==============================================================================
--- head/lib/libc/net/sctp_sendmsg.3	Sat Nov 28 11:13:50 2009	(r199872)
+++ head/lib/libc/net/sctp_sendmsg.3	Sat Nov 28 11:27:37 2009	(r199873)
@@ -103,13 +103,13 @@ is set to 
 the message is not transmitted.
 .Pp
 No indication of failure to deliver is implicit in a
-.Xr sctp_sendmsg 2
+.Xr sctp_sendmsg 3
 call.
 Locally detected errors are indicated by a return value of -1.
 .Pp
 If no space is available at the socket to hold
 the message to be transmitted, then
-.Xr sctp_sendmsg 2
+.Xr sctp_sendmsg 3
 normally blocks, unless the socket has been placed in
 non-blocking I/O mode.
 The
@@ -123,7 +123,7 @@ argument is an opaque 32 bit value that 
 through the stack to the peer endpoint.
 It will be available on
 reception of a message (see
-.Xr sctp_recvmsg 2 ) .
+.Xr sctp_recvmsg 3 ) .
 Note that the stack passes this value without regard to byte
 order.
 .Pp
_______________________________________________
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"
Comment 3 Daniel Gerzo freebsd_committer freebsd_triage 2009-11-28 11:28:16 UTC
Responsible Changed
From-To: freebsd-doc->danger

- assign to me
Comment 4 dfilter service freebsd_committer freebsd_triage 2011-06-06 22:23:25 UTC
Author: gjb (doc committer)
Date: Mon Jun  6 21:23:11 2011
New Revision: 222781
URL: http://svn.freebsd.org/changeset/base/222781

Log:
  MFC 199873 [1]:
  
  - correct xref sections
  
  PR:		140940
  Original commit by:	danger [1]

Modified:
  stable/8/lib/libc/net/sctp_send.3
  stable/8/lib/libc/net/sctp_sendmsg.3
Directory Properties:
  stable/8/lib/libc/   (props changed)
  stable/8/lib/libc/stdtime/   (props changed)

Modified: stable/8/lib/libc/net/sctp_send.3
==============================================================================
--- stable/8/lib/libc/net/sctp_send.3	Mon Jun  6 21:07:44 2011	(r222780)
+++ stable/8/lib/libc/net/sctp_send.3	Mon Jun  6 21:23:11 2011	(r222781)
@@ -111,7 +111,7 @@ The 
 argument is an opaque 32 bit value that is passed transparently
 through the stack to the peer endpoint. It will be available on
 reception of a message (see
-.Xr sctp_recvmsg 2 ) .
+.Xr sctp_recvmsg 3 ) .
 Note that the stack passes this value without regard to byte
 order.
 .Pp

Modified: stable/8/lib/libc/net/sctp_sendmsg.3
==============================================================================
--- stable/8/lib/libc/net/sctp_sendmsg.3	Mon Jun  6 21:07:44 2011	(r222780)
+++ stable/8/lib/libc/net/sctp_sendmsg.3	Mon Jun  6 21:23:11 2011	(r222781)
@@ -103,13 +103,13 @@ is set to 
 the message is not transmitted.
 .Pp
 No indication of failure to deliver is implicit in a
-.Xr sctp_sendmsg 2
+.Xr sctp_sendmsg 3
 call.
 Locally detected errors are indicated by a return value of -1.
 .Pp
 If no space is available at the socket to hold
 the message to be transmitted, then
-.Xr sctp_sendmsg 2
+.Xr sctp_sendmsg 3
 normally blocks, unless the socket has been placed in
 non-blocking I/O mode.
 The
@@ -123,7 +123,7 @@ argument is an opaque 32 bit value that 
 through the stack to the peer endpoint.
 It will be available on
 reception of a message (see
-.Xr sctp_recvmsg 2 ) .
+.Xr sctp_recvmsg 3 ) .
 Note that the stack passes this value without regard to byte
 order.
 .Pp
_______________________________________________
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"
Comment 5 dfilter service freebsd_committer freebsd_triage 2011-06-06 22:24:16 UTC
Author: gjb (doc committer)
Date: Mon Jun  6 21:24:07 2011
New Revision: 222782
URL: http://svn.freebsd.org/changeset/base/222782

Log:
  MFC 199873 [1]:
  
  - correct xref sections
  
  PR:		140940
  Original commit by:	danger [1]

Modified:
  stable/7/lib/libc/net/sctp_send.3
  stable/7/lib/libc/net/sctp_sendmsg.3
Directory Properties:
  stable/7/lib/libc/   (props changed)
  stable/7/lib/libc/stdtime/   (props changed)

Modified: stable/7/lib/libc/net/sctp_send.3
==============================================================================
--- stable/7/lib/libc/net/sctp_send.3	Mon Jun  6 21:23:11 2011	(r222781)
+++ stable/7/lib/libc/net/sctp_send.3	Mon Jun  6 21:24:07 2011	(r222782)
@@ -111,7 +111,7 @@ The 
 argument is an opaque 32 bit value that is passed transparently
 through the stack to the peer endpoint. It will be available on
 reception of a message (see
-.Xr sctp_recvmsg 2 ) .
+.Xr sctp_recvmsg 3 ) .
 Note that the stack passes this value without regard to byte
 order.
 .Pp

Modified: stable/7/lib/libc/net/sctp_sendmsg.3
==============================================================================
--- stable/7/lib/libc/net/sctp_sendmsg.3	Mon Jun  6 21:23:11 2011	(r222781)
+++ stable/7/lib/libc/net/sctp_sendmsg.3	Mon Jun  6 21:24:07 2011	(r222782)
@@ -103,13 +103,13 @@ is set to 
 the message is not transmitted.
 .Pp
 No indication of failure to deliver is implicit in a
-.Xr sctp_sendmsg 2
+.Xr sctp_sendmsg 3
 call.
 Locally detected errors are indicated by a return value of -1.
 .Pp
 If no space is available at the socket to hold
 the message to be transmitted, then
-.Xr sctp_sendmsg 2
+.Xr sctp_sendmsg 3
 normally blocks, unless the socket has been placed in
 non-blocking I/O mode.
 The
@@ -123,7 +123,7 @@ argument is an opaque 32 bit value that 
 through the stack to the peer endpoint.
 It will be available on
 reception of a message (see
-.Xr sctp_recvmsg 2 ) .
+.Xr sctp_recvmsg 3 ) .
 Note that the stack passes this value without regard to byte
 order.
 .Pp
_______________________________________________
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"
Comment 6 Glen Barber freebsd_committer freebsd_triage 2011-06-06 22:25:58 UTC
State Changed
From-To: patched->closed

MFCd to stable/8 and stable/7.