From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ian Campbell Subject: Re: Xen document day (Oct 12 or 26) Date: Wed, 28 Sep 2011 14:58:10 +0100 Message-ID: <1317218291.26672.59.camel@zakaz.uk.xensource.com> References: <20110922130618.GA13238@phenom.oracle.com> <20110922174002.GA1205@phenom.oracle.com> <20098.1097.824552.541924@mariner.uk.xensource.com> <1317195656.13424.73.camel@dagon.hellion.org.uk> <20099.8327.326129.357335@mariner.uk.xensource.com> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <20099.8327.326129.357335@mariner.uk.xensource.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xensource.com Errors-To: xen-devel-bounces@lists.xensource.com To: Ian Jackson Cc: Daniel Castro , "xen-devel@lists.xensource.com" , Konrad Rzeszutek Wilk List-Id: xen-devel@lists.xenproject.org On Wed, 2011-09-28 at 14:26 +0100, Ian Jackson wrote: > Ian Campbell writes ("Re: [Xen-devel] Xen document day (Oct 12 or 26)"): > > Since the guest APIs are stable there should be relatively little churn > > so perhaps a wiki page (or even series of pages) would be appropriate > > for this sort of thing? > > I want this to be in-tree. If it's in-tree, we can refuse patches > which do not update the documentation. I was referring to the example API usage which Daniel was intending to supply, not the API documentation (which I agree should be in-tree, if not in-line in the headers), in case that matters. In some sense mini-os was originally supposed to serve as the in-tree example on how to use the Xen APIs. If it's not serving that purpose I'm not sure what would. > > > I think this would be good too and in fact even more important than the > > interface documentation. Everyone needs to be able to build Xen to hack > > on it but only a subset need to know any particular API. > > > > Also although we recommend that users consume Xen via their distro where > > possible such a guide would also help any who would rather build from > > scratch (e.g. because we've asked them to "try the latest version" or to > > bisect a bug etc). > > This would be a good candidate for a wiki page, backed up by revisions > of the in-tree README. > > Ian.