[Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table v2

[Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table v2

[Blue Swirl]

[-- Attachment #1: Type: text/plain, Size: 570 bytes --]

Hi,

I converted all options to the new system. Because of problems with #
and ' characters, I had to move from CPP to a Perl scripts. I'm sure
any Perl expert worth their salt could compress the scripts much
further. A comment token (HXCOMM?, deleted while parsing) would be
nice, then there could be comments that describe the syntax and usage
on top of options.hx.

Comments? Objections?

A related idea: maybe the machine definition files should also enclose
a mandatory TEXI description, leading to a generated list of machines
and their devices for qemu-doc.texi.

[-- Attachment #2: option_system.diff.bz2 --]
[-- Type: application/x-bzip2, Size: 21919 bytes --]

Re: [Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table v2

[Anthony Liguori]

Blue Swirl wrote:
> Hi,
>
> I converted all options to the new system. Because of problems with #
> and ' characters, I had to move from CPP to a Perl scripts. I'm sure
> any Perl expert worth their salt could compress the scripts much
> further. A comment token (HXCOMM?, deleted while parsing) would be
> nice, then there could be comments that describe the syntax and usage
> on top of options.hx.
>
> Comments? Objections?
>   

Adding a perl dependency is really painful for win32.  We could check in 
the resulting options.h but if we can find a way to do it with CPP, that 
would be much better.

Long term, I think there are better ways to generate the man page.  For 
instance, if we had a verbose help setting, we could make use of 
help2man.  But I think this is a step in the right direction (provided 
we can drop the perl dependency).

Regards,

Anthony Liguori

> A related idea: maybe the machine definition files should also enclose
> a mandatory TEXI description, leading to a generated list of machines
> and their devices for qemu-doc.texi.

Re: [Qemu-devel] [PATCH] [RFC] Syncing documentation vs. -help vs. qemu_options table v2

[Avi Kivity]

Blue Swirl wrote:
> Hi,
>
> I converted all options to the new system. Because of problems with #
> and ' characters, I had to move from CPP to a Perl scripts. I'm sure
> any Perl expert worth their salt could compress the scripts much
> further. A comment token (HXCOMM?, deleted while parsing) would be
> nice, then there could be comments that describe the syntax and usage
> on top of options.hx.
>   

The script needs expanding, not compressing.

-- 
error compiling committee.c: too many arguments to function