Bug 30234

Summary:	socketvar.h comment references obsolete structure members
Product:	Documentation	Reporter:	Joseph Mallett <jmallett>
Component:	Books & Articles	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Joseph Mallett 2001-08-31 14:00:01 UTC

/sys/sys/socketvar.h has the folllowing comment:

 * For head socket so_q0 queues partially completed connections,
 * while so_q is a queue of connections ready to be accepted.
 * If a connection is aborted and it has so_head set, then
 * it has to be pulled out of either so_q0 or so_q.
 * We allow connections to queue up based on current queue lengths
 * and limit on number of queued connections for this socket.

but q0 and q have been replaced by so_incomp and so_comp.

Fix: 

just replace the old names with the new names, and possibly mention something about the use of TAILQ
How-To-Repeat: vi /sys/sys/socketvar.h
read the comment
and then look for the structure members it references

Comment 1 jmallett 2001-08-31 14:36:39 UTC

Sorry, this has been fixed in current, I checked on RELENG_4...

Please close this, but please MFC the comment change as well, it's been 
two months.

On Fri, Aug 31, 2001 at 05:57:59AM -0700, Joseph Mallett wrote:
> 
> >Number:         30234
> >Category:       docs
> >Synopsis:       socketvar.h comment references obsolete structure members
> >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:   Fri Aug 31 06:00:01 PDT 2001
> >Closed-Date:
> >Last-Modified:
> >Originator:     Joseph Mallett
> >Release:        4.3
> >Organization:
> >Environment:
> FreeBSD Dalek.xMach.ORG 4.3-STABLE FreeBSD 4.3-STABLE #0: Mon Jun 18 07:07:16 EDT 2001     jmallett@Dalek.xMach.ORG:/usr/home/jmallett/vmunix.build  i386
> >Description:
> /sys/sys/socketvar.h has the folllowing comment:
> 
>  * For head socket so_q0 queues partially completed connections,
>  * while so_q is a queue of connections ready to be accepted.
>  * If a connection is aborted and it has so_head set, then
>  * it has to be pulled out of either so_q0 or so_q.
>  * We allow connections to queue up based on current queue lengths
>  * and limit on number of queued connections for this socket.
> 
> but q0 and q have been replaced by so_incomp and so_comp.
> >How-To-Repeat:
> vi /sys/sys/socketvar.h
> read the comment
> and then look for the structure members it references
> >Fix:
> just replace the old names with the new names, and possibly mention something about the use of TAILQ
> >Release-Note:
> >Audit-Trail:
> >Unformatted:
> 
> To Unsubscribe: send mail to majordomo@FreeBSD.org
> with "unsubscribe freebsd-doc" in the body of the message

-- 
--
Joseph A. Mallett
http://srcsys.org

xMach Core Team, www.xMach.org

Comment 2 dd freebsd_committer

2001-09-03 16:56:08 UTC

State Changed
From-To: open->closed

IIRC jlemon MFC'd this stuff.