Commit b9174d4f authored by Daniel P. Berrangé's avatar Daniel P. Berrangé Committed by Andreas Färber
Browse files

doc: Document user creatable object types in help text 



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: default avatarDaniel P. Berrange <berrange@redhat.com>
Reviewed-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Signed-off-by: default avatarAndreas Färber <afaerber@suse.de>
parent b1028b4e

qemu-options.hx

+54 −16
Original line number Diff line number Diff line
@@ -3476,22 +3476,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

@item -object @var{typename}[,@var{prop1}=@var{value1},...]

@findex -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"
@@ -3517,6 +3501,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

@item -object @var{typename}[,@var{prop1}=@var{value1},...]

@findex -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.



@table @option



@item -object memory-backend-file,id=@var{id},size=@var{size},mem-path=@var{dir},share=@var{on|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.



@item -object rng-random,id=@var{id},filename=@var{/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}.



@item -object rng-egd,id=@var{id},chardev=@var{chardevid}



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.



@end table



ETEXI





HXCOMM This is the last statement. Insert new options before this line!

STEXI

@end table