diff options
| author | Mahmoud Mandour <ma.mandourr@gmail.com> | 2021-08-02 15:44:14 +0200 |
|---|---|---|
| committer | Alex Bennée <alex.bennee@linaro.org> | 2021-09-02 11:29:34 +0100 |
| commit | 67f145745fc2187f0c5b5df72794e9efcfd0533d (patch) | |
| tree | 317c42f760327c3854429e0c567de39fea461a1d /docs | |
| parent | a694d739bbf87e9de4ab1b76e03722e7eca32a4d (diff) | |
docs/deprecated: deprecate passing plugin args through `arg=`
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>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about/deprecated.rst | 12 |
1 files changed, 12 insertions, 0 deletions
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 ------------------------------------ |