From nobody@FreeBSD.org  Wed Mar 11 06:25:12 2009
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 0DC331065675
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 11 Mar 2009 06:25:12 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id F07108FC18
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 11 Mar 2009 06:25:11 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id n2B6PBdq027834
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 11 Mar 2009 06:25:11 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id n2B6PBh9027833;
	Wed, 11 Mar 2009 06:25:11 GMT
	(envelope-from nobody)
Message-Id: <200903110625.n2B6PBh9027833@www.freebsd.org>
Date: Wed, 11 Mar 2009 06:25:11 GMT
From: Garrett Cooper <yaneurabeya@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [PATCH] Fix documentation for atapicam(4) and umass(4)
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         132525
>Category:       docs
>Synopsis:       [PATCH] Fix documentation for atapicam(4) and umass(4)
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    brueffer
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Mar 11 06:30:05 UTC 2009
>Closed-Date:    Wed Oct 28 18:47:18 CET 2009
>Last-Modified:  Sun Feb 03 22:27:53 UTC 2013
>Originator:     Garrett Cooper
>Release:        8-CURRENT
>Organization:
n/a
>Environment:
>Description:
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.
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

Index: share/man/man4/umass.4
===================================================================
--- share/man/man4/umass.4	(revision 189678)
+++ share/man/man4/umass.4	(working copy)
@@ -38,6 +38,9 @@
 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
Index: share/man/man4/atapicam.4
===================================================================
--- share/man/man4/atapicam.4	(revision 189678)
+++ share/man/man4/atapicam.4	(working copy)
@@ -34,6 +34,9 @@
 .Nm atapicam
 .Nd CAM XPT (transport) module for ATAPI devices
 .Sh SYNOPSIS
+.Cd "device scbus"
+.Cd "device cam"
+.Cd "device ata"
 .Cd "device atapicam"
 .Sh DESCRIPTION
 The ATAPI/CAM module allows ATAPI devices (CD-ROM, CD-RW, DVD drives,


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: brueffer 
State-Changed-When: Thu Oct 22 13:35:21 CEST 2009 
State-Changed-Why:  
Committed, thanks! 


Responsible-Changed-From-To: freebsd-doc->brueffer 
Responsible-Changed-By: brueffer 
Responsible-Changed-When: Thu Oct 22 13:35:21 CEST 2009 
Responsible-Changed-Why:  
MFC reminder. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/132525: commit references a PR
Date: Thu, 22 Oct 2009 11:35:26 +0000 (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"
 
State-Changed-From-To: patched->closed 
State-Changed-By: brueffer 
State-Changed-When: Wed Oct 28 18:47:05 CET 2009 
State-Changed-Why:  
MFCs done. 

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