Xen 
 
Home About Xen.org Xen Xen Summit Wiki Mailing List Bug Tracker Xen Downloads
 
   
 

xen-devel

Re: [Xen-devel] [PATCH] Add Initial Man Pages for xm and xmdomain.cfg

To: Daniel Stekloff <dsteklof@xxxxxxxxxx>
Subject: Re: [Xen-devel] [PATCH] Add Initial Man Pages for xm and xmdomain.cfg
From: "M.A. Williamson" <maw48@xxxxxxxxx>
Date: 29 Oct 2005 17:29:43 +0100
Cc: Xen Mailing List <xen-devel@xxxxxxxxxxxxxxxxxxx>, ewan@xxxxxxxxxxxxx, Sean Dague <japh@xxxxxxxxxx>
Delivery-date: Sat, 29 Oct 2005 16:27:06 +0000
Envelope-to: www-data@xxxxxxxxxxxxxxxxxxx
In-reply-to: <1130549640.23947.18.camel@xxxxxxxxxxxxxxxxxxxxxxxxxxxx>
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: <1130549640.23947.18.camel@xxxxxxxxxxxxxxxxxxxxxxxxxxxx>
Reply-to: mark.williamson@xxxxxxxxxxxx
Sender: xen-devel-bounces@xxxxxxxxxxxxxxxxxxx
It's good to see man pages appearing for other tools!

I'd still suggest considering a script for generating the command help though: e.g. have a "skeleton" man page but use a script (maybe just a shell script) to allow quick regeneration of the command descriptions (by just running xm help over everything and formatting the results).

We can still check a pre-generated manpage into hg and ship it readymade; it's just that relying on developers to update the documentation tends not to work ;-)

Cheers,
Mark

On Oct 29 2005, Daniel Stekloff wrote:


Here's a first stab at man pages for xm and xmdomain.cfg. Sean submitted
this patch over the summer. I've just added a xm man page to it. Both
man pages are rough and need more work.
Sean's original post:

http://lists.xensource.com/archives/html/xen-devel/2005-08/txtOQiiLcE26t.txt

Thanks,

Dan


Signed-off-by: Sean Dague <sean@xxxxxxxxx>
Signed-off-by: Daniel Stekloff <dsteklof@xxxxxxxxxx>




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