From nobody@FreeBSD.org  Sun Jul 31 23:46:37 2011
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 168FC1065670
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 31 Jul 2011 23:46:37 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id 066DA8FC08
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 31 Jul 2011 23:46:37 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p6VNkaZ2052091
	for <freebsd-gnats-submit@FreeBSD.org>; Sun, 31 Jul 2011 23:46:36 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id p6VNkaCt052090;
	Sun, 31 Jul 2011 23:46:36 GMT
	(envelope-from nobody)
Message-Id: <201107312346.p6VNkaCt052090@red.freebsd.org>
Date: Sun, 31 Jul 2011 23:46:36 GMT
From: Garrett Cooper <yaneurabeya@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] incorrect reference to netinet/if_ether.h in ethers(3)
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         159341
>Category:       docs
>Synopsis:       [patch] incorrect reference to netinet/if_ether.h in ethers(3)
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    hrs
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Jul 31 23:50:07 UTC 2011
>Closed-Date:    Mon Aug 08 03:09:39 UTC 2011
>Last-Modified:  Sun Feb 03 22:29:13 UTC 2013
>Originator:     Garrett Cooper
>Release:        CURRENT
>Organization:
n/a
>Environment:
>Description:
ethers(3) recommends that the user should look in netinet/if_ether.h, instead of net/ethernet.h, where the definition actually resides.

This doc bug was introduced in r20288 ( http://svnweb.freebsd.org/base?view=revision&revision=20288 ).

This bug has been around for more than a decade.
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

Index: lib/libc/net/ethers.3
===================================================================
--- lib/libc/net/ethers.3	(revision 223824)
+++ lib/libc/net/ethers.3	(working copy)
@@ -68,7 +68,7 @@
 These functions operate on ethernet addresses using an
 .Vt ether_addr
 structure, which is defined in the header file
-.In netinet/if_ether.h :
+.In net/ethernet.h :
 .Bd -literal -offset indent
 /*
  * The number of bytes in an ethernet (MAC) address.


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->hrs 
Responsible-Changed-By: hrs 
Responsible-Changed-When: Mon Aug 1 16:09:31 UTC 2011 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=159341 
State-Changed-From-To: open->closed 
State-Changed-By: hrs 
State-Changed-When: Mon Aug 8 03:09:16 UTC 2011 
State-Changed-Why:  
Committed, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=159341 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/159341: commit references a PR
Date: Mon,  8 Aug 2011 03:09:12 +0000 (UTC)

 Author: hrs
 Date: Mon Aug  8 03:09:03 2011
 New Revision: 224701
 URL: http://svn.freebsd.org/changeset/base/224701
 
 Log:
   Fix a pathname (s,netinet/if_ether.h,net/ethernet.h,).
   
   PR:		docs/159341
   Submitted by:	Garrett Cooper
   Approved by:	re (kib)
 
 Modified:
   head/lib/libc/net/ethers.3
 
 Modified: head/lib/libc/net/ethers.3
 ==============================================================================
 --- head/lib/libc/net/ethers.3	Sun Aug  7 20:24:32 2011	(r224700)
 +++ head/lib/libc/net/ethers.3	Mon Aug  8 03:09:03 2011	(r224701)
 @@ -68,7 +68,7 @@
  These functions operate on ethernet addresses using an
  .Vt ether_addr
  structure, which is defined in the header file
 -.In netinet/if_ether.h :
 +.In net/ethernet.h :
  .Bd -literal -offset indent
  /*
   * The number of bytes in an ethernet (MAC) address.
 _______________________________________________
 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"
 
>Unformatted:
