Bug 140938

Summary: sctp(4) links to sctp_opt_info in section 2 instead of 3
Product: Documentation Reporter: Rebecca Cran <bcran>
Component: Books & ArticlesAssignee: Peter Pentchev <roam>
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 12:50:02 UTC
The sctp(4) manual page contains an embedded reference to sctp_opt_info(2). It should refer to sctp_opt_info(3):

"SCTP supports a number of socket options which can be set with
     setsockopt(2) and tested with getsockopt(2) or sctp_opt_info(2):"

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

How-To-Repeat: View the man page for sctp(4) at http://www.freebsd.org/cgi/man.cgi?query=sctp&apropos=0&sektion=0&manpath=FreeBSD+8.0-RELEASE&format=html
Comment 1 dfilter service freebsd_committer freebsd_triage 2009-11-27 13:08:40 UTC
Author: roam (doc,ports committer)
Date: Fri Nov 27 13:08:25 2009
New Revision: 199863
URL: http://svn.freebsd.org/changeset/base/199863

Log:
  Fix the cross-reference to sctp_opt_info in the text - section 3, not 2.
  
  PR:		140938
  Submitted by:	Bruce Cran <bruce@cran.org.uk>
  MFC after:	2 weeks

Modified:
  head/share/man/man4/sctp.4

Modified: head/share/man/man4/sctp.4
==============================================================================
--- head/share/man/man4/sctp.4	Fri Nov 27 13:05:14 2009	(r199862)
+++ head/share/man/man4/sctp.4	Fri Nov 27 13:08:25 2009	(r199863)
@@ -179,7 +179,7 @@ supports a number of socket options whic
 and tested with
 .Xr getsockopt 2
 or
-.Xr sctp_opt_info 2 :
+.Xr sctp_opt_info 3 :
 .Bl -tag -width ".Dv SCTP_SET_PEER_PRIMARY_ADDR"
 .It Dv SCTP_NODELAY
 Under most circumstances,
_______________________________________________
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 2 Peter Pentchev freebsd_committer freebsd_triage 2009-11-27 13:35:54 UTC
State Changed
From-To: open->patched

Fixed in -CURRENT, will merge to the stable branches in two weeks. 
Thanks for spotting this! 


Comment 3 Peter Pentchev freebsd_committer freebsd_triage 2009-11-27 13:35:54 UTC
Responsible Changed
From-To: freebsd-doc->roam

MFC reminder.
Comment 4 dfilter service freebsd_committer freebsd_triage 2009-12-24 20:30:11 UTC
Author: roam (doc,ports committer)
Date: Thu Dec 24 20:29:58 2009
New Revision: 200960
URL: http://svn.freebsd.org/changeset/base/200960

Log:
  MFC r199863:
    Fix the cross-reference to sctp_opt_info in the text - section 3, not 2.
  
    PR:           140938
    Submitted by: Bruce Cran <bruce@cran.org.uk>

Modified:
  stable/8/share/man/man4/sctp.4
Directory Properties:
  stable/8/share/man/man4/   (props changed)

Modified: stable/8/share/man/man4/sctp.4
==============================================================================
--- stable/8/share/man/man4/sctp.4	Thu Dec 24 19:06:13 2009	(r200959)
+++ stable/8/share/man/man4/sctp.4	Thu Dec 24 20:29:58 2009	(r200960)
@@ -179,7 +179,7 @@ supports a number of socket options whic
 and tested with
 .Xr getsockopt 2
 or
-.Xr sctp_opt_info 2 :
+.Xr sctp_opt_info 3 :
 .Bl -tag -width ".Dv SCTP_SET_PEER_PRIMARY_ADDR"
 .It Dv SCTP_NODELAY
 Under most circumstances,
_______________________________________________
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 2009-12-24 20:31:46 UTC
Author: roam (doc,ports committer)
Date: Thu Dec 24 20:31:26 2009
New Revision: 200961
URL: http://svn.freebsd.org/changeset/base/200961

Log:
  MFC r199863:
    Fix the cross-reference to sctp_opt_info in the text - section 3, not 2.
  
    PR:           140938
    Submitted by: Bruce Cran <bruce@cran.org.uk>

Modified:
  stable/7/share/man/man4/sctp.4
Directory Properties:
  stable/7/share/man/man4/   (props changed)

Modified: stable/7/share/man/man4/sctp.4
==============================================================================
--- stable/7/share/man/man4/sctp.4	Thu Dec 24 20:29:58 2009	(r200960)
+++ stable/7/share/man/man4/sctp.4	Thu Dec 24 20:31:26 2009	(r200961)
@@ -179,7 +179,7 @@ supports a number of socket options whic
 and tested with
 .Xr getsockopt 2
 or
-.Xr sctp_opt_info 2 :
+.Xr sctp_opt_info 3 :
 .Bl -tag -width ".Dv SCTP_SET_PEER_PRIMARY_ADDR"
 .It Dv SCTP_NODELAY
 Under most circumstances,
_______________________________________________
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 Peter Pentchev freebsd_committer freebsd_triage 2009-12-24 20:32:14 UTC
State Changed
From-To: patched->closed

I just merged the fix to the 7.x- and 8.x-STABLE branches. 
Thanks again!