diff mbox series

[v4,13/13] docs/deprecated: deprecate passing plugin args through `arg=`

Message ID 20210730135817.17816-14-ma.mandourr@gmail.com
State New
Headers show
Series new plugin argument passing scheme | expand

Commit Message

Mahmoud Abumandour July 30, 2021, 1:58 p.m. UTC
Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
---
 docs/system/deprecated.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Alex Bennée Aug. 2, 2021, 10:53 a.m. UTC | #1
Mahmoud Mandour <ma.mandourr@gmail.com> writes:

> Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
> ---
>  docs/system/deprecated.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
> index e2e0090878..7ae6f1f727 100644
> --- a/docs/system/deprecated.rst
> +++ b/docs/system/deprecated.rst
> @@ -126,6 +126,13 @@ other options have been processed.  This will either have no effect (if
>  if they were not given.  The property is therefore useless and should not be
>  specified.
>  
> +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.

We should probably also mention that single word arguments are treated
as booleans and prefer the flag=on form. Anyway:

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
diff mbox series

Patch

diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index e2e0090878..7ae6f1f727 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -126,6 +126,13 @@  other options have been processed.  This will either have no effect (if
 if they were not given.  The property is therefore useless and should not be
 specified.
 
+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.
 
 QEMU Machine Protocol (QMP) commands
 ------------------------------------