[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 21/22] docs/deprecated: deprecate passing plugin args through `arg
From: |
Alex Bennée |
Subject: |
[PULL 21/22] docs/deprecated: deprecate passing plugin args through `arg=` |
Date: |
Fri, 3 Sep 2021 10:03:38 +0100 |
From: Mahmoud Mandour <ma.mandourr@gmail.com>
Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
Message-Id: <20210802134414.52037-1-ma.mandourr@gmail.com>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
[AJB: fixed up move of deprecated.rst]
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst
index 1e1a5e96ad..6e88a84bba 100644
--- a/docs/about/deprecated.rst
+++ b/docs/about/deprecated.rst
@@ -139,6 +139,18 @@ The ``-no-quit`` is a synonym for ``-display
...,window-close=off`` which
should be used instead.
+Plugin argument passing through ``arg=<string>`` (since 6.1)
+''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+
+Passing TCG plugins arguments through ``arg=`` is redundant is makes the
+command-line less readable, especially when the argument itself consist of a
+name and a value, e.g. ``-plugin plugin_name,arg="arg_name=arg_value"``.
+Therefore, the usage of ``arg`` is redundant. Single-word arguments are treated
+as short-form boolean values, and passed to plugins as ``arg_name=on``.
+However, short-form booleans are deprecated and full explicit ``arg_name=on``
+form is preferred.
+
+
QEMU Machine Protocol (QMP) commands
------------------------------------
--
2.30.2
- [PULL 12/22] plugins/hotblocks: Added correct boolean argument parsing, (continued)
- [PULL 12/22] plugins/hotblocks: Added correct boolean argument parsing, Alex Bennée, 2021/09/03
- [PULL 19/22] tests/plugins/mem: introduce "track" arg and make args not positional, Alex Bennée, 2021/09/03
- [PULL 17/22] tests/plugins/bb: adapt to the new arg passing scheme, Alex Bennée, 2021/09/03
- [PULL 20/22] tests/plugins/syscalls: adhere to new arg-passing scheme, Alex Bennée, 2021/09/03
- [PULL 22/22] docs/devel: be consistent about example plugin names, Alex Bennée, 2021/09/03
- [PULL 10/22] plugins/api: added a boolean parsing plugin api, Alex Bennée, 2021/09/03
- [PULL 14/22] plugins/hwprofile: adapt to the new plugin arguments scheme, Alex Bennée, 2021/09/03
- [PULL 13/22] plugins/lockstep: make socket path not positional & parse bool arg, Alex Bennée, 2021/09/03
- [PULL 18/22] tests/plugins/insn: made arg inline not positional and parse it as bool, Alex Bennée, 2021/09/03
- [PULL 16/22] docs/tcg-plugins: new passing parameters scheme for cache docs, Alex Bennée, 2021/09/03
- [PULL 21/22] docs/deprecated: deprecate passing plugin args through `arg=`,
Alex Bennée <=
- Re: [PULL 00/22] testing and plugin updates, Peter Maydell, 2021/09/04