Bug 132525

Summary: [PATCH] Fix documentation for atapicam(4) and umass(4)
Product: Documentation Reporter: Enji Cooper <ngie>
Component: Books & ArticlesAssignee: Christian Brueffer <brueffer>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Enji Cooper freebsd_committer freebsd_triage 2009-03-11 06:30:05 UTC 
The manpages for atapicam and umass are correct, but lacking the device details. Let's add in the other required components for atapicam and umass in the requirements section, like with msk(4) for instance.

Fix: Patch attached with submission follows:
Comment 1 Christian Brueffer freebsd_committer freebsd_triage 2009-10-22 12:35:21 UTC 
State Changed
From-To: open->patched

Committed, thanks!
Comment 2 Christian Brueffer freebsd_committer freebsd_triage 2009-10-22 12:35:21 UTC 
Responsible Changed
From-To: freebsd-doc->brueffer

MFC reminder.
Comment 3 dfilter service freebsd_committer freebsd_triage 2009-10-22 12:35:26 UTC 
Author: brueffer
Date: Thu Oct 22 11:35:12 2009
New Revision: 198363
URL: http://svn.freebsd.org/changeset/base/198363

Log:
  List more dependencies for these drivers. While here, convert
  atapicam(4) to use our standard section 4 SYNOPSIS layout.
  
  PR:		132525
  Submitted by:	gcooper
  MFC after:	3 days

Modified:
  head/share/man/man4/atapicam.4
  head/share/man/man4/umass.4

Modified: head/share/man/man4/atapicam.4
==============================================================================
--- head/share/man/man4/atapicam.4	Thu Oct 22 09:39:32 2009	(r198362)
+++ head/share/man/man4/atapicam.4	Thu Oct 22 11:35:12 2009	(r198363)
@@ -27,14 +27,29 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd October 23, 2002
+.Dd October 22, 2009
 .Dt ATAPICAM 4
 .Os
 .Sh NAME
 .Nm atapicam
 .Nd CAM XPT (transport) module for ATAPI devices
 .Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device scbus"
+.Cd "device cam"
+.Cd "device ata"
 .Cd "device atapicam"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+atapicam_load="YES"
+.Ed
 .Sh DESCRIPTION
 The ATAPI/CAM module allows ATAPI devices (CD-ROM, CD-RW, DVD drives,
 floppy drives such as Iomega Zip, tape drives) to be accessed through

Modified: head/share/man/man4/umass.4
==============================================================================
--- head/share/man/man4/umass.4	Thu Oct 22 09:39:32 2009	(r198362)
+++ head/share/man/man4/umass.4	Thu Oct 22 11:35:12 2009	(r198363)
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 22, 2006
+.Dd October 22, 2009
 .Dt UMASS 4
 .Os
 .Sh NAME
@@ -38,6 +38,9 @@ To compile this driver into the kernel,
 place the following line in your
 kernel configuration file:
 .Bd -ragged -offset indent
+.Cd "device scbus"
+.Cd "device cam"
+.Cd "device usb"
 .Cd "device umass"
 .Ed
 .Pp
_______________________________________________
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"
Comment 4 Christian Brueffer freebsd_committer freebsd_triage 2009-10-28 17:47:05 UTC 
State Changed
From-To: patched->closed

MFCs done.