qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Mahmoud Mandour <ma.mandourr@gmail.com>
To: qemu-devel@nongnu.org
Cc: "reviewer:Incompatible changes" <libvir-list@redhat.com>,
	Mahmoud Mandour <ma.mandourr@gmail.com>,
	alex.bennee@linaro.org
Subject: [PATCH v5] docs/deprecated: deprecate passing plugin args through `arg=`
Date: Mon,  2 Aug 2021 15:44:14 +0200	[thread overview]
Message-ID: <20210802134414.52037-1-ma.mandourr@gmail.com> (raw)
In-Reply-To: <87h7g8glor.fsf@linaro.org>

Signed-off-by: Mahmoud Mandour <ma.mandourr@gmail.com>
---

v4 -> v5:
    1. Mentioned that short-form booleans are still usable but not preferable.

 docs/system/deprecated.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
index e2e0090878..43ae154c85 100644
--- a/docs/system/deprecated.rst
+++ b/docs/system/deprecated.rst
@@ -126,6 +126,16 @@ 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. 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.25.1



  reply	other threads:[~2021-08-02 13:45 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-30 13:58 [PATCH v4 00/13] new plugin argument passing scheme Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 01/13] plugins: allow plugin arguments to be passed directly Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 02/13] plugins/api: added a boolean parsing plugin api Mahmoud Mandour
2021-08-02  9:07   ` Alex Bennée
2021-07-30 13:58 ` [PATCH v4 03/13] plugins/hotpages: introduce sortby arg and parsed bool args correctly Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 04/13] plugins/hotblocks: Added correct boolean argument parsing Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 05/13] plugins/lockstep: make socket path not positional & parse bool arg Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 06/13] plugins/hwprofile: adapt to the new plugin arguments scheme Mahmoud Mandour
2021-08-02 10:52   ` Alex Bennée
2021-07-30 13:58 ` [PATCH v4 07/13] plugins/howvec: adapting to the new argument passing scheme Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 08/13] docs/tcg-plugins: new passing parameters scheme for cache docs Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 09/13] tests/plugins/bb: adapt to the new arg passing scheme Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 10/13] tests/plugins/insn: made arg inline not positional and parse it as bool Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 11/13] tests/plugins/mem: introduce "track" arg and make args not positional Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 12/13] tests/plugins/syscalls: adhere to new arg-passing scheme Mahmoud Mandour
2021-07-30 13:58 ` [PATCH v4 13/13] docs/deprecated: deprecate passing plugin args through `arg=` Mahmoud Mandour
2021-08-02 10:53   ` Alex Bennée
2021-08-02 13:44     ` Mahmoud Mandour [this message]
2021-08-04 15:40 ` [PATCH v4 00/13] new plugin argument passing scheme Alex Bennée

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210802134414.52037-1-ma.mandourr@gmail.com \
    --to=ma.mandourr@gmail.com \
    --cc=alex.bennee@linaro.org \
    --cc=libvir-list@redhat.com \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).