From ryanb@goddamnbastard.org  Mon Oct 21 06:49:34 2002
Return-Path: <ryanb@goddamnbastard.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id B12B537B401
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 21 Oct 2002 06:49:34 -0700 (PDT)
Received: from jesper.goddamnbastard.org (12-251-154-208.client.attbi.com [12.251.154.208])
	by mx1.FreeBSD.org (Postfix) with ESMTP id B242C43E65
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 21 Oct 2002 06:49:28 -0700 (PDT)
	(envelope-from ryanb@goddamnbastard.org)
Received: by jesper.goddamnbastard.org (Postfix, from userid 1000)
	id 9657D154AB; Mon, 21 Oct 2002 08:49:27 -0500 (CDT)
Message-Id: <20021021134927.9657D154AB@jesper.goddamnbastard.org>
Date: Mon, 21 Oct 2002 08:49:27 -0500 (CDT)
From: ryan beasley <ryanb@goddamnbastard.org>
Reply-To: ryan beasley <ryanb@goddamnbastard.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc: ryan beasley <ryanb@goddamnbastard.org>
Subject: [PATCH] netstat(1) manual references nonexistent mbuf(9)
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         44337
>Category:       docs
>Synopsis:       [PATCH] netstat(1) manual references nonexistent mbuf(9)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    hmp
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Oct 21 06:50:03 PDT 2002
>Closed-Date:    Mon Sep 01 18:42:18 PDT 2003
>Last-Modified:  Mon Sep 01 18:42:18 PDT 2003
>Originator:     ryan beasley
>Release:        FreeBSD 4.6.2-RELEASE i386
>Organization:
>Environment:
	Any RELENG_4 system.
>Description:
	The netstat(1) manual contains reference to mbuf(9).  mbuf(9)
	doesn't exist on the RELENG_4 branch.

	e.g.:

	netstat -m [-M core] [-N system]
             Show statistics recorded by the memory management routines
             (mbuf(9)).  The network manages a private pool of memory
	     buffers.
	...
	SEE ALSO
	     fstat(1), nfsstat(1), ps(1), sockstat(1), inet(4), route(4),
	     unix(4), hosts(5), networks(5), protocols(5), services(5),
	     iostat(8), route(8), trpt(8), vmstat(8), mbuf(9)
>How-To-Repeat:
	man 1 netstat
>Fix:
	While it may be optimal to grab the HEAD revision mbuf(9) and edit
	to match up with any differences found in RELENG_4, the following
	patch will at least correct the mismatched manual.

--- usr.bin/netstat/netstat.1.orig	Mon Oct 21 08:34:41 2002
+++ usr.bin/netstat/netstat.1	Mon Oct 21 08:35:04 2002
@@ -182,9 +182,8 @@
 .Op Fl N Ar system
 .Ek
 .Xc
-Show statistics recorded by the memory management routines
-.Pq Xr mbuf 9 .
-The network manages a private pool of memory buffers.
+Show statistics recorded by the memory management routines.  The network
+manages a private pool of memory buffers.
 .It Xo
 .Bk -words
 .Nm
@@ -421,8 +420,7 @@
 .Xr iostat 8 ,
 .Xr route 8 ,
 .Xr trpt 8 ,
-.Xr vmstat 8 ,
-.Xr mbuf 9
+.Xr vmstat 8
 .Sh HISTORY
 The
 .Nm

>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->analyzed 
State-Changed-By: hmp 
State-Changed-When: Mon May 26 12:24:51 PDT 2003 
State-Changed-Why:  
I have looked into this matter, and also discussed with one of our 
Mbuf subsystem guru, Bosko Milekic.  The mbuf(9) man page in -CURRENT 
is not good enough for MFC, and there also other issues with it. 

Work will be done to split up the mbuf(9) manual page into small other 
manual pages, with MLINKS and the whole deal, but this will take some 
time.  So I am taking this PR as a reminder. 


Responsible-Changed-From-To: freebsd-doc->hmp 
Responsible-Changed-By: hmp 
Responsible-Changed-When: Mon May 26 12:24:51 PDT 2003 
Responsible-Changed-Why:  
Assign this PR to me, I will look into this issue. 
Note, the mbuf(9) manual page in -CURRENT is not a good MFC candidate. 

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

From: Yar Tikhiy <yar@freebsd.org>
To: hmp@freebsd.org
Cc: freebsd-gnats-submit@freebsd.org, ryanb@goddamnbastard.org
Subject: Re: docs/44337: [PATCH] netstat(1) manual references nonexistent mbuf(9)
Date: Wed, 28 May 2003 18:27:16 +0400

 Hi Hiten,
 
 Excuse me than I managed to jump into the business of fixing this
 PR after you had taken it over.  I checked this PR's status two
 days ago, and it was taken by nobody.
 
 A few minutes ago I committed a version of mbuf(9) page to STABLE, 
 not noticing that you had displayed your interest in more thorough
 work at this issue.  I beg your pardon for that.
 
 What I did was taking mbuf(9) from CURRENT and axing macros and
 functions not applicable to STABLE.  That gave a page with a fair
 load of relevant information.  It will do for now.
 
 I'm unsure if it's a really good idea to divide mbuf(9) into several
 pages since all the mbuf macros and functions are too interrelated,
 and each of them does too little work to be granted with a separate
 manpage.  That's while arranging proper MLINKS would be great.
 
 -- 
 Yar
State-Changed-From-To: analyzed->patched 
State-Changed-By: hmp 
State-Changed-When: Wed May 28 09:35:25 PDT 2003 
State-Changed-Why:  
Yar Tikhiy (author of the manual page) has honoured the MFC 
request.  I still have to split the manual page, and do such 
things; for that reason, I am keeping this PR open, but in a 
patched state. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=44337 
State-Changed-From-To: patched->closed 
State-Changed-By: hmp 
State-Changed-When: Mon Sep 1 18:40:50 PDT 2003 
State-Changed-Why:  
As per the PR followup, I am currently do not have time 
to do the split of the manual page, and it was not a 
necessary thing. 

So close this PR.  Thank you to all who participated. 


http://www.freebsd.org/cgi/query-pr.cgi?pr=44337 
>Unformatted:
