From owner-freebsd-bugs  Fri Aug 18 19:30:05 1995
Return-Path: bugs-owner
Received: (from majordom@localhost)
          by freefall.FreeBSD.org (8.6.11/8.6.6) id TAA08312
          for bugs-outgoing; Fri, 18 Aug 1995 19:30:05 -0700
Received: (from gnats@localhost)
          by freefall.FreeBSD.org (8.6.11/8.6.6) id TAA08305
          ; Fri, 18 Aug 1995 19:30:04 -0700
Resent-Date: Fri, 18 Aug 1995 19:30:04 -0700
Resent-Message-Id: <199508190230.TAA08305@freefall.FreeBSD.org>
Resent-From: gnats (GNATS Management)
Resent-To: freebsd-bugs
Resent-Reply-To: FreeBSD-gnats@freefall.FreeBSD.org, fenner@parc.xerox.com
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
X-Send-Pr-Version: 3.2
Subject: kern/700: /sys/net/in.h comments scrogged
Sender: bugs-owner@freebsd.org
Precedence: bulk


>Number:         700
>Category:       kern
>Synopsis:       The comments in /sys/net/in.h are confusing
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-bugs
>State:          open
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Aug 18 19:30:02 PDT 1995
>Last-Modified:
>Originator:     Bill Fenner
>Organization:
Xerox PARC
>Release:        FreeBSD 2.0-BUILT-19950527 i386
>Environment:

	
-current source

>Description:

	
The comments that go with the structures in <net/in.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'' */
>Audit-Trail:
>Unformatted: