[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL v2 06/12] doc: Document user creatable object types i
From: |
Andreas Färber |
Subject: |
[Qemu-devel] [PULL v2 06/12] doc: Document user creatable object types in help text |
Date: |
Wed, 27 May 2015 20:20:17 +0200 |
From: "Daniel P. Berrange" <address@hidden>
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>
Reviewed-by: Paolo Bonzini <address@hidden>
Signed-off-by: Andreas Färber <address@hidden>
---
qemu-options.hx | 70 ++++++++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 54 insertions(+), 16 deletions(-)
diff --git a/qemu-options.hx b/qemu-options.hx
index ec356f6..00ae287 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 a 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 a 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
--
2.1.4
- [Qemu-devel] [PULL v2 00/12] QOM devices patch queue 2015-05-27, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 01/12] qom: strdup() target property name on object_property_add_alias(), Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 04/12] scripts: Add support for path as argument of qom-tree, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 05/12] backends: Fix typename of 'policy' enum property in hostmem obj, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 02/12] qdev: Free property names after registering gpio aliases, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 08/12] qom: Add helper method for getting user objects root, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 12/12] qom: Add object_property_add_const_link(), Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 06/12] doc: Document user creatable object types in help text,
Andreas Färber <=
- [Qemu-devel] [PULL v2 07/12] vl: Create (most) objects before creating chardev backends, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 11/12] qom: Add an object_property_add_enum() helper function, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 10/12] qom: Make enum string tables const-correct, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 09/12] qom: Add object_new_with_props() / object_new_withpropv() helpers, Andreas Färber, 2015/05/27
- [Qemu-devel] [PULL v2 03/12] tests: Use qtest_add_data_func() consistently, Andreas Färber, 2015/05/27
- Re: [Qemu-devel] [PULL v2 00/12] QOM devices patch queue 2015-05-27, Peter Maydell, 2015/05/28