qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: peter.maydell@linaro.org
Cc: "reviewer:Incompatible changes" <libvir-list@redhat.com>,
	"Mahmoud Mandour" <ma.mandourr@gmail.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	qemu-devel@nongnu.org
Subject: [PULL 21/22] docs/deprecated: deprecate passing plugin args through `arg=`
Date: Fri,  3 Sep 2021 10:03:38 +0100	[thread overview]
Message-ID: <20210903090339.1074887-22-alex.bennee@linaro.org> (raw)
In-Reply-To: <20210903090339.1074887-1-alex.bennee@linaro.org>

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



  parent reply	other threads:[~2021-09-03  9:20 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-03  9:03 [PULL 00/22] testing and plugin updates Alex Bennée
2021-09-03  9:03 ` [PULL 01/22] plugins/execlog: removed unintended "s" at the end of log lines Alex Bennée
2021-09-03  9:03 ` [PULL 02/22] gitlab-ci: Merge "build-disabled" with "build-without-default-features" Alex Bennée
2021-09-03  9:03 ` [PULL 03/22] gitlab-ci: Remove superfluous "dnf install" statement Alex Bennée
2021-09-03  9:03 ` [PULL 04/22] gitlab-ci: Fix ..._RUNNER_AVAILABLE variables and document them Alex Bennée
2021-09-03  9:03 ` [PULL 05/22] plugins: do not limit exported symbols if modules are active Alex Bennée
2021-09-03  9:03 ` [PULL 06/22] plugins/cache: supported multicore cache modelling Alex Bennée
2021-09-03  9:03 ` [PULL 07/22] plugins: sort exported symbol list Alex Bennée
2021-09-03  9:03 ` [PULL 08/22] docs/devel/tcg-plugins: added cores arg to cache plugin Alex Bennée
2021-09-03  9:03 ` [PULL 09/22] plugins: allow plugin arguments to be passed directly Alex Bennée
2021-09-03  9:03 ` [PULL 10/22] plugins/api: added a boolean parsing plugin api Alex Bennée
2021-09-03  9:03 ` [PULL 11/22] plugins/hotpages: introduce sortby arg and parsed bool args correctly Alex Bennée
2021-09-03  9:03 ` [PULL 12/22] plugins/hotblocks: Added correct boolean argument parsing Alex Bennée
2021-09-03  9:03 ` [PULL 13/22] plugins/lockstep: make socket path not positional & parse bool arg Alex Bennée
2021-09-03  9:03 ` [PULL 14/22] plugins/hwprofile: adapt to the new plugin arguments scheme Alex Bennée
2021-09-03  9:03 ` [PULL 15/22] plugins/howvec: adapting to the new argument passing scheme Alex Bennée
2021-09-03  9:03 ` [PULL 16/22] docs/tcg-plugins: new passing parameters scheme for cache docs Alex Bennée
2021-09-03  9:03 ` [PULL 17/22] tests/plugins/bb: adapt to the new arg passing scheme Alex Bennée
2021-09-03  9:03 ` [PULL 18/22] tests/plugins/insn: made arg inline not positional and parse it as bool Alex Bennée
2021-09-03  9:03 ` [PULL 19/22] tests/plugins/mem: introduce "track" arg and make args not positional Alex Bennée
2021-09-03  9:03 ` [PULL 20/22] tests/plugins/syscalls: adhere to new arg-passing scheme Alex Bennée
2021-09-03  9:03 ` Alex Bennée [this message]
2021-09-03  9:03 ` [PULL 22/22] docs/devel: be consistent about example plugin names Alex Bennée
2021-09-04 18:20 ` [PULL 00/22] testing and plugin updates Peter Maydell

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=20210903090339.1074887-22-alex.bennee@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=libvir-list@redhat.com \
    --cc=ma.mandourr@gmail.com \
    --cc=peter.maydell@linaro.org \
    --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).