docs/84676: atacontrol manpage not current for V5, V6, and -current

[Kevin Oberman]

>Number:         84676
>Category:       docs
>Synopsis:       atacontrol manpage not current for V5, V6, and -current
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Aug 08 18:50:10 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Kevin Oberman
>Release:        FreeBSD 5.4-STABLE i386
>Organization:
>Environment:
System: FreeBSD ptavv.es.net 5.4-STABLE FreeBSD 5.4-STABLE #37: Fri Jan 28 11:48:02 PST 2005 oberman at ptavv.es.net:/usr/obj/usr/src/sys/PTAVV i386

>Description:
The man page for atacontrol(8) does not reflect the current syntax of
the command. The argumnets for several commands have changed from
simply the controller number to the controller name, but the man pages
don't reflect this.

>How-To-Repeat:
N/A

>Fix:

--- atacontrol.8	Mon May 16 08:09:13 2005
+++ atacontrol.8.new	Fri May 20 09:27:35 2005
@@ -38,13 +38,13 @@
 .Pp
 .Nm
 .Ic attach
-.Ar channel
+.Ar controller
 .Nm
 .Ic detach
-.Ar channel
+.Ar controller
 .Nm
 .Ic reinit
-.Ar channel
+.Ar controller
 .Nm
 .Ic create
 .Ar type Oo Ar interleave Oc Ar disk0 ... diskN
@@ -65,7 +65,7 @@
 .Ar device
 .Nm
 .Ic info
-.Ar channel
+.Ar controller
 .Nm
 .Ic cap
 .Ar device
@@ -87,25 +87,26 @@
 exercise caution when using this command!
 .Pp
 The
-.Ar channel
-argument is the number of the ATA channel on which to operate.
+.Ar controller
+argument is the name of the ATA controller on which to operate. Ususally
+'ataN'.
 The following commands are supported:
 .Bl -tag -width "rebuild"
 .It Ic attach
 Attach an ATA
-.Ar channel .
-Devices on the channel are probed and attached as
+Ar controller .
+Devices on the controller are probed and attached as
 is done on boot.
 .It Ic detach
 Detach an ATA
-.Ar channel .
-Devices on the channel are removed from the kernel,
+.Ar controller .
+Devices on the controlller are removed from the kernel,
 and all outstanding transfers etc.\& are returned back to the system marked
 as failed.
 .It Ic reinit
 Reinitialize an ATA
-.Ar channel .
-Both devices on the channel are reset and
+.Ar controller .
+Both devices on the controller are reset and
 initialized to the parameters the ATA driver has stored internally.
 Devices that have gone bad and no longer respond to the probe, or devices
 that have physically been removed, are removed from the kernel.
@@ -192,7 +193,7 @@
 .Ar device .
 .It Ic info
 Show info about the attached devices on the
-.Ar channel .
+.Ar controller .
 .It Ic list
 Show info about all attached devices on all active controllers.
 .El



>Release-Note:
>Audit-Trail:
>Unformatted: