HEDSUP: man -k cleanup (man -k RAID, some bits are missing)

Roman Kurakin rik at inse.ru
Tue May 15 16:42:16 UTC 2007


Hi all,

   Trying to obtain information about supported RAID devices in
the system via `man -k RAID` I've found that not all known
by me devices are there. So a grep-ed a bit and going to commit
the following patchset. I think that keyword RAID should present
in description of all these man pages. But may be I am wrong?

There is also some bits I was not able to fix.
1) Is it safe to s/Array/RAID/ in ida(4)?
2) Is it safe to mark ciss as driver for RAID controllers?
3) Should be isp(4) marked as driver for RAID controllers?
4) Should geom(4) be patched as suggested in my patch or
it is enough of mentioning in corresponding class utilities?
5) Have I missed smth else?

PS. I think that there is other such places where `man -k` is not
complete, so its good todo idea, currently not for me ;-).
PPS. Sorry for crossposting. I hope I included all affected parties.

rik

Index: sbin/geom/class/concat/gconcat.8
===================================================================
RCS file: /home/ncvs/src/sbin/geom/class/concat/gconcat.8,v
retrieving revision 1.18
diff -u -r1.18 gconcat.8
--- sbin/geom/class/concat/gconcat.8    30 Jan 2006 22:47:07 -0000      1.18
+++ sbin/geom/class/concat/gconcat.8    15 May 2007 15:55:59 -0000
@@ -29,7 +29,7 @@
 .Os
 .Sh NAME
 .Nm gconcat
-.Nd "disk concatenation control utility"
+.Nd "disk concatenation control utility (software RAID capability)"
 .Sh SYNOPSIS
 .Nm
 .Cm create
Index: sbin/geom/class/mirror/gmirror.8
===================================================================
RCS file: /home/ncvs/src/sbin/geom/class/mirror/gmirror.8,v
retrieving revision 1.23
diff -u -r1.23 gmirror.8
--- sbin/geom/class/mirror/gmirror.8    21 Dec 2006 18:30:23 -0000      1.23
+++ sbin/geom/class/mirror/gmirror.8    15 May 2007 15:56:00 -0000
@@ -29,7 +29,7 @@
 .Os
 .Sh NAME
 .Nm gmirror
-.Nd "control utility for mirrored devices"
+.Nd "control utility for mirrored devices (software RAID1 capability)"
 .Sh SYNOPSIS
 .Nm
 .Cm label
Index: sbin/gvinum/gvinum.8
===================================================================
RCS file: /home/ncvs/src/sbin/gvinum/gvinum.8,v
retrieving revision 1.4
diff -u -r1.4 gvinum.8
--- sbin/gvinum/gvinum.8        30 Sep 2006 11:02:17 -0000      1.4
+++ sbin/gvinum/gvinum.8        15 May 2007 15:56:00 -0000
@@ -33,7 +33,7 @@
 .Os
 .Sh NAME
 .Nm gvinum
-.Nd Logical Volume Manager control program
+.Nd Logical Volume Manager control program (software RAID capability)
 .Sh SYNOPSIS
 .Nm
 .Op Ar command
Index: share/man/man4/asr.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/asr.4,v
retrieving revision 1.24
diff -u -r1.24 asr.4
--- share/man/man4/asr.4        2 Aug 2004 23:33:15 -0000       1.24
+++ share/man/man4/asr.4        15 May 2007 15:56:00 -0000
@@ -11,7 +11,7 @@
 .Os
 .Sh NAME
 .Nm asr
-.Nd driver for Adaptec I2O based SCSI/ATA host bus adapters
+.Nd driver for Adaptec I2O based SCSI/ATA RAID host bus adapters
 .Sh SYNOPSIS
 .Cd "device asr"
 .Sh DESCRIPTION
Index: share/man/man4/ccd.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/ccd.4,v
retrieving revision 1.32
diff -u -r1.32 ccd.4
--- share/man/man4/ccd.4        14 Apr 2006 09:20:24 -0000      1.32
+++ share/man/man4/ccd.4        15 May 2007 15:56:01 -0000
@@ -39,7 +39,7 @@
 .Os
 .Sh NAME
 .Nm ccd
-.Nd Concatenated Disk driver
+.Nd Concatenated Disk driver (software RAID capability)
 .Sh SYNOPSIS
 .Cd "device ccd"
 .Sh DESCRIPTION
Index: share/man/man4/geom.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/geom.4,v
retrieving revision 1.16
diff -u -r1.16 geom.4
--- share/man/man4/geom.4       25 May 2006 13:39:27 -0000      1.16
+++ share/man/man4/geom.4       15 May 2007 15:56:01 -0000
@@ -39,7 +39,8 @@
 .Dt GEOM 4
 .Sh NAME
 .Nm GEOM
-.Nd "modular disk I/O request transformation framework"
+.Nd "modular disk I/O request transformation framework (software RAID \
+capability)"
 .Sh DESCRIPTION
 The
 .Nm
Index: share/man/man4/mpt.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/mpt.4,v
retrieving revision 1.15
diff -u -r1.15 mpt.4
--- share/man/man4/mpt.4        7 Apr 2007 04:01:00 -0000       1.15
+++ share/man/man4/mpt.4        15 May 2007 15:56:01 -0000
@@ -40,7 +40,7 @@
 .Os
 .Sh NAME
 .Nm mpt
-.Nd LSI Fusion-MPT SCSI/Fibre Channel driver
+.Nd LSI Fusion-MPT SCSI/Fibre Channel driver with RAID capability
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following lines in your
Index: share/man/man4/pst.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/pst.4,v
retrieving revision 1.5
diff -u -r1.5 pst.4
--- share/man/man4/pst.4        20 May 2006 09:39:28 -0000      1.5
+++ share/man/man4/pst.4        15 May 2007 15:56:01 -0000
@@ -30,7 +30,7 @@
 .Os
 .Sh NAME
 .Nm pst
-.Nd device driver for Promise Supertrak SX6000
+.Nd device driver for Promise Supertrak SX6000 RAID adapter
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following line in your
Index: share/man/man4/vinum.4
===================================================================
RCS file: /home/ncvs/src/share/man/man4/vinum.4,v
retrieving revision 1.52
diff -u -r1.52 vinum.4
--- share/man/man4/vinum.4      11 Jun 2006 19:41:07 -0000      1.52
+++ share/man/man4/vinum.4      15 May 2007 15:56:02 -0000
@@ -41,7 +41,7 @@
 .Os
 .Sh NAME
 .Nm vinum
-.Nd Logical Volume Manager
+.Nd Logical Volume Manager (software RAID capability)
 .Sh SYNOPSIS
 .Cd "device vinum"
 .Sh DESCRIPTION



More information about the freebsd-current mailing list