WARNING - OLD ARCHIVES

This is an archived copy of the Xen.org mailing list, which we have preserved to ensure that existing links to archives are not broken. The live archive, which contains the latest emails, can be found at http://lists.xen.org/
   
 
 
Xen 
 
Home Products Support Community News
 
   
 

xen-devel

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

To: Sean Dague <sean@xxxxxxxxx>
Subject: [Xen-devel] Re: [Fwd: [Xen-changelog] Fix Jerone Young's xenstat / xenstore patch:]
From: Mark Williamson <mark.williamson@xxxxxxxxxxxx>
Date: Sun, 30 Oct 2005 01:55:18 +0000
Cc: Daniel Stekloff <dsteklof@xxxxxxxxxx>, xen-devel@xxxxxxxxxxxxxxxxxxx, Ewan Mellor <ewan@xxxxxxxxxxxxx>, Jerone Young <jyoung5@xxxxxxxxxx>, Josh Triplett <josh@xxxxxxxxxxxxxxx>
Delivery-date: Sun, 30 Oct 2005 01:52:38 +0000
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
In-reply-to: <20051028204612.GB20903@xxxxxxxxxxxxxxxxxxx>
List-help: <mailto:xen-devel-request@lists.xensource.com?subject=help>
List-id: Xen developer discussion <xen-devel.lists.xensource.com>
List-post: <mailto:xen-devel@lists.xensource.com>
List-subscribe: <http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=subscribe>
List-unsubscribe: <http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-devel>, <mailto:xen-devel-request@lists.xensource.com?subject=unsubscribe>
References: <1130429095.9330.6.camel@xxxxxxxxxxxxxxxxxxxxxxxxxxxx> <200510280041.29873.mark.williamson@xxxxxxxxxxxx> <20051028204612.GB20903@xxxxxxxxxxxxxxxxxxx>
Sender: xen-devel-bounces@xxxxxxxxxxxxxxxxxxx
User-agent: KMail/1.8.3
> > 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.

Actually, I think Matt wants to move to autogenerating the manpages for hg.  
It doesn't have to cause formatting issues either - it's not that difficult 
to just parse blocks of help text if they're sensibly structured.  Or you 
could go the "direct" route of writing the "generator" script in Python and 
accessing the strings directly (*evil grin*).

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

Equally well, many of the doc bugs *come* from patches that touch code, 
causing the docs to become wrong ;-)

Anyhow if the docs get well maintained by someone it doesn't really matter how 
it happens.

Cheers,
Mark

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