Date: Sun, 10 Aug 2003 02:06:22 +0200 From: "Simon L. Nielsen" <simon@FreeBSD.org> To: "Bruce A. Mah" <bmah@freebsd.org> Cc: Ruslan Ermilov <ru@FreeBSD.org> Subject: Re: Hardware notes Message-ID: <20030810000622.GF396@FreeBSD.org> In-Reply-To: <20030809000230.GA53916@FreeBSD.org> References: <Pine.LNX.4.44.0308081232001.28480-100000@pancho> <200308082326.h78NQpmh056949@intruder.kitchenlab.org> <20030809000230.GA53916@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--RMedoP2+Pr6Rq0N2 Content-Type: multipart/mixed; boundary="xkXJwpr35CY/Lc3I" Content-Disposition: inline --xkXJwpr35CY/Lc3I Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On 2003.08.09 02:02:31 +0200, Simon L. Nielsen wrote: >=20 > [Bruce wants to simplify the hardware notes, and mainly make the > hardware notes references to the section 4 manual pages] >=20 > I have been thinking a bit about the hardware notes today, and I got a > crazy idea... If each section 4 manual page listed the supported > devices in some machine parseable way (e.g. in a seperate section?), the > device list could actually be extracted from the manual pages and used > in the release notes. Then the actual list would only be one place for > each driver. While it might sound a bit crazy, I actually think it > could work. Of course it would require some work in the manual pages, > but it shouldn't be too hard. It was suggested that I should do a proof of concept, so I did. I actually think it works pretty well, but I'm still not really sure if I think this is the way to go, since manual pages were not really made for this. Anyway, I tried with three more or less random manual pages (dc/asr/twe) and I have attached the diff to the manual pages and the output from my script pasted into the DocBook hardware notes. The resulting hardware notes : http://people.freebsd.org/~simon/mdoc2html/article.html#SUPPORT The Perl script: http://people.freebsd.org/~simon/mdoc2html/mdoc2sgml --=20 Simon L. Nielsen FreeBSD Documentation Team --xkXJwpr35CY/Lc3I Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="hwnotes-manparse.patch" --- /FreeBSD/CURRENT/share/man/man4/asr.4 Wed Apr 30 02:36:11 2003 +++ asr.4 Sun Aug 10 00:52:30 2003 @@ -15,6 +15,7 @@ .Sh SYNOPSIS .Cd "device asr" .Sh DESCRIPTION +.\"HWLIST START - This is a marker for mdoc2sgml - don't remove The Adaptec .Nm driver provides access to disks @@ -57,6 +58,7 @@ DEC KZPCC-XC (LVD 1-ch, 16MB cache), DEC KZPCC-XE (LVD 3-ch, 64MB cache) -- rebadged SmartRAID V Millennium .El +.\"HWLIST STOP - This is a marker for mdoc2sgml - don't remove .Pp Some of the adapters provide 64 bit PCI, Compact PCI, --- /FreeBSD/CURRENT/share/man/man4/dc.4 Fri Jul 11 15:10:28 2003 +++ dc.4 Sat Aug 9 23:18:06 2003 @@ -40,6 +40,7 @@ .Cd "device miibus" .Cd "device dc" .Sh DESCRIPTION +.\"HWLIST START - This is a marker for mdoc2sgml - don't remove The .Nm driver provides support for several PCI fast ethernet adapters and @@ -65,6 +66,7 @@ .It Conexant LANfinity RS7112 (miniPCI) .El +.\"HWLIST STOP - This is a marker for mdoc2sgml - don't remove .Pp All of these chips have the same general register layout, DMA descriptor format and method of operation. --- /FreeBSD/CURRENT/share/man/man4/twe.4 Fri Jul 18 11:13:09 2003 +++ twe.4 Sun Aug 10 01:11:04 2003 @@ -34,6 +34,7 @@ .Cd device pci .Cd device twe .Sh DESCRIPTION +.\"HWLIST START - This is a marker for mdoc2sgml - don't remove The .Nm driver provides support for the following series of ATA RAID @@ -49,6 +50,7 @@ .It Escalade 3W-8x00 .El +.\"HWLIST STOP - This is a marker for mdoc2sgml - don't remove .Pp These devices support 2, 4 or 8 ATA disk drives and provide RAID0 (striping) and RAID1 (mirroring) functionality. --xkXJwpr35CY/Lc3I Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename="hwnotes-manparse-article.patch" Content-Transfer-Encoding: quoted-printable Index: common/dev.sgml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D RCS file: /home/ncvs/src/release/doc/en_US.ISO8859-1/hardware/common/dev.sg= ml,v retrieving revision 1.163 diff -u -d -r1.163 dev.sgml --- common/dev.sgml 29 Jun 2003 01:12:57 -0000 1.163 +++ common/dev.sgml 9 Aug 2003 23:33:23 -0000 @@ -36,6 +36,14 @@ =20 <title>Supported Devices</title> =20 + <para>The next three lists (dc/asr/twe) have been generated by mdoc2sgml= :</para> + + &hwlist.dc.4; + + &hwlist.asr.4; + + &hwlist.twe.4; + <para>This section describes the devices currently known to be supported by with &os; on the &arch.print; platform. Other configuratio= ns may also work, but simply have not been tested yet. Feedback, Index: i386/article.sgml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D RCS file: /home/ncvs/src/release/doc/en_US.ISO8859-1/hardware/i386/article.= sgml,v retrieving revision 1.4 diff -u -d -r1.4 article.sgml --- i386/article.sgml 3 Dec 2002 18:00:30 -0000 1.4 +++ i386/article.sgml 9 Aug 2003 23:30:19 -0000 @@ -16,6 +16,151 @@ <!ENTITY arch "i386"> <!ENTITY arch.print "i386"> =20 + +<!-- Start of auto generated list - this has just been copy/pasted in + here --> + +<!ENTITY hwlist.dc.4 ' +<para>The +&man.dc.4; +driver provides support for several PCI fast ethernet adapters and +embedded controllers based on the following chipsets: +</para> +<itemizedlist> +<listitem> +<para>DEC/Intel 21143 +</para> +</listitem> +<listitem> +<para>Macronix 98713, 98713A, 98715, 98715A, 98725, 98727 and 98732 +</para> +</listitem> +<listitem> +<para>Davicom DM9100, DM9102 and DM9102A +</para> +</listitem> +<listitem> +<para>ASIX Electronics AX88140A and AX88141 +</para> +</listitem> +<listitem> +<para>ADMtek AL981 Comet and AN985 Centaur +</para> +</listitem> +<listitem> +<para>Lite-On 82c168 and 82c169 PNIC +</para> +</listitem> +<listitem> +<para>Lite-On/Macronix 82c115 PNIC II +</para> +</listitem> +<listitem> +<para>Xircom X3201 (cardbus only) +</para> +</listitem> +<listitem> +<para>Conexant LANfinity RS7112 (miniPCI) +</para> +</listitem></itemizedlist> +'> +<!ENTITY hwlist.asr.4 ' +<para>The Adaptec +&man.asr.4; +driver provides access to disks +and disk arrays controlled by I2O based host bus adapters and +SmartRAID SCSI RAID adapters through the standard SCSI disk +interface. +The adapters currently supported include the following RAID adapters: +</para> +<itemizedlist> +<listitem> +<para>Adaptec Zero-Channel SCSI RAID 2000S & 2005S +</para> +</listitem> +<listitem> +<para>Adaptec SCSI RAID 2100S (2110S) +</para> +</listitem> +<listitem> +<para>Adaptec ATA-100 RAID 2400A +</para> +</listitem> +<listitem> +<para>Adaptec SCSI RAID 3200S (3210S) +</para> +</listitem> +<listitem> +<para>Adaptec SCSI RAID 3400S (3410S) +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM1554 +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM2554 +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM2564 +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM2664 +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM2865 +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM3754 +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM3755U2B / SmartRAID V Millennium +</para> +</listitem> +<listitem> +<para>Adaptec SmartRAID PM3757 +</para> +</listitem> +<listitem> +<para>DEC KZPCC-AC (LVD 1-ch, 4MB or 16MB cache), +DEC KZPCC-CE (LVD 3-ch, 64MB cache), +DEC KZPCC-XC (LVD 1-ch, 16MB cache), +DEC KZPCC-XE (LVD 3-ch, 64MB cache) -- rebadged SmartRAID V Millennium +</para> +</listitem></itemizedlist> +'> +<!ENTITY hwlist.twe.4 ' +<para>The +&man.twe.4; +driver provides support for the following series of ATA RAID +controllers: +</para> +<itemizedlist> +<listitem> +<para>Escalade 3W-5x00 +</para> +</listitem> +<listitem> +<para>Escalade 3W-6x00 +</para> +</listitem> +<listitem> +<para>Escalade 3W-7x00 +</para> +</listitem> +<listitem> +<para>Escalade 3W-8x00 +</para> +</listitem></itemizedlist> +'> + +<!-- End of auto generated list --> + ]> =20 <article> --xkXJwpr35CY/Lc3I-- --RMedoP2+Pr6Rq0N2 Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2 (FreeBSD) iD8DBQE/NYx+h9pcDSc1mlERAmC6AJsGivDM7cwI/QqSbI1QSrclY2fwJgCdEnir 7ZPPTDQ0+gVw1khsOE6hu64= =KB5y -----END PGP SIGNATURE----- --RMedoP2+Pr6Rq0N2--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030810000622.GF396>