Skip to contentSkip to conversation

Add missing parameters to mon option documentation

PATCH In review Vicente Jimenez Aguilar 3 participants 3 messages Nov 9, 2017

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add missing parameters to mon option documentation

Documentation missed 'mon' option's 'pretty' and 'default' parameters

---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
qemu-options.hx +2 -2
index 3728e9b4dd..72cf48a8e5 100644
@@ -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
Signature · 1 line
2.14.1
#1 lore raw
Quoted 12 lines · Vicente Jimenez Aguilar

Documentation missed 'mon' option's 'pretty' and 'default' parameters

---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
qemu-options.hx +0 -0
index 3728e9b4dd..72cf48a8e5 100644

qemu-options.hx Like -qmp but uses pretty JSON formatting. · line 3482

Quoted 8 lines
qemu-options.hx +2 -2
@@ -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

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
#2 lore raw
In reply to Vicente Jimenez Aguilar

Hi

Quoted 12 lines · Vicente Jimenez Aguilar

Documentation missed 'mon' option's 'pretty' and 'default' parameters

---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
qemu-options.hx +0 -0
index 3728e9b4dd..72cf48a8e5 100644

qemu-options.hx Like -qmp but uses pretty JSON formatting. · line 3482

Quoted 8 lines
qemu-options.hx +2 -2
@@ -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

Quoted 7 lines
qemu-options.hx +0 -1
 @findex -mon
 Setup monitor on chardev @var{name}.
 ETEXI
--

2.14.1

Signature · 1 line
Marc-André Lureau