[Xen-devel] Re: Re: [Fwd: [Xen-changelog] Fix Jerone Young's xenstat / xenstore patch:]

[Sean Dague <sean@xxxxxxxxx>]

On Fri, Oct 28, 2005 at 12:41:29AM +0100, Mark Williamson wrote:
> > As far as I know, those references to man pages are big fat lies, and it
> > would be very useful if you could write some.  I think that the command
> > list in xm/main.py is pretty much up to date, so that's a good starting
> > point, but it's worth checking them, obviously.
> 
> *even* nicer would be to have a Python script that groks through main.py and 
> *generates* an up-to-date man page based on some template text, adding the 
> help text for the current commands.
> 
> Non-live documentation tends to get broken very quickly, so anything that can 
> be semi-automatically rebuilt is a definite plus.

Except formatting kind of blows in those cases.  Even hg uses off line text
to generate it's man pages.

The other nice thing is you can more easily get people working on doc bugs
without submitting patches that touch code.

        -Sean

-- 
__________________________________________________________________

Sean Dague                                       Mid-Hudson Valley
sean at dague dot net                            Linux Users Group
http://dague.net                                 http://mhvlug.org

There is no silver bullet.  Plus, werewolves make better neighbors
than zombies, and they tend to keep the vampire population down.
__________________________________________________________________

Attachment: pgpngSiIY7an_.pgp
Description: PGP signature

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel