From owner-freebsd-hackers Thu Apr 6 2:41:40 2000 Delivered-To: freebsd-hackers@freebsd.org Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66]) by hub.freebsd.org (Postfix) with ESMTP id 8D14437BB19 for ; Thu, 6 Apr 2000 02:41:29 -0700 (PDT) (envelope-from nik@nothing-going-on.demon.co.uk) Received: (from nik@localhost) by nothing-going-on.demon.co.uk (8.9.3/8.9.3) id JAA64134 for hackers@freebsd.org; Thu, 6 Apr 2000 09:57:25 +0100 (BST) (envelope-from nik) Date: Thu, 6 Apr 2000 09:57:25 +0100 From: Nik Clayton To: hackers@freebsd.org Subject: Task for -doc newbie / XML'ing LINT. . . Message-ID: <20000406095725.D62492@catkin.nothing-going-on.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Mailer: Mutt 1.0.1i Organization: FreeBSD Project Sender: owner-freebsd-hackers@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG Hi, [ sent to -doc, where it's on topic. Sent to -stable, where there's been much discussion of the docs recently. If anyone's got any energy left from that they could usefully expend it on this. Sent to -hackers, where the last chunk about XML is on topic, and will probably get me lynched. . . Follow-ups *not* set, as depending on which bits you reply to might make it more appropriate for one list or another. ] If anyone's looking for a relatively simple, but quite involving task. . . Update section 2.3 of the Handbook, "Supported Hardware". In particular, for each piece of hardware I'd like to know * The name of the hardware (which we already have, pretty much) * The category ("Disk Controller", "NIC", "USB", "ISDN", "Serial", "Mice", "Scanners", Other. . .) * The name of the driver/kernel config entry it's associated with * A URL for a page on the manufacturer's website that describes the product (if it exists). * Other URLs of interest (for example, if someone else has a page up that explains how to use this device with FreeBSD). * Assorted notes about the product What would be particularly useful is if we can get this information in a queryable form (XML, rah rah rah). We could then * Convert it to DocBook for inclusion in the Handbook * Build something much like the BSDI's website "Supported Hardware" section, where you can search for your hardware, and it gives you back lots of info about the device. [ OK, I'm pushing the boat out big time on this one, and it'll probably get shot down, but what the hell ] * Use this as *documentation in the source tree* to build chunks of the LINT config file. Imagine, for example, src/sys/pci/DRIVERS.xml, which looked something like (and I'm doodling on the back of an envelope at the moment) pci NIC fxp EtherExpress Pro/10, Pro/100B, Pro/100+ Fast Ethernet adapters, based on the Intel i82557 or i82559 chipsets. [ ... ] LINT would then become some boiler plate text for things we don't want to describe this way, plus the output of a process which takes the above and turns it into a config(8) style file. When you add a new driver, update the .xml file(s) as necessary. Next time LINT is built it contains the appropriate text, next time the Handbook is built it lists the device as supported. . . Thoughts? N -- Internet connection, $19.95 a month. Computer, $799.95. Modem, $149.95. Telephone line, $24.95 a month. Software, free. USENET transmission, hundreds if not thousands of dollars. Thinking before posting, priceless. Somethings in life you can't buy. For everything else, there's MasterCard. -- Graham Reed, in the Scary Devil Monastery To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-hackers" in the body of the message