Hardware notes

Sun Aug 10 00:06:26 UTC 2003

On 2003.08.09 02:02:31 +0200, Simon L. Nielsen wrote:
> 
> [Bruce wants to simplify the hardware notes, and mainly make the
> hardware notes references to the section 4 manual pages]
> 
> 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

-- 
Simon L. Nielsen
FreeBSD Documentation Team
-------------- next part --------------

--- /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.
-------------- next part --------------
Index: common/dev.sgml
===================================================================
RCS file: /home/ncvs/src/release/doc/en_US.ISO8859-1/hardware/common/dev.sgml,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 @@
 
   <title>Supported Devices</title>
 
+  <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 configurations
   may also work, but simply have not been tested yet.  Feedback,
Index: i386/article.sgml
===================================================================
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">
 
+
+<!-- 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 -->
+
 ]>
 
 <article>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030810/eddab2b4/attachment.sig>
