From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:55156) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YqjJ2-00044X-Gf for qemu-devel@nongnu.org; Fri, 08 May 2015 10:31:18 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YqjIz-00087h-AG for qemu-devel@nongnu.org; Fri, 08 May 2015 10:31:12 -0400 Received: from cantor2.suse.de ([195.135.220.15]:34717 helo=mx2.suse.de) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YqjIz-00087U-0v for qemu-devel@nongnu.org; Fri, 08 May 2015 10:31:09 -0400 Message-ID: <554CC8AC.6090809@suse.de> Date: Fri, 08 May 2015 16:31:08 +0200 From: =?ISO-8859-15?Q?Andreas_F=E4rber?= MIME-Version: 1.0 References: <1430476206-26034-1-git-send-email-berrange@redhat.com> <1430476206-26034-3-git-send-email-berrange@redhat.com> In-Reply-To: <1430476206-26034-3-git-send-email-berrange@redhat.com> Content-Type: text/plain; charset=iso-8859-15 Content-Transfer-Encoding: quoted-printable Subject: Re: [Qemu-devel] [PATCH v3 2/7] qom: document user creatable object types in help text List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: "Daniel P. Berrange" , qemu-devel@nongnu.org Cc: Paolo Bonzini 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. >=20 > Signed-off-by: Daniel P. Berrange > --- > qemu-options.hx | 70 ++++++++++++++++++++++++++++++++++++++++++++-----= -------- > 1 file changed, 54 insertions(+), 16 deletions(-) >=20 > 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_irqc= hip, "", QEMU_ARCH_I386) > HXCOMM Deprecated (ignored) > DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) > =20 > -DEF("object", HAS_ARG, QEMU_OPTION_object, > - "-object TYPENAME[,PROP1=3DVALUE1,...]\n" > - " create an new object of type TYPENAME setting pro= perties\n" > - " in the order they are specified. Note that the '= id'\n" > - " property must be set. These objects are placed i= n the\n" > - " '/objects' path.\n", > - QEMU_ARCH_ALL) > -STEXI > -@item -object @var{typename}[,@var{prop1}=3D@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[=3Don|off]\n" > " change the format of messages\n" > @@ -3462,6 +3446,60 @@ Dump json-encoded vmstate information for curren= t machine type to file > in @var{file} > ETEXI > =20 > +DEFHEADING(Generic object creation) > + > +DEF("object", HAS_ARG, QEMU_OPTION_object, > + "-object TYPENAME[,PROP1=3DVALUE1,...]\n" > + " create an new object of type TYPENAME setting pro= perties\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=E4rber 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 i= n the\n" > + " '/objects' path.\n", > + QEMU_ARCH_ALL) > +STEXI > +@item -object @var{typename}[,@var{prop1}=3D@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. > + > +@table @option > + > +@item -object memory-backend-file,id=3D@var{id},size=3D@var{size},mem-= path=3D@var{dir},share=3D@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=3D@var{id},filename=3D@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=3D@var{id},chardev=3D@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 connecti= on > +to the RNG daemon. > + > +@end table > + > +ETEXI > + > + > HXCOMM This is the last statement. Insert new options before this line= ! > STEXI > @end table >=20 --=20 SUSE Linux GmbH, Maxfeldstr. 5, 90409 N=FCrnberg, Germany GF: Felix Imend=F6rffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu, Graham Norton; HRB 21284 (AG N=FCrnberg)