Bug 44337

Summary: [PATCH] netstat(1) manual references nonexistent mbuf(9)
Product: Documentation Reporter: Ryan Beasley <ryanb>
Component: Books & ArticlesAssignee: Hiten Pandya <hmp>
Status: Closed FIXED    
Severity: Affects Only Me CC: ryanb
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Ryan Beasley 2002-10-21 14:50:03 UTC
	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)

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.
How-To-Repeat: 	man 1 netstat
Comment 1 Hiten Pandya freebsd_committer freebsd_triage 2003-05-26 20:24:51 UTC
State Changed
From-To: open->analyzed

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. 


Comment 2 Hiten Pandya freebsd_committer freebsd_triage 2003-05-26 20:24:51 UTC
Responsible Changed
From-To: freebsd-doc->hmp

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.
Comment 3 Yar Tikhiy freebsd_committer freebsd_triage 2003-05-28 15:27:16 UTC
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
Comment 4 Hiten Pandya freebsd_committer freebsd_triage 2003-05-28 17:35:25 UTC
State Changed
From-To: analyzed->patched

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.
Comment 5 Hiten Pandya freebsd_committer freebsd_triage 2003-09-02 02:40:50 UTC
State Changed
From-To: patched->closed

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.