[PATCH] doc: Add notes about -mon option mode=control argument.

[PATCH] doc: Add notes about -mon option mode=control argument.

[Ali Shirvani via]

The mode=control argument configures a QMP monitor.

Signed-off-by: Ali Shirvani <alishir@routerhosting.com>
---
 qemu-options.hx | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index e22fb94d99..292c6f6bdc 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -3787,8 +3787,11 @@ DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
     "-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]\n", QEMU_ARCH_ALL)
 SRST
 ``-mon [chardev=]name[,mode=readline|control][,pretty[=on|off]]``
-    Setup monitor on chardev name. ``pretty`` is only valid when
-    ``mode=control``, turning on JSON pretty printing to ease
+    Setup monitor on chardev name. ``mode=control`` configures 
+    a QMP monitor (a JSON RPC-style protocol) and it is not the
+    same as HMP, the human monitor that has a "(qemu)" prompt.
+    ``pretty`` is only valid when ``mode=control``, 
+    turning on JSON pretty printing to ease
     human reading and debugging.
 ERST
 
-- 
2.30.2

Re: [PATCH] doc: Add notes about -mon option mode=control argument.

[no-reply]

Patchew URL: https://patchew.org/QEMU/0799f0de89ad2482672b5d61d0de61e6eba782da.1621407918.git.alishir@routerhosting.com/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Type: series
Message-id: 0799f0de89ad2482672b5d61d0de61e6eba782da.1621407918.git.alishir@routerhosting.com
Subject: [PATCH] doc: Add notes about -mon option mode=control argument.

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Updating 3c8cf5a9c21ff8782164d1def7f44bd888713384
Switched to a new branch 'test'
7733e41 doc: Add notes about -mon option mode=control argument.

=== OUTPUT BEGIN ===
ERROR: Author email address is mangled by the mailing list
#2: 
Author: Ali Shirvani via <qemu-devel@nongnu.org>

ERROR: trailing whitespace
#25: FILE: qemu-options.hx:3790:
+    Setup monitor on chardev name. ``mode=control`` configures $

ERROR: trailing whitespace
#28: FILE: qemu-options.hx:3793:
+    ``pretty`` is only valid when ``mode=control``, $

total: 3 errors, 0 warnings, 13 lines checked

Commit 7733e412ab28 (doc: Add notes about -mon option mode=control argument.) has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/0799f0de89ad2482672b5d61d0de61e6eba782da.1621407918.git.alishir@routerhosting.com/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to patchew-devel@redhat.com

Re: [PATCH] doc: Add notes about -mon option mode=control argument.

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 330 bytes --]

On Wed, May 19, 2021 at 11:41:45AM +0430, Ali Shirvani via wrote:
> The mode=control argument configures a QMP monitor.
> 
> Signed-off-by: Ali Shirvani <alishir@routerhosting.com>
> ---
>  qemu-options.hx | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]