From nobody@FreeBSD.org  Sat Aug 20 21:00:42 2011
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 11BB21065674
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 20 Aug 2011 21:00:42 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id EB7E18FC14
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 20 Aug 2011 21:00:41 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p7KL0f8V018122
	for <freebsd-gnats-submit@FreeBSD.org>; Sat, 20 Aug 2011 21:00:41 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id p7KL0fVq018121;
	Sat, 20 Aug 2011 21:00:41 GMT
	(envelope-from nobody)
Message-Id: <201108202100.p7KL0fVq018121@red.freebsd.org>
Date: Sat, 20 Aug 2011 21:00:41 GMT
From: Ben Kaduk <kaduk@mit.edu>
To: freebsd-gnats-submit@FreeBSD.org
Subject: grammar updates to ata.4
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         159948
>Category:       docs
>Synopsis:       [patch] grammar updates to ata.4
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    brueffer
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Aug 20 21:10:10 UTC 2011
>Closed-Date:    Fri Sep 02 20:53:27 CEST 2011
>Last-Modified:  Fri Sep  2 19:00:28 UTC 2011
>Originator:     Ben Kaduk
>Release:        9-current
>Organization:
MIT SIPB
>Environment:
n/a
>Description:
Make a pass through ata.4 to clean up the grammar.
Also one instance of trailing whitespace, and a couple markup tweaks.
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

--- ata.4.orig	2011-08-20 15:51:14.000000000 -0400
+++ ata.4	2011-08-20 16:57:55.000000000 -0400
@@ -74,47 +74,54 @@
 atavia_load="YES"
 .Ed
 .Pp
-First line is common hardware independent code.
-Next three lines are generic bus-specific drivers.
-ataahci is AHCI driver.
-The rest are vendor-specific PCI drivers.
-ATA_CAM option should always remain in kernel configuration to make
-the driver work as CAM(4) subsystem module.
+The first line is for common hardware independent code, and is a
+prerequisite for the other modules.
+The next three lines are generic bus-specific drivers.
+Of the rest, ataahci is the AHCI driver.
+The others are vendor-specific PCI drivers.
+The ATA_CAM option should always remain in the kernel configuration, to make
+the driver work as a
+.Xr CAM 4
+subsystem module.
 .Pp
 The following tunables are settable from the
 .Xr loader 8 :
 .Bl -ohang
 .It Va hw.ata.ata_dma_check_80pin
-set to 0 to disable the 80pin cable check (default is 1, check the cable) 
+set to 0 to disable the 80pin cable check (the default is 1, check the cable)
 .It Va hint.atapci.X.msi
-set to 1 to allow Message Signalled Interrupts (MSI) to be used by
+set to 1 to allow Message Signalled Interrupts (MSI) to be used by the
 specified PCI ATA controller, if supported.
 .It Va hint.ata.X.devX.mode
-limits initial ATA mode for specified device on specified channel.
+limits the initial ATA mode for the specified device on the specified channel.
 .It Va hint.ata.X.mode
-limits initial ATA mode for every device on specified channel.
+limits the initial ATA mode for every device on the specified channel.
 .It Va hint.ata.X.pm_level
-controls SATA interface Power Management for specified channel,
-allowing to save some power by the cost of additional command latency.
+controls SATA interface Power Management for the specified channel,
+allowing some power savings at the cost of additional command latency.
 Possible values:
 .Bl -tag -compact
 .It 0
-interface Power Management is disabled, default value.
+Interface Power Management is disabled.
+This is the default value.
 .It 1
-device is allowed to initiate PM state change, host is passive.
+The device is allowed to initiate a PM state change; the host is passive.
 .It 2
-host initiates PARTIAL PM state transition every time port becomes idle.
+The host initiates a PARTIAL PM state transition every time a port becomes idle.
 .It 3
-host initiates SLUMBER PM state transition every time port becomes idle.
+The host initiates a SLUMBER PM state transition every time a port becomes idle.
 .El
-Modes 2 and 3 are supported only for AHCI.
+Modes 2 and 3 are only supported for AHCI.
 .El
 .Sh DESCRIPTION
 The
 .Nm
-driver provides the CAM(4) subsystem access to ATA (IDE) and SATA ports
+driver gives the
+.Xr CAM 4
+subsystem access to the ATA (IDE) and SATA ports
 of many generic controllers.
-Depending on controller, each PATA port or each one or two SATA ports are
+Depending on the controller, each PATA (IDE)
+port or each one or two SATA ports are
 represented to CAM as a separate bus with one or two targets.
 Most of the bus-management details are handled by the ATA/SATA-specific
 transport of CAM.
@@ -126,22 +133,21 @@
 .Xr sa 4 ,
 etc.
 .Pp
-Driver supports ATA and for the most of controllers ATAPI devices.
+This driver supports ATA, and for the most controllers, ATAPI devices.
 Command queuing and SATA port multipliers are not supported.
-Device hot-plug and SATA interface power management supported only on
+Device hot-plug and SATA interface power management is supported only on
 some controllers.
 .Pp
 The
 .Nm
 driver can change the transfer mode when the system is up and running.
-See
-.Xr camcontrol 8
-negotiate subcommand.
+See the negotiate subcommand of
+.Xr camcontrol 8 .
 .Pp
 The
 .Nm
 driver sets the maximum transfer mode supported by the hardware as default.
-However the
+However, the
 .Nm
 driver sometimes warns:
 .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: brueffer 
State-Changed-When: Fri Sep 2 20:52:35 CEST 2011 
State-Changed-Why:  
Committed together with some more markup fixes. Thanks! 


Responsible-Changed-From-To: freebsd-doc->brueffer 
Responsible-Changed-By: brueffer 
Responsible-Changed-When: Fri Sep 2 20:52:35 CEST 2011 
Responsible-Changed-Why:  
Committed together with some more markup fixes. Thanks! 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/159948: commit references a PR
Date: Fri,  2 Sep 2011 18:52:36 +0000 (UTC)

 Author: brueffer
 Date: Fri Sep  2 18:52:28 2011
 New Revision: 225352
 URL: http://svn.freebsd.org/changeset/base/225352
 
 Log:
   Wording, grammar and markup cleanup.
   
   PR:		159948
   Submitted by:	Ben Kaduk <kaduk@mit.edu>
   Approved by:	re (kib)
 
 Modified:
   head/share/man/man4/ata.4
 
 Modified: head/share/man/man4/ata.4
 ==============================================================================
 --- head/share/man/man4/ata.4	Fri Sep  2 18:52:17 2011	(r225351)
 +++ head/share/man/man4/ata.4	Fri Sep  2 18:52:28 2011	(r225352)
 @@ -74,47 +74,56 @@ atasis_load="YES"
  atavia_load="YES"
  .Ed
  .Pp
 -First line is common hardware independent code.
 -Next three lines are generic bus-specific drivers.
 -ataahci is AHCI driver.
 -The rest are vendor-specific PCI drivers.
 -ATA_CAM option should always remain in kernel configuration to make
 -the driver work as CAM(4) subsystem module.
 +The first line is for the common hardware independent code, and is a
 +prerequisite for the other modules.
 +The next three lines are generic bus-specific drivers.
 +Of the rest, ataahci is the AHCI driver.
 +The others are vendor-specific PCI drivers.
 +The
 +.Dv ATA_CAM
 +option should always remain in the kernel configuration, to make
 +the driver work as a
 +.Xr CAM 4
 +subsystem module.
  .Pp
  The following tunables are settable from the
  .Xr loader 8 :
  .Bl -ohang
  .It Va hw.ata.ata_dma_check_80pin
 -set to 0 to disable the 80pin cable check (default is 1, check the cable) 
 +set to 0 to disable the 80pin cable check (the default is 1, check the cable)
  .It Va hint.atapci.X.msi
 -set to 1 to allow Message Signalled Interrupts (MSI) to be used by
 +set to 1 to allow Message Signalled Interrupts (MSI) to be used by the
  specified PCI ATA controller, if supported.
  .It Va hint.ata.X.devX.mode
 -limits initial ATA mode for specified device on specified channel.
 +limits the initial ATA mode for the specified device on specified the channel.
  .It Va hint.ata.X.mode
 -limits initial ATA mode for every device on specified channel.
 +limits the initial ATA mode for every device on the specified channel.
  .It Va hint.ata.X.pm_level
 -controls SATA interface Power Management for specified channel,
 -allowing to save some power by the cost of additional command latency.
 +controls SATA interface Power Management for the specified channel,
 +allowing some power savings at the cost of additional command latency.
  Possible values:
  .Bl -tag -compact
  .It 0
 -interface Power Management is disabled, default value.
 +Interface Power Management is disabled.
 +This is the default value.
  .It 1
 -device is allowed to initiate PM state change, host is passive.
 +The device is allowed to initiate a PM state change; the host is passive.
  .It 2
 -host initiates PARTIAL PM state transition every time port becomes idle.
 +The host initiates a PARTIAL PM state transition every time a port becomes idle.
  .It 3
  host initiates SLUMBER PM state transition every time port becomes idle.
  .El
 -Modes 2 and 3 are supported only for AHCI.
 +Modes 2 and 3 are only supported for AHCI.
  .El
  .Sh DESCRIPTION
  The
  .Nm
 -driver provides the CAM(4) subsystem access to ATA (IDE) and SATA ports
 +driver gives the
 +.Xr CAM 4
 +subsystem access to the ATA (IDE) and SATA ports
  of many generic controllers.
 -Depending on controller, each PATA port or each one or two SATA ports are
 +Depending on the controller, each PATA (IDE)
 +port or each one or two SATA ports are
  represented to CAM as a separate bus with one or two targets.
  Most of the bus-management details are handled by the ATA/SATA-specific
  transport of CAM.
 @@ -126,22 +135,23 @@ ATAPI devices are handled by the SCSI pr
  .Xr sa 4 ,
  etc.
  .Pp
 -Driver supports ATA and for the most of controllers ATAPI devices.
 +This driver supports ATA, and for the most of controllers, ATAPI devices.
  Command queuing and SATA port multipliers are not supported.
 -Device hot-plug and SATA interface power management supported only on
 +Device hot-plug and SATA interface power management is supported only on
  some controllers.
  .Pp
  The
  .Nm
  driver can change the transfer mode when the system is up and running.
 -See
 -.Xr camcontrol 8
 -negotiate subcommand.
 +See the
 +.Cm negotiate
 +subcommand of
 +.Xr camcontrol 8 .
  .Pp
  The
  .Nm
  driver sets the maximum transfer mode supported by the hardware as default.
 -However the
 +However, the
  .Nm
  driver sometimes warns:
  .Dq Sy "DMA limited to UDMA33, non-ATA66 cable or device".
 @@ -247,10 +257,12 @@ The
  .Nm
  driver first appeared in
  .Fx 4.0 .
 -Turned into CAM(4) interface module in
 +It was turned into a
 +.Xr CAM 4
 +interface module in
  .Fx 9.0 .
  .Sh AUTHORS
  .An Alexander Motin
  .Aq mav@FreeBSD.org ,
  .An S\(/oren Schmidt
 -.Aq sos@FreeBSD.org .
 +.Aq sos@FreeBSD.org
 _______________________________________________
 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"
 
>Unformatted:
