diff mbox series

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

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

Commit Message

Mahmoud Abumandour July 17, 2021, 10:09 a.m. UTC
Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
---
 docs/system/deprecated.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Peter Krempa July 19, 2021, 12:13 p.m. UTC | #1
On Sat, Jul 17, 2021 at 12:09:20 +0200, Mahmoud Mandour wrote:
> Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
> ---
>  docs/system/deprecated.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
> index e2e0090878..aaf0ee5777 100644
> --- a/docs/system/deprecated.rst
> +++ b/docs/system/deprecated.rst
> @@ -126,6 +126,12 @@ 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 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. ``arg="arg_name=arg_value"``. Therefore, the usage of ``arg`` is redundant.

Based on this entry itself it's hard to figure out that this is for TCG
plugings. Preferably reword that entry so it's more clear.

Libvirt isn't setting these so it's okay to deprecate/remove from our
point of view.
diff mbox series

Patch

diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index e2e0090878..aaf0ee5777 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -126,6 +126,12 @@  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 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. ``arg="arg_name=arg_value"``. Therefore, the usage of ``arg`` is redundant.
 
 QEMU Machine Protocol (QMP) commands
 ------------------------------------