Bug 14567

Summary: camcontrol(8) sez to see cam(9) and xpt(9) but there ain't no such
Product: Documentation Reporter: Ronald F. Guilmette <rfg>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Ronald F. Guilmette 1999-10-28 01:50:01 UTC
	The camcontrol(8) man page sez:

	SEE ALSO
		cam(3),  cam_cdbparse(3),  pass(4),  cam(9),  xpt(9)
                                                     ^^^^^^   ^^^^^^

	Unfortunately, `man 9 cam' produces only:

		No entry for cam in section 9 of the manual

	Likewise for `man 9 xpt'.

Fix: 

? Create a cam(9) man page ?
How-To-Repeat: 
	man 9 cam
	man 9 xpt
Comment 1 chris 1999-10-28 01:55:23 UTC
On Wed, Oct 27, 1999, Ronald F. Guilmette wrote:
> >Fix:
> 
> 	? Create a cam(9) man page ?

   Yes please.  You can send the patches as a reply to this PR.
I've been meaning to figure out what to document, but if you're
willing to do it, I will accept, review (and have Ken review)
and commit the pages.

-- 
|Chris Costello <chris@calldei.com>
|If you have a procedure with 10 parameters, you probably missed some.
`---------------------------------------------------------------------
Comment 2 Ronald F. Guilmette 1999-10-28 02:08:30 UTC
In message <19991027195523.F70024@holly.calldei.com>, you wrote:

>On Wed, Oct 27, 1999, Ronald F. Guilmette wrote:
>> >Fix:
>> 
>> 	? Create a cam(9) man page ?
>
>   Yes please.  You can send the patches as a reply to this PR.
>I've been meaning to figure out what to document, but if you're
>willing to do it, I will accept, review (and have Ken review)
>and commit the pages.

Umm....

I'd love to help out.  Really.  But given that I don't have the foggiest
idea what `cam' even is, I don't think that I'm the proper person to be
doing this particular task.
Comment 3 Matthew Hunt 1999-10-28 17:39:20 UTC
On Wed, Oct 27, 1999 at 06:00:02PM -0700, Chris Costello wrote:

>  > 	? Create a cam(9) man page ?
>  
>     Yes please.  You can send the patches as a reply to this PR.
>  I've been meaning to figure out what to document, but if you're
>  willing to do it, I will accept, review (and have Ken review)
>  and commit the pages.

cam(4) and xpt(4) exist.  My assumption is that camcontrol(8)
should refer to these, and the (9) was a mistake?

-- 
Matthew Hunt <mph@astro.caltech.edu> * UNIX is a lever for the
http://www.pobox.com/~mph/           * intellect. -J.R. Mashey
Comment 4 ken 1999-10-28 17:59:22 UTC
Matthew Hunt wrote...
> On Wed, Oct 27, 1999 at 06:00:02PM -0700, Chris Costello wrote:
> 
> >  > 	? Create a cam(9) man page ?
> >  
> >     Yes please.  You can send the patches as a reply to this PR.
> >  I've been meaning to figure out what to document, but if you're
> >  willing to do it, I will accept, review (and have Ken review)
> >  and commit the pages.
> 
> cam(4) and xpt(4) exist.  My assumption is that camcontrol(8)
> should refer to these, and the (9) was a mistake?

Yes, camcontrol(8) should refer to cam(4) and xpt(4).

As for the xpt(9) and cam(9) references, look in the BUGS section of the
camcontrol(8) man page:

BUGS
     Most of the man page cross references don't exist yet.  This will be
     fixed soon.

Of course, it's been over a year, and I haven't had time to write cam(9) or
xpt(9).

If the missing cross-references are causing problems, go ahead and take
them out, but make sure you take out the paragraph from the BUGS section
as well.

Ken
-- 
Kenneth Merry
ken@kdm.org
Comment 5 mph freebsd_committer freebsd_triage 1999-10-28 18:20:23 UTC
State Changed
From-To: open->closed

I have added cam(4) and xpt(4) to SEE ALSO, deleted cam(9) and xpt(9) which 
do not exist, and deleted the BUGS statement which says they'll be 
added soon.