Subject: Re: SoC: Efficient memory file-system
To: der Mouse <mouse@Rodents.Montreal.QC.CA>
From: Rui Paulo <rpaulo@NetBSD.org>
List: tech-kern
Date: 06/26/2005 21:04:36
On 2005.06.26 12:49:58 +0000, der Mouse wrote:
> >> [...]; I'll also be writing documentation on how to write a
> >> file-system driver from scratch, similar to the Device Driver
> >> Writing Guide we already have.
> > Great, please do this in XML!
> 
> If you *must* use XML, please make sure it's readable with plain text
> tools too!  There's little worse than documentation with useful
> information in it but impossible to read (okay, very difficult and slow
> to read) because it's more tags than text.  (Modern NTP comes to mind
> as an example.)  About the only thing worse I can think of would be
> some undocumented proprietary format like MSWord.

If you use XML you can convert it to a number of formats (an example
is the pkgsrc guide which is available in HTML and plan text format). 
Writing stuff in XML is as readable as writing in mdoc format, IMHO.

		-- Rui Paulo