Document pretty parameter for mon option
authorVicente Jimenez Aguilar <googuy@gmail.com>
Tue, 14 Nov 2017 08:11:27 +0000 (09:11 +0100)
committerMichael Tokarev <mjt@tls.msk.ru>
Mon, 18 Dec 2017 14:07:02 +0000 (17:07 +0300)
Documentation: document pretty parameter for mon option
that turns on JSON pretty printing

Signed-off-by: Vicente Jimenez Aguilar <googuy@gmail.com>
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
qemu-options.hx

index fe0c29271fc9196f14f6d91593afddacf7bbd808..32d93781722cb2fc2f84981f316abc984b2c2906 100644 (file)
@@ -3487,11 +3487,12 @@ 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]]\n", QEMU_ARCH_ALL)
 STEXI
-@item -mon [chardev=]name[,mode=readline|control]
+@item -mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]
 @findex -mon
-Setup monitor on chardev @var{name}.
+Setup monitor on chardev @var{name}. @code{pretty} turns on JSON pretty printing
+easing human reading and debugging.
 ETEXI
 
 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \