| Message ID | 20171109121903.24510-1-googuy@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | Add missing parameters to mon option documentation | expand |
On Thu, Nov 09, 2017 at 01:19:03PM +0100, Vicente Jimenez Aguilar wrote: > Documentation missed 'mon' option's 'pretty' and 'default' parameters > > Signed-off-by: Vicente Jimenez Aguilar <googuy@gmail.com> > --- > qemu-options.hx | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/qemu-options.hx b/qemu-options.hx > index 3728e9b4dd..72cf48a8e5 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -3477,9 +3477,9 @@ Like -qmp but uses pretty JSON formatting. > ETEXI > > DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ > - "-mon [chardev=]name[,mode=readline|control]\n", QEMU_ARCH_ALL) > + "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]][,default[=on|off]]\n", QEMU_ARCH_ALL) > STEXI > -@item -mon [chardev=]name[,mode=readline|control] > +@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]][,default[=on|off]] The 'default' option is deprecated and unused, so intentionally not documented https://qemu.weilnetz.de/doc/qemu-doc.html#g_t_002dmon-default_003don-_0028since-2_002e4_002e0_0029 Regards, Daniel
Hi On Thu, Nov 9, 2017 at 1:19 PM, Vicente Jimenez Aguilar <googuy@gmail.com> wrote: > Documentation missed 'mon' option's 'pretty' and 'default' parameters > > Signed-off-by: Vicente Jimenez Aguilar <googuy@gmail.com> > --- > qemu-options.hx | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/qemu-options.hx b/qemu-options.hx > index 3728e9b4dd..72cf48a8e5 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -3477,9 +3477,9 @@ Like -qmp but uses pretty JSON formatting. > ETEXI > > DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ > - "-mon [chardev=]name[,mode=readline|control]\n", QEMU_ARCH_ALL) > + "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]][,default[=on|off]]\n", QEMU_ARCH_ALL) > STEXI > -@item -mon [chardev=]name[,mode=readline|control] > +@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]][,default[=on|off]] "default" is deprecated since commit 06ac27f (2.4.0). It does nothing anymore, so should probably not be documented. "pretty" was added in commit 39eaab9ac2a82f. You write some documentation for it based on the commit message perhaps? thanks > @findex -mon > Setup monitor on chardev @var{name}. > ETEXI > -- > 2.14.1 > >
diff --git a/qemu-options.hx b/qemu-options.hx index 3728e9b4dd..72cf48a8e5 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -3477,9 +3477,9 @@ Like -qmp but uses pretty JSON formatting. ETEXI DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ - "-mon [chardev=]name[,mode=readline|control]\n", QEMU_ARCH_ALL) + "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]][,default[=on|off]]\n", QEMU_ARCH_ALL) STEXI -@item -mon [chardev=]name[,mode=readline|control] +@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]][,default[=on|off]] @findex -mon Setup monitor on chardev @var{name}. ETEXI
Documentation missed 'mon' option's 'pretty' and 'default' parameters Signed-off-by: Vicente Jimenez Aguilar <googuy@gmail.com> --- qemu-options.hx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)