[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH v3 2/7] qom: document user creatable object type
From: |
Andreas Färber |
Subject: |
Re: [Qemu-devel] [PATCH v3 2/7] qom: document user creatable object types in help text |
Date: |
Fri, 08 May 2015 16:31:08 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.6.0 |
Am 01.05.2015 um 12:30 schrieb Daniel P. Berrange:
> The QEMU help for -object is essentially useless, just giving users
> the generic syntax. Move it down into its own section and introduce
> a nested table where each user creatable object can be documented.
> The existing memory-backend-file, rng-random and rng-egd object
> types are documented.
>
> Signed-off-by: Daniel P. Berrange <address@hidden>
> ---
> qemu-options.hx | 70
> ++++++++++++++++++++++++++++++++++++++++++++-------------
> 1 file changed, 54 insertions(+), 16 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 319d971..5ef0ae4 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -3421,22 +3421,6 @@ DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip,
> "", QEMU_ARCH_I386)
> HXCOMM Deprecated (ignored)
> DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
>
> -DEF("object", HAS_ARG, QEMU_OPTION_object,
> - "-object TYPENAME[,PROP1=VALUE1,...]\n"
> - " create an new object of type TYPENAME setting
> properties\n"
> - " in the order they are specified. Note that the 'id'\n"
> - " property must be set. These objects are placed in
> the\n"
> - " '/objects' path.\n",
> - QEMU_ARCH_ALL)
> -STEXI
> address@hidden -object @var{typename}[,@address@hidden,...]
> address@hidden -object
> -Create an new object of type @var{typename} setting properties
> -in the order they are specified. Note that the 'id'
> -property must be set. These objects are placed in the
> -'/objects' path.
> -ETEXI
> -
> DEF("msg", HAS_ARG, QEMU_OPTION_msg,
> "-msg timestamp[=on|off]\n"
> " change the format of messages\n"
> @@ -3462,6 +3446,60 @@ Dump json-encoded vmstate information for current
> machine type to file
> in @var{file}
> ETEXI
>
> +DEFHEADING(Generic object creation)
> +
> +DEF("object", HAS_ARG, QEMU_OPTION_object,
> + "-object TYPENAME[,PROP1=VALUE1,...]\n"
> + " create an new object of type TYPENAME setting
> properties\n"
I see you're only moving this, but should we fix the typo while doing so
or as follow-up?
Apart from that,
Reviewed-by: Andreas Färber <address@hidden>
but again not really "qom:" but rather Paolo's -object domain.
Regards,
Andreas
> + " in the order they are specified. Note that the 'id'\n"
> + " property must be set. These objects are placed in
> the\n"
> + " '/objects' path.\n",
> + QEMU_ARCH_ALL)
> +STEXI
> address@hidden -object @var{typename}[,@address@hidden,...]
> address@hidden -object
> +Create an new object of type @var{typename} setting properties
> +in the order they are specified. Note that the 'id'
> +property must be set. These objects are placed in the
> +'/objects' path.
> +
> address@hidden @option
> +
> address@hidden -object
> memory-backend-file,address@hidden,address@hidden,address@hidden,address@hidden|off}
> +
> +Creates a memory file backend object, which can be used to back
> +the guest RAM with huge pages. The @option{id} parameter is a
> +unique ID that will be used to reference this memory region
> +when configuring the @option{-numa} argument. The @option{size}
> +option provides the size of the memory region, and accepts
> +common suffixes, eg @option{500M}. The @option{mem-path} provides
> +the path to either a shared memory or huge page filesystem mount.
> +The @option{share} boolean option determines whether the memory
> +region is marked as private to QEMU, or shared. The latter allows
> +a co-operating external process to access the QEMU memory region.
> +
> address@hidden -object rng-random,address@hidden,address@hidden/dev/random}
> +
> +Creates a random number generator backend which obtains entropy from
> +a device on the host. The @option{id} parameter is a unique ID that
> +will be used to reference this entropy backend from the @option{virtio-rng}
> +device. The @option{filename} parameter specifies which file to obtain
> +entropy from and if omitted defaults to @option{/dev/random}.
> +
> address@hidden -object rng-egd,address@hidden,address@hidden
> +
> +Creates a random number generator backend which obtains entropy from
> +an external daemon running on the host. The @option{id} parameter is
> +a unique ID that will be used to reference this entropy backend from
> +the @option{virtio-rng} device. The @option{chardev} parameter is
> +the unique ID of a character device backend that provides the connection
> +to the RNG daemon.
> +
> address@hidden table
> +
> +ETEXI
> +
> +
> HXCOMM This is the last statement. Insert new options before this line!
> STEXI
> @end table
>
--
SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
Graham Norton; HRB 21284 (AG Nürnberg)