Re: [PATCH v2 5/5] meson_options.txt: Document that "configure" reads this file, too

[Eric Blake <eblake@redhat.com>]

On Fri, Sep 03, 2021 at 10:13:58AM +0200, Thomas Huth wrote:
> Add a comment that meson_options.txt is also parsed by the configure
> script and that the options need a certain layout for this to succeed.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  meson_options.txt | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/meson_options.txt b/meson_options.txt
> index 2c89e79e8b..86b3c03c7d 100644
> --- a/meson_options.txt
> +++ b/meson_options.txt
> @@ -1,3 +1,9 @@

Huh - we don't have any copyright header in this file.  Oh well, not your fault.

> +# Note: This file is also parsed by "configure" to automatically handle the
> +# 'feature' options for its --enable-* and --disable-* parameters. To be able
> +# to use this automation, make sure that the corresponding options() have their
> +# "type: 'feature'" in the very first line, and their "description:" in their
> +# second line.
> +
>  option('qemu_suffix', type : 'string', value: 'qemu',
>         description: 'Suffix for QEMU data/modules/config directories (can be empty)')

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org