From fenner@parc.xerox.com  Fri Aug 18 19:27:28 1995
Received: from alpha.xerox.com (alpha.Xerox.COM [13.1.64.93])
          by freefall.FreeBSD.org (8.6.11/8.6.6) with SMTP id TAA08201
          for <FreeBSD-gnats-submit@freebsd.org>; Fri, 18 Aug 1995 19:27:27 -0700
Received: from baobab.parc.xerox.com ([13.2.116.113]) by alpha.xerox.com with SMTP id <16156(2)>; Fri, 18 Aug 1995 19:26:51 PDT
Received: (from fenner@localhost) by baobab.parc.xerox.com (8.6.11/8.6.9) id TAA22436; Fri, 18 Aug 1995 19:29:38 -0700
Message-Id: <199508190229.TAA22436@baobab.parc.xerox.com>
Date: Fri, 18 Aug 1995 19:29:38 PDT
From: Bill Fenner <fenner@parc.xerox.com>
Reply-To: fenner@parc.xerox.com
To: FreeBSD-gnats-submit@freebsd.org
Subject: /sys/net/if.h comments scrogged
X-Send-Pr-Version: 3.2

>Number:         700
>Category:       kern
>Synopsis:       The comments in /sys/net/if.h are confusing
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    steve
>State:          closed
>Quarter:
>Keywords:
>Date-Required:
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Aug 18 19:30:02 PDT 1995
>Closed-Date:    Sun Jan 11 16:21:07 PST 1998
>Last-Modified:  Sun Jan 11 16:22:16 PST 1998
>Originator:     Bill Fenner
>Release:        FreeBSD 2.0-BUILT-19950527 i386
>Organization:
Xerox PARC
>Environment:

	
-current source

>Description:

	
The comments that go with the structures in <net/if.h> don't appear to
actually go with the structures that they are near.

I have always associated the comment "would like to call this if" with
struct ifnet, but that comment is now near struct ifqueue.  struct ifnet
is described as being information which may be of interest to management
entities, which sounds more like struct if_data.  struct if_data has no
description at all.

>How-To-Repeat:

	

>Fix:
	
	

--- /usr/src/current/sys/net/if.h.orig	Sat Aug 19 02:24:10 1995
+++ /usr/src/current/sys/net/if.h	Sat Aug 19 02:24:43 1995
@@ -79,6 +79,10 @@
 struct	ether_header;
 #endif
 
+/*
+ * Structure describing information about an interface
+ * which may be of interest to management entities.
+ */
 struct if_data {
 	/* generic interface information */
 	u_char	ifi_type;		/* ethernet, tokenring, etc */
@@ -105,10 +109,7 @@
 
 /*
  * Structure defining a queue for a network interface.
- *
- * (Would like to call this struct ``if'', but C isn't PL/1.)
  */
-
 struct	ifqueue {
 	struct	mbuf *ifq_head;
 	struct	mbuf *ifq_tail;
@@ -118,8 +119,9 @@
 };
 
 /*
- * Structure describing information about an interface
- * which may be of interest to management entities.
+ * Structure defining a network interface.
+ *
+ * (Would like to call this struct ``if'', but C isn't PL/1.)
  */
 struct ifnet {
 	char	*if_name;		/* name, e.g. ``en'' or ``lo'' */
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: scrappy 
State-Changed-When: Sun May 26 22:47:22 PDT 1996 
State-Changed-Why:  
include file sys/net/in.h doesn't exist anymore... 
State-Changed-From-To: closed->open 
State-Changed-By: fenner 
State-Changed-When: Mon May 27 09:31:17 PDT 1996 
State-Changed-Why:  
problem still exists 


Responsible-Changed-From-To: freebsd-bugs->fenner 
Responsible-Changed-By: fenner 
Responsible-Changed-When: Mon May 27 09:31:17 PDT 1996 
Responsible-Changed-Why:  
I might as well fix my own complaints 
State-Changed-From-To: open->closed 
State-Changed-By: fenner 
State-Changed-When: Mon Oct 21 16:06:01 PDT 1996 
State-Changed-Why:  
Suggested fixes applied. 
State-Changed-From-To: closed->open 
State-Changed-By: fenner 
State-Changed-When: Wed Aug 13 18:21:43 PDT 1997 
State-Changed-Why:  
testing gnats with old PR that belonged to me anyway 


Responsible-Changed-From-To: fenner->fenner@cmf.nrl.navy.mil 
Responsible-Changed-By: fenner 
Responsible-Changed-When: Wed Aug 13 18:21:43 PDT 1997 
Responsible-Changed-Why:  
testotronic 
State-Changed-From-To: open->closed 
State-Changed-By: steve 
State-Changed-When: Sun Jan 11 16:21:07 PST 1998 
State-Changed-Why:  
This was fixed in revision 1.36 by Bill Fenner and re-opened 
later as a test but never closed again. 
>Unformatted:
