Bug 52448

Summary: [patch] Misc man page reference fixes
Product: Documentation Reporter: simon <simon>
Component: Books & ArticlesAssignee: Simon L. B. Nielsen <simon>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
man-intro-3.patch
none
file.diff none

Description simon 2003-05-19 23:30:02 UTC
intro.3:
	Remove Xr references to libc, libcurses, libcompat, libkvm,
	libl, libtermcap and liby since they do not exists as man
	pages under those names.

	Add section number to libmp Xr reference (which do have a man
	page).
	Add libmp description - from libmp(3).

picobsd.8:
	Remove Xr reference to etherboot since it does not have a man
	page at all. Add reference to the location of the port instead.
Comment 1 phantom 2003-05-20 09:28:28 UTC
On Tue, May 20, 2003 at 12:24:10AM +0200, Simon L.Nielsen wrote:
> 
> >Number:         52448
> >Category:       docs
> >Synopsis:       [patch] Misc man page reference fixes

[..]

> >Description:
> intro.3:
> 	Remove Xr references to libc, libcurses, libcompat, libkvm,
> 	libl, libtermcap and liby since they do not exists as man
> 	pages under those names.
> 
> 	Add section number to libmp Xr reference (which do have a man
> 	page).
> 	Add libmp description - from libmp(3).

I'd rather prefer to someone write stub or normal (which is better) manual
pages for those libraries than removing Xr's.  Yet Another Junior Doc Hacker
Task -- ant takers ? :-)

> picobsd.8:
> 	Remove Xr reference to etherboot since it does not have a man
> 	page at all. Add reference to the location of the port instead.
Comment 2 simon 2003-05-20 10:10:49 UTC
On 2003.05.20 11:28:28 +0300, Alexey Zelkin wrote:
> On Tue, May 20, 2003 at 12:24:10AM +0200, Simon L.Nielsen wrote:
> > 
> > >Number:         52448
> > >Category:       docs
> > >Synopsis:       [patch] Misc man page reference fixes
> 
> [..]
> 
> > >Description:
> > intro.3:
> > 	Remove Xr references to libc, libcurses, libcompat, libkvm,
> > 	libl, libtermcap and liby since they do not exists as man
> > 	pages under those names.
> > 
> > 	Add section number to libmp Xr reference (which do have a man
> > 	page).
> > 	Add libmp description - from libmp(3).
> 
> I'd rather prefer to someone write stub or normal (which is better) manual
> pages for those libraries than removing Xr's.  Yet Another Junior Doc Hacker
> Task -- ant takers ? :-)


I might as well get to know mdoc better :-) I will have a look at theese.

Some of them might simply be fixed with proper links to existing man
page.  Update to follow once I get looked at it more.

-- 
Simon L. Nielsen
Comment 3 Simon L. B. Nielsen freebsd_committer freebsd_triage 2003-07-20 23:40:15 UTC
Responsible Changed
From-To: freebsd-doc->simon

I will handle my own PR's.
Comment 4 Simon L. B. Nielsen freebsd_committer freebsd_triage 2006-09-03 23:42:25 UTC
State Changed
From-To: open->closed

Close PR since I doubt I will ever get around to fixing this, and it's 
not really that important.