Date: Mon, 26 Jun 2000 11:50:09 +0100 From: Nik Clayton <nik@freebsd.org> To: Jun Kuriyama <kuriyama@FreeBSD.org> Cc: doc@FreeBSD.org, current@FreeBSD.org Subject: Re: XML driver config file to replace LINT Message-ID: <20000626115008.B462@catkin.nothing-going-on.org> In-Reply-To: <7mvgyw4u04.wl@waterblue.imgsrc.co.jp>; from kuriyama@FreeBSD.org on Mon, Jun 26, 2000 at 07:27:39PM %2B0900 References: <20000625195803.G470@kilt.nothing-going-on.org> <7mvgyw4u04.wl@waterblue.imgsrc.co.jp>
next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Jun 26, 2000 at 07:27:39PM +0900, Jun Kuriyama wrote: > So first of all, we (documentation project) should develop prototype > tool to achive that conversion. > > And we should keep that master text simple to ease modification by > hackers. If we force to write complex markups, hackers will *forget* > to update that master text. :-) The aim is that we have one file that describes the drivers -- this file will be used by us to keep the documentation up to date, but it will also be used by the system -- if the driver writer doesn't update this file then the system won't know about their driver, and won't build it. They'll *have* to keep it up to date. > > LINT would then become a skeletal file for things which don't fit this > > sort of pattern, and the full LINT would be generated by a script which > > parsed the above and the skeletal file to generate the full LINT. > > I think developpers may dislike to install doc toolchain to build > LINT file. $CVSROOT/src tree should not depend on doc toolchain. Agreed. But Perl (already in the base system) plus a Perl XML module should be OK? > Another idea is to write some script to convert LINT to LINT.xml for > documentation. And website and documents depend on it. Yes, this is > not ideal world from the point of SGML/XML view, but we should not > bother hackers' development in the source tree. I disagree. We're not Linux, where people can throw in code without thought to the wider consequences -- one of the commitments you should make (that's a generic "you" there, not you specifically) as a FreeBSD committer is to maintain the documentation that's affected by your changes. A look at HARDWARE.TXT shows that (with a few notable exceptions) the FreeBSD Developer Community at large is *not* keeping it up to date. 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-current" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20000626115008.B462>