Mailing List Archive: Re: [PATCH 01 of 32 RFC] libxl: remove comment support from IDL

Re: [PATCH 01 of 32 RFC] libxl: remove comment support from IDL

Jan 16, 2012, 8:23 AM

Post #1 of 3 (84 views)

Ian Campbell writes ("[Xen-devel] [PATCH 01 of 32 RFC] libxl: remove comment support from IDL"):
> libxl: remove comment support from IDL

I'm not entirely convinced by this, or at least not yet.

Are we going to eventually have an automatic docs generator and find
that this "literate" style (if I may grossly stretch the term) is what
we wanted ?

I guess the current syntax is not really suitable for going for a
literate style in the idl.

Ian.

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

Re: [PATCH 01 of 32 RFC] libxl: remove comment support from IDL [ In reply to ]

Ian.Campbell at citrix

Jan 16, 2012, 8:29 AM

Post #2 of 3 (83 views)

Permalink

On Mon, 2012-01-16 at 16:23 +0000, Ian Jackson wrote:
> Ian Campbell writes ("[Xen-devel] [PATCH 01 of 32 RFC] libxl: remove comment support from IDL"):
> > libxl: remove comment support from IDL
>
> I'm not entirely convinced by this, or at least not yet.
>
> Are we going to eventually have an automatic docs generator and find
> that this "literate" style (if I may grossly stretch the term) is what
> we wanted ?

I honestly don't know.

I guess in some sense this new scheme is no different in this respect to
any other source file which we might want to extract docs from?

> I guess the current syntax is not really suitable for going for a
> literate style in the idl.

It is pretty limited/limiting.

Ian.

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

Re: [PATCH 01 of 32 RFC] libxl: remove comment support from IDL [ In reply to ]

Ian.Jackson at eu

Jan 16, 2012, 8:30 AM

Post #3 of 3 (81 views)

Permalink

Ian Campbell writes ("Re: [Xen-devel] [PATCH 01 of 32 RFC] libxl: remove comment support from IDL"):
> On Mon, 2012-01-16 at 16:23 +0000, Ian Jackson wrote:
> > Are we going to eventually have an automatic docs generator and find
> > that this "literate" style (if I may grossly stretch the term) is what
> > we wanted ?
>
> I honestly don't know.
>
> I guess in some sense this new scheme is no different in this respect to
> any other source file which we might want to extract docs from?
>
> > I guess the current syntax is not really suitable for going for a
> > literate style in the idl.
>
> It is pretty limited/limiting.

OK, I think this will do for now. Certainly the comments you're
removing aren't valuable, so

Acked-by: Ian Jackson <ian.jackson@eu.citrix.com>

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