From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616717555661.0409676500534; Thu, 13 Feb 2020 09:58:37 -0800 (PST) Received: from localhost ([::1]:57122 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Il2-00021k-6l for importer@patchew.org; Thu, 13 Feb 2020 12:58:36 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33484) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjP-0008W9-N7 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:57 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjO-0002IX-1z for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:55 -0500 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:46094) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjN-0002GO-Q1 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:53 -0500 Received: by mail-wr1-x435.google.com with SMTP id z7so7788253wrl.13 for ; Thu, 13 Feb 2020 09:56:53 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:51 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=bNrhvkUv2TO4FrpIdTAVSOaQ1Nd3Ip9jUXQiwdMHf3E=; b=MVO+IU7TLrNzOQMOBVXUYyAYHNCX0Raac3P92MIQ0SK+N+6uFx2mYQsFYkTxRTbdXL IQ20OlkDIoZbE1GBCTcw3xddGo2D6nigt34rk0B0610Rs2nTkY8ZUHWu2+EA9es0mezb CSQOEBHyv9EzkTDWqTKwsFECHFLf3R+VbDQ/k7x0gQGqEaB8QI687jn0pbq8nNANQdgo TWJA7RUT0V4pxgNg0WjJF+ee7zon+nhlJku9O7dzXxnHzVnxDaELd//IR/uMgrLdy3t7 u6GuNignHSol4M3dUuFTgO7+knsAXkJLc+kL+4aoHSrA5zId701u05i/MGTM6LF/YxOe xyQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=bNrhvkUv2TO4FrpIdTAVSOaQ1Nd3Ip9jUXQiwdMHf3E=; b=pvhukesc9Ea0bNNheovexnCtVPW6xHVXq/QF1z6ocrYICDrX7oMr3SaW08tCoXzdTy hxFErw5BDfPWT8iOvNmU7KDzXzWKONTx9K7DxbTCk9LrrjKUH9tL6BzElBBKoKNAdDEo mYcbLgl7AXJtDyUQIjQANglTj762Lzml5A/0thhUJoSMc2CmlMIFho/XjPwnlFHS46Vg fAhiW5tfP2jR81A6AIJjpkiw6ZwGodfLmx8qbKCoh+DwYeVzrzMweAbHji62qsin5sXo GryPbo3iR6QqdFpp5E5oDdQlYgZcqglDGy3tnSgNO114iPt1JO2TFEtWcQVHdOKFtUph YmPw== X-Gm-Message-State: APjAAAXj7eKCB49Gjgo8oKbYQrIyXvFNAn3F25v5OiwCU3idcNZezqf4 rMCC9O581Cbh1VO/9wrcwUe4wcdkOtg= X-Google-Smtp-Source: APXvYqywKPn91NGIhyfCtdzGY7rOfxc3X75BgpjEC8sKIXamZVXJk1+/U8iWFTJFe7KXYcviDv/ICQ== X-Received: by 2002:a5d:4085:: with SMTP id o5mr22530913wrp.321.1581616612367; Thu, 13 Feb 2020 09:56:52 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary Date: Thu, 13 Feb 2020 17:56:18 +0000 Message-Id: <20200213175647.17628-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::435 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Currently we insist on using 'sphinx-build' from the $PATH; allow the user to specify the binary to use. This will be more useful as we become pickier about the capabilities we require (eg needing a Python 3 sphinx-build). Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Wainer dos Santos Moschetta Reviewed-by: Peter Maydell --- configure | 10 +++++++++- Makefile | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/configure b/configure index 115dc38085f..0aceb8e50db 100755 --- a/configure +++ b/configure @@ -584,6 +584,7 @@ query_pkg_config() { } pkg_config=3Dquery_pkg_config sdl2_config=3D"${SDL2_CONFIG-${cross_prefix}sdl2-config}" +sphinx_build=3Dsphinx-build =20 # If the user hasn't specified ARFLAGS, default to 'rv', just as make does. ARFLAGS=3D"${ARFLAGS-rv}" @@ -975,6 +976,8 @@ for opt do ;; --python=3D*) python=3D"$optarg" ;; + --sphinx-build=3D*) sphinx_build=3D"$optarg" + ;; --gcov=3D*) gcov_tool=3D"$optarg" ;; --smbd=3D*) smbd=3D"$optarg" @@ -1677,6 +1680,7 @@ Advanced options (experts only): --make=3DMAKE use specified make [$make] --install=3DINSTALL use specified install [$install] --python=3DPYTHON use specified python [$python] + --sphinx-build=3DSPHINX use specified sphinx-build [$sphinx_build] --smbd=3DSMBD use specified smbd [$smbd] --with-git=3DGIT use specified git [$git] --static enable static build [$static] @@ -4799,7 +4803,7 @@ has_sphinx_build() { # sphinx-build doesn't exist at all or if it is too old. mkdir -p "$TMPDIR1/sphinx" touch "$TMPDIR1/sphinx/index.rst" - sphinx-build -c "$source_path/docs" -b html "$TMPDIR1/sphinx" "$TMPDIR= 1/sphinx/out" >/dev/null 2>&1 + $sphinx_build -c "$source_path/docs" -b html "$TMPDIR1/sphinx" "$TMPDI= R1/sphinx/out" >/dev/null 2>&1 } =20 # Check if tools are available to build documentation. @@ -6474,6 +6478,9 @@ echo "QEMU_LDFLAGS $QEMU_LDFLAGS" echo "make $make" echo "install $install" echo "python $python ($python_version)" +if test "$docs" !=3D "no"; then + echo "sphinx-build $sphinx_build" +fi echo "slirp support $slirp $(echo_version $slirp $slirp_version)" if test "$slirp" !=3D "no" ; then echo "smbd $smbd" @@ -7503,6 +7510,7 @@ echo "INSTALL_DATA=3D$install -c -m 0644" >> $config_= host_mak echo "INSTALL_PROG=3D$install -c -m 0755" >> $config_host_mak echo "INSTALL_LIB=3D$install -c -m 0644" >> $config_host_mak echo "PYTHON=3D$python" >> $config_host_mak +echo "SPHINX_BUILD=3D$sphinx_build" >> $config_host_mak echo "CC=3D$cc" >> $config_host_mak if $iasl -h > /dev/null 2>&1; then echo "IASL=3D$iasl" >> $config_host_mak diff --git a/Makefile b/Makefile index f0e1a2fc1dc..430bbad0557 100644 --- a/Makefile +++ b/Makefile @@ -1030,7 +1030,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \ # Note the use of different doctree for each (manual, builder) tuple; # this works around Sphinx not handling parallel invocation on # a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946 -build-manual =3D $(call quiet-command,CONFDIR=3D"$(qemu_confdir)" sphinx-b= uild $(if $(V),,-q) -W -b $2 -D version=3D$(VERSION) -D release=3D"$(FULL_V= ERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPH= INX","$(MANUAL_BUILDDIR)/$1") +build-manual =3D $(call quiet-command,CONFDIR=3D"$(qemu_confdir)" $(SPHINX= _BUILD) $(if $(V),,-q) -W -b $2 -D version=3D$(VERSION) -D release=3D"$(FUL= L_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"= SPHINX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) \ $(wildcard $(SRC_PATH)/docs/$1/*.rst.inc) \ --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616717345196.65511694376005; Thu, 13 Feb 2020 09:58:37 -0800 (PST) Received: from localhost ([::1]:57118 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Il0-00021F-P6 for importer@patchew.org; Thu, 13 Feb 2020 12:58:34 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33529) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjQ-00005h-B0 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:57 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjP-0002Kg-6C for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:56 -0500 Received: from mail-wr1-x431.google.com ([2a00:1450:4864:20::431]:40270) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjO-0002It-Ud for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:55 -0500 Received: by mail-wr1-x431.google.com with SMTP id t3so7806529wru.7 for ; Thu, 13 Feb 2020 09:56:54 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:53 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=wr8RlgOBQK+lZKQOUvmEh0ytBymCGpyT+5O+C4ZgoYs=; b=NQZYCKT3Eqi6lJKeBeuJcFRFHqY5CnDIdqrRPVocEsoDPkQ7K52VmMTNw56WUBs4o5 8Pj+r5ErzQ4fSZrk5VRSa7+SFhMMAFXNOcAb6oeZp7Wb9aLUMwY/h8lIUhqAeud99MIo dYo8EllPWHSs2mKum9lxODQsAx+MKZg5NyK3MOSMhx4ccEYmvigLgIrzQuRPnx8GVkO/ 2ps4TwjI9NzSplvi7mJ9vkvA/AAxbQb2eofxMnItGgmSuJx7mssPzwW1MasnAvQW2ago IMzDD0Z8ZCjpzCB5tcjMaGKjIp+EiQ3gcz3l98Sg5rt3s3EAmvgaR1GlabJdUTQCTDVV Ke1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=wr8RlgOBQK+lZKQOUvmEh0ytBymCGpyT+5O+C4ZgoYs=; b=P1BL6grw5Z2tcbYqvMXMzNlGaD4GnnkjaIgtoJD0ZW0tHTWR6xSAEcFSSGPY0lzUGa nGlwVBY8kBcu9B1qPT1+bayRowHxAdTi+F71Mez2nwg9dJPZ3Af86yM9y0P2MHxvHKTu 1k1qKBEFKHyLq/dMUwZ7g2aoefop5PmvK2MofKYhZXSV5dNL8dTpuM+lO4gtwPQjqgUw 8hYLRUTGhoKSd+6Ys8iPaWmMtYE1hcxIYCUjXoJbUsvHMF2mCnib04SidhsAmTZo4lYs 7BZSl1m+0PpnFoFysmeRfAPZouELo4Kud0KRH8ZDjZTju4e4Ch8N5V9tniuzTrumjblE scAw== X-Gm-Message-State: APjAAAU1iG8CxBeRC38LBtPLeSv+ud2T4MwPTthA2ix4KY8Hcw4jd8Gt MlLbY+oVcWPmPQ3hxyWUAdGMqFEjw58= X-Google-Smtp-Source: APXvYqxQwyRGLtKqOvFOZApwoHcgpkKOlejk7mN1XbrBaxNUgGz94oH+I9fjNBRN8fbn8LlmtQVaBw== X-Received: by 2002:adf:e610:: with SMTP id p16mr24460075wrm.81.1581616613657; Thu, 13 Feb 2020 09:56:53 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 02/30] configure: Check that sphinx-build is using Python 3 Date: Thu, 13 Feb 2020 17:56:19 +0000 Message-Id: <20200213175647.17628-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::431 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Currently configure's has_sphinx_build() check simply runs a dummy sphinx-build and either passes or fails. This means that "no sphinx-build at all" and "sphinx-build exists but is too old" are both reported the same way. Further, we want to assume that all the Python we write is running with at least Python 3.5; configure checks that for our scripts, but Sphinx extensions run with whatever Python version sphinx-build itself is using. Add a check to our conf.py which makes sphinx-build fail if it would be running our extensions with an old Python, and handle this in configure so we can report failure helpfully to the user. This will mean that configure --enable-docs will fail like this if the sphinx-build provided is not suitable: Warning: sphinx-build exists but it is either too old or uses too old a Pyt= hon version ERROR: User requested feature docs configure was not able to find it. Install texinfo, Perl/perl-podlators and a Python 3 version of pytho= n-sphinx (As usual, the default is to simply not build the docs, as we would if sphinx-build wasn't present at all.) Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Wainer dos Santos Moschetta --- configure | 12 ++++++++++-- docs/conf.py | 10 ++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/configure b/configure index 0aceb8e50db..2c5cad13edd 100755 --- a/configure +++ b/configure @@ -4808,11 +4808,19 @@ has_sphinx_build() { =20 # Check if tools are available to build documentation. if test "$docs" !=3D "no" ; then - if has makeinfo && has pod2man && has_sphinx_build; then + if has_sphinx_build; then + sphinx_ok=3Dyes + else + sphinx_ok=3Dno + fi + if has makeinfo && has pod2man && test "$sphinx_ok" =3D "yes"; then docs=3Dyes else if test "$docs" =3D "yes" ; then - feature_not_found "docs" "Install texinfo, Perl/perl-podlators and p= ython-sphinx" + if has $sphinx_build && test "$sphinx_ok" !=3D "yes"; then + echo "Warning: $sphinx_build exists but it is either too old or us= es too old a Python version" >&2 + fi + feature_not_found "docs" "Install texinfo, Perl/perl-podlators and a= Python 3 version of python-sphinx" fi docs=3Dno fi diff --git a/docs/conf.py b/docs/conf.py index ee7faa6b4e7..7588bf192ee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,6 +28,16 @@ =20 import os import sys +import sphinx +from sphinx.errors import VersionRequirementError + +# Make Sphinx fail cleanly if using an old Python, rather than obscurely +# failing because some code in one of our extensions doesn't work there. +# Unfortunately this doesn't display very neatly (there's an unavoidable +# Python backtrace) but at least the information gets printed... +if sys.version_info < (3,5): + raise VersionRequirementError( + "QEMU requires a Sphinx that uses Python 3.5 or better\n") =20 # The per-manual conf.py will set qemu_docdir for a single-manual build; # otherwise set it here if this is an entire-manual-set build. --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616876329321.7073416402063; Thu, 13 Feb 2020 10:01:16 -0800 (PST) Received: from localhost ([::1]:57190 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2InZ-0005cY-9e for importer@patchew.org; Thu, 13 Feb 2020 13:01:14 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33570) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjR-000070-6O for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:01 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjQ-0002Mf-48 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:57 -0500 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:47063) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjP-0002Kw-Ua for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:56 -0500 Received: by mail-wr1-x441.google.com with SMTP id z7so7788407wrl.13 for ; Thu, 13 Feb 2020 09:56:55 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:54 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=f6kVJ6Rk8MNPYq7XtbttxL4g3BI/a4u+7aEZDw9SWmQ=; b=sYmu3e7afL3MVy8r96vEIyQ0aEzV1r6O/UX9LQAafbtIQtLIJcC71+vrQZu9wryJyv YasJGbxwwLTRgxpDpjsmHypp+29SGasyPMX6k4ushYbAsHwvk2TnAQy5udTJyKUdXqXu IAhfKt/goVD7MnSfNwTkJQUx/YPs7cNh85nrGK3aNo9TD/WXNzw9FzTmZ5thDcXLfeEg LnRyySYQYAuCSaqgy6vYrAI2xep8iebEx57/JPpZrH1GjUkN23vTMBOhVo7XZRxmRdIq L5uq0IiKKFMdJwurAcDqW88C5L8KMY62/Z7zRbysKXATRcoHXCoxnrDm9Df+4OdjT7we oV7A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=f6kVJ6Rk8MNPYq7XtbttxL4g3BI/a4u+7aEZDw9SWmQ=; b=mj7BElHBjt1XA3kx1NLU81fpcIV8rUFbOiFdGL0zeW0oO8WKhBFJKB9ZXvCfWZ0Ojb Iob2GDm2+ncKgfkzHyNFQYfVxNzkpS0GOelukKSG5OJkplt/+X7o+s+2USpDApq8toWV c7bLAAgjzyLwcDXE5hJf9YPhvyiUXvjIMhV84vZp4FJwWd+W9REpTdCxTMPOwqvpr8+C eYX68CFvSZ7oPs+JwEwri1iL7Xc5vHX2PudM979ze4b74bmE3szOoBOPyVC+Mo2PiSia 71tMPsvFxORMiC1ibc9Y7VQaYFAlhOk2DxQ32XAUHtpKQVdOOIilTCgarBXpUPx843+1 qsWA== X-Gm-Message-State: APjAAAUSQjhUbcE8M/K0iT2gieBME9zBu8vXDr9yH9erp4ufC4qkI3yP kuRcV+6q7ZzLKdnahfcPiTSrCBm2rA0= X-Google-Smtp-Source: APXvYqy/s0Ta3TNzvEpI14Dezd/1s1NHfkUY6gYKdtp4lIM8Y/G7+qPv7m76ZmVch41d6pr/qwUe6g== X-Received: by 2002:adf:db84:: with SMTP id u4mr23299487wri.317.1581616614787; Thu, 13 Feb 2020 09:56:54 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 03/30] Makefile: Fix typo in dependency list for interop manpages Date: Thu, 13 Feb 2020 17:56:20 +0000 Message-Id: <20200213175647.17628-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::441 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Fix a typo in the dependency list for the manpages built from the 'interop' manual, which meant we were accidentally not including the .hx file in the dependency list. Fixes: e13c59fa4414215500e6 Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 430bbad0557..b5a7377cb18 100644 --- a/Makefile +++ b/Makefile @@ -1059,7 +1059,7 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-d= eps,system) $(call define-manpage-rule,interop,\ qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ virtiofsd.1 virtfs-proxy-helper.1,\ - $(SRC_PATH/qemu-img-cmds.hx)) + $(SRC_PATH)/qemu-img-cmds.hx) =20 $(call define-manpage-rule,system,qemu-block-drivers.7) =20 --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616874244844.5939708060729; Thu, 13 Feb 2020 10:01:14 -0800 (PST) Received: from localhost ([::1]:57186 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2InX-0005Z9-M9 for importer@patchew.org; Thu, 13 Feb 2020 13:01:11 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33624) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjS-00007Y-9G for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:01 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjR-0002P2-AH for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:58 -0500 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:43699) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjR-0002NM-4R for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:56:57 -0500 Received: by mail-wr1-x434.google.com with SMTP id r11so7776034wrq.10 for ; Thu, 13 Feb 2020 09:56:57 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=g2WZpfNoMWL/DfUoo26twQ8bt2763a6Rl0JvwrClvQs=; b=XlWHyHLG1QEHmvjeZvjkLlCerr0xlPubWaomPJugssnSIl1etyMCbT4VRCgmQ2sw2r vOfhpsqVXJpuLTOFLR7eSFpquI4tlLiQILUJEAAAbK6UtkL9ZAp42aBHCDItBE39OA4P YnF2xYHSo9XeRcgDZrlBTEw+UIy8K0VXiy5wHARNXbAB0ih48IJeUUGgvDxVCPem4LmX mudojxNGhEGD3nu6DrDrxf6AVe3HBNIXXCo7x/VJ2eeL8Hw2YlvZje/hhmNDpI5rJpGr gBHaoq5iKG+g2qfOQ/JGjsE9OZpbKFC+DZp2KfTPlK+5ww0JxKZhWgQxEhWQsaU9xRnJ 81BA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=g2WZpfNoMWL/DfUoo26twQ8bt2763a6Rl0JvwrClvQs=; b=ZmuR7K+QZrdxZLJdUCVLSR8etbfKtWwpmWmCtFNJKyb/GD6jnnjcHQMEuaz1YkUugh 6zu5Nk5AQl7UKKTdksgIY9azoUqrQtgvmwrgbLW/t2Hdjruu/8S3N3RA4C4APEolphSa suQS75pZsLiZtM1NwnqTLQU9eAg4VwCN2YuuOaA3L7NJooc5r41oOh0Q4pKWi1OebztK Qjq0BBCZvxIxT5BkWlP8oLkzml0RwOsMik/AjtTHoRMHuMG8wZOhUF9AbdgTCdquPqg3 sJ3py8CRZWxqR6FdPwjo9E0X4HZ28UruEZw6i7zxPeJTF4q2QRpgkeTSG03kq0WrZZFU aKjA== X-Gm-Message-State: APjAAAX9b8OUqHf5ztYvaVFQ4Hjr7/NSrrsDcaJD8Whaee3cTQkf3Voc 1hLTHF0J2Et5W4pXQ1rF7mKhmXZzqLg= X-Google-Smtp-Source: APXvYqzSR42TgFvA5POGIbBseeCQorZaGXeW0oi5bLUw+40gFc7tw5/MLZMcv7bljicZSWhx1n5oNQ== X-Received: by 2002:adf:f28f:: with SMTP id k15mr22514041wro.230.1581616615883; Thu, 13 Feb 2020 09:56:55 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 04/30] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment Date: Thu, 13 Feb 2020 17:56:21 +0000 Message-Id: <20200213175647.17628-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::434 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The doc comment for GuestDiskBusType doesn't match up with the enumeration because of a missing hyphen in 'file-backed-virtual'. This means the docs are rendered wrongly: "virtual" Win virtual bus type "file-backed" virtual: Win file-backed bus = type "file-backed-virtual" Not documented Add the missing hyphen. Signed-off-by: Peter Maydell Reviewed-by: Eric Blake Reviewed-by: Markus Armbruster --- qga/qapi-schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index fb4605cc19c..23ce6af597d 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -809,7 +809,7 @@ # @sas: Win serial-attaches SCSI bus type # @mmc: Win multimedia card (MMC) bus type # @virtual: Win virtual bus type -# @file-backed virtual: Win file-backed bus type +# @file-backed-virtual: Win file-backed bus type # # Since: 2.2; 'Unknown' and all entries below since 2.4 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617000876958.9703078082455; Thu, 13 Feb 2020 10:03:20 -0800 (PST) Received: from localhost ([::1]:57240 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ipb-0000RB-5E for importer@patchew.org; Thu, 13 Feb 2020 13:03:19 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33735) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjZ-0000KA-1m for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:06 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjX-0002WJ-4G for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:04 -0500 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]:35172) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjW-0002Qb-Sb for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:03 -0500 Received: by mail-wm1-x341.google.com with SMTP id b17so7802588wmb.0 for ; Thu, 13 Feb 2020 09:56:58 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:56 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=fLHmDYlQWfVhICZYevuL8zWZyC/V25dFeDELII/rZe0=; b=nbRdmOjVYe+iQDa1VUiH9cMvYBXgtoW5pQWEPpqGeiVioM1n33HMFS/UmSzWDzM5Ju qjjWvT11C6fIgGtWotWjMy/WjpwJdLApmGTZLT52g9UIO1jNKk92VeCPk2Dn2jkbxW0t HIDY3anAa0jcHaSUncmh0pJTLR75UHEQp2KkaPPETu6lfmG2QChU7NPkFkdWsx2IFaE9 B76D514cfJzk3IVGs694et2/oLLHFE01agoIzBJVq3JmMUpQLtcp5xkDAnhi6L/MTHi6 vJmPTeu9qI3f17b24PJ13omw5X2YDEvIcKsAftH8fqerlTzp+Sa3XnIHQvT1F5+YvfVp r83g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=fLHmDYlQWfVhICZYevuL8zWZyC/V25dFeDELII/rZe0=; b=hglR01z3AwIttx1gUkCX9wlTDC2Rgta3Y3sfHXBwM2CwuDUz1zckt5e1ZlknrhNhv2 b3nWLM32PMXnOlE5rjyIktAIwmd9e5TU+t6hOSYqlBlzF4Q1qZI4aK9UbpRjF6IdRCv2 Brz5oS7T+qMXIphBvNudq6/COJz9gkwn/j7ldo7t8KE+hicWgmyWKK0iU5a4V23HzQI4 iqTmLCzE1phVGiBg1lumB+zfcFMT2kpQQx1VxPg4s6tNm45deDT6Le2Ogw6QdcRc6Afp fqCnT4sx722PXKlSc+/4crR/X4i0O7UTnc4yvBvUIxgl1RR9Onpyi9GZOdO4K/zb9XXa ox+w== X-Gm-Message-State: APjAAAXStY6ZkjwAJZJufkv1SZkF6gMsjr0q7Tyh2PbtyDGQDvQZ1nwV aQq/qcQVYj3FQtkDzkHi7UT0CVj/wZs= X-Google-Smtp-Source: APXvYqxzY+gNirlHFe6Hw3LMktCz1UNWii9+LvHgOX44Jfd3R1gJ9Dcex+yCTesEwg7YGdKp4sidUw== X-Received: by 2002:a05:600c:2c53:: with SMTP id r19mr6976901wmg.39.1581616617124; Thu, 13 Feb 2020 09:56:57 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 05/30] qga/qapi-schema.json: Fix indent level on doc comments Date: Thu, 13 Feb 2020 17:56:22 +0000 Message-Id: <20200213175647.17628-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::341 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The texinfo doc generation doesn't care much about indentation levels, but we would like to add a rST backend, and rST does care about indentation. Make the doc comments more strongly consistent about indentation for multiline constructs like: @arg: description line 1 description line 2 Returns: line one line 2 so that there is always exactly one space after the colon, and subsequent lines align with the first. This commit is a purely whitespace change, and it does not alter the generated .texi files (because the texi generation code strips away all the extra whitespace). This does mean that we end up with some over-length lines. Note that when the documentation for an argument fits on a single line like this: @arg: one line only then stray extra spaces after the ':' don't affect the rST output, so I have not attempted to methodically fix them, though the preference is a single space here too. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- qga/qapi-schema.json | 62 ++++++++++++++++++++++---------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 23ce6af597d..7661b2b3b45 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -416,7 +416,7 @@ # Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined below) # # Note: This may fail to properly report the current state as a result of -# some other guest processes having issued an fs freeze/thaw. +# some other guest processes having issued an fs freeze/thaw. # # Since: 0.15.0 ## @@ -431,13 +431,13 @@ # unfreeze. # # Note: On Windows, the command is implemented with the help of a -# Volume Shadow-copy Service DLL helper. The frozen state is limited -# for up to 10 seconds by VSS. +# Volume Shadow-copy Service DLL helper. The frozen state is limited +# for up to 10 seconds by VSS. # # Returns: Number of file systems currently frozen. On error, all filesyst= ems -# will be thawed. If no filesystems are frozen as a result of this call, -# then @guest-fsfreeze-status will remain "thawed" and calling -# @guest-fsfreeze-thaw is not necessary. +# will be thawed. If no filesystems are frozen as a result of thi= s call, +# then @guest-fsfreeze-status will remain "thawed" and calling +# @guest-fsfreeze-thaw is not necessary. # # Since: 0.15.0 ## @@ -455,7 +455,7 @@ # Invalid mount points are ignored. # # Returns: Number of file systems currently frozen. On error, all filesyst= ems -# will be thawed. +# will be thawed. # # Since: 2.2 ## @@ -511,12 +511,12 @@ # Discard (or "trim") blocks which are not in use by the filesystem. # # @minimum: -# Minimum contiguous free range to discard, in bytes. Free ranges -# smaller than this may be ignored (this is a hint and the guest -# may not respect it). By increasing this value, the fstrim -# operation will complete more quickly for filesystems with badly -# fragmented free space, although not all blocks will be discarded. -# The default value is zero, meaning "discard every free block". +# Minimum contiguous free range to discard, in bytes. Free ranges +# smaller than this may be ignored (this is a hint and the guest +# may not respect it). By increasing this value, the fstrim +# operation will complete more quickly for filesystems with badly +# fragmented free space, although not all blocks will be discard= ed. +# The default value is zero, meaning "discard every free block". # # Returns: A @GuestFilesystemTrimResponse which contains the # status of all trimmed paths. (since 2.4) @@ -693,7 +693,7 @@ # @ip-addresses: List of addresses assigned to @name # # @statistics: various statistic counters related to @name -# (since 2.11) +# (since 2.11) # # Since: 1.1 ## @@ -743,7 +743,7 @@ # This is a read-only operation. # # Returns: The list of all VCPUs the guest knows about. Each VCPU is put o= n the -# list exactly once, but their order is unspecified. +# list exactly once, but their order is unspecified. # # Since: 1.5 ## @@ -937,8 +937,8 @@ # This is a read-only operation. # # Returns: The list of all memory blocks the guest knows about. -# Each memory block is put on the list exactly once, but their order -# is unspecified. +# Each memory block is put on the list exactly once, but their or= der +# is unspecified. # # Since: 2.3 ## @@ -971,9 +971,9 @@ # @response: the result of memory block operation. # # @error-code: the error number. -# When memory block operation fails, we assign the value of -# 'errno' to this member, it indicates what goes wrong. -# When the operation succeeds, it will be omitted. +# When memory block operation fails, we assign the value of +# 'errno' to this member, it indicates what goes wrong. +# When the operation succeeds, it will be omitted. # # Since: 2.3 ## @@ -1040,15 +1040,15 @@ # @exited: true if process has already terminated. # @exitcode: process exit code if it was normally terminated. # @signal: signal number (linux) or unhandled exception code -# (windows) if the process was abnormally terminated. +# (windows) if the process was abnormally terminated. # @out-data: base64-encoded stdout of the process # @err-data: base64-encoded stderr of the process -# Note: @out-data and @err-data are present only -# if 'capture-output' was specified for 'guest-exec' +# Note: @out-data and @err-data are present only +# if 'capture-output' was specified for 'guest-exec' # @out-truncated: true if stdout was not fully captured -# due to size limitation. +# due to size limitation. # @err-truncated: true if stderr was not fully captured -# due to size limitation. +# due to size limitation. # # Since: 2.5 ## @@ -1131,8 +1131,8 @@ =20 ## # @GuestUser: -# @user: Username -# @domain: Logon domain (windows only) +# @user: Username +# @domain: Logon domain (windows only) # @login-time: Time of login of this user on the computer. If multiple # instances of the user are logged in, the earliest login tim= e is # reported. The value is in fractional seconds since epoch ti= me. @@ -1156,10 +1156,10 @@ ## # @GuestTimezone: # -# @zone: Timezone name. These values may differ depending on guest/OS a= nd -# should only be used for informational purposes. -# @offset: Offset to UTC in seconds, negative numbers for time zones west= of -# GMT, positive numbers for east +# @zone: Timezone name. These values may differ depending on guest/OS and +# should only be used for informational purposes. +# @offset: Offset to UTC in seconds, negative numbers for time zones west = of +# GMT, positive numbers for east # # Since: 2.10 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617326817550.9784581556441; Thu, 13 Feb 2020 10:08:46 -0800 (PST) Received: from localhost ([::1]:57348 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Iup-0007vN-54 for importer@patchew.org; Thu, 13 Feb 2020 13:08:43 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33846) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijc-0000Ts-OY for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjX-0002WZ-5j for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:08 -0500 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:46094) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjW-0002S5-U2 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:03 -0500 Received: by mail-wr1-x434.google.com with SMTP id z7so7788648wrl.13 for ; Thu, 13 Feb 2020 09:56:59 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=A2//xF4cU9fngBLXdXyIv9i7RvZaILvkPN4bDJz6pxM=; b=U0GYZGnvwGmx7JLznGm9hVOateVotVkRb9aUaYbBA5NcAQkNIOOWh5EqQmTiK68wxg ThlZriYAnFjDSKhgfxFkAaBJ+EqveSwfT7vCiRxHTXVGYf+vCy6Ed1jKuL3W89sEebRu QQrUonxFWB3EimGddl7tTD3yA664xWNFdDu+yadN9rvzLkFAfh7KgYFsrAM1Qq1tk5b+ Rbzz8FRmJs+znx6Tefvwl9HXzvvMrcCd/6ZovqgkIerbtWg+IfqnSsZBRV1GEGJl6SY4 y12s3Z6cTWj9NFDPLBXTtdOCiocJa1bRlTtx36Dq6xMjeDBqTVbOfpv6uVet8zmW0rR+ 9Cqg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=A2//xF4cU9fngBLXdXyIv9i7RvZaILvkPN4bDJz6pxM=; b=A6RUa8drE9assr7KttEGck4i27yo5l3cE7XG4B4MTuxEbYe7RfnxeS+4IZGqCv0Ns9 9JkwJs1MqfvLOol2yZeIdzbkJJsxW3g8flzRIms48BgA/woxT9hhnT0emlO1IkiQWIw+ 6ilmQvvbpIjLYSAG61X3tGjABJgOCndEOEYxqOe5sSFCxoQCsbpieCqtW+OayWkJ7xC9 4dospJDldTp+5MKOqtQg5XGS1t1ncQ2lMr5EJuFhR5mQik/VhxwOGBYbLPgv8/y6TZPK kB/fLThoPrazmNlCSOeFJYDZU2FeXuGjiz0VmODxyHSiDhdr/IAC33omPq0gsUlq7ky+ EXog== X-Gm-Message-State: APjAAAWNm6ZI6qlE3THN4pq9UFt9TpyoGN6oWbEty8e0p4QZMy+jWvC/ V0EaNnThbhYrAFD277nbUeJ8MHKlHIs= X-Google-Smtp-Source: APXvYqys9A4r9ErZKxx8Rn4o2ZOhb0vNkWQum/hj0nT62+o5d4X13K1rag/WuTmePnVeYN1xbBdZGw== X-Received: by 2002:a5d:6b03:: with SMTP id v3mr21788863wrw.289.1581616618568; Thu, 13 Feb 2020 09:56:58 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 06/30] qga/qapi-schema.json: minor format fixups for rST Date: Thu, 13 Feb 2020 17:56:23 +0000 Message-Id: <20200213175647.17628-7-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::434 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" rST format requires a blank line before the start of a bulleted or enumerated list. Two places in qapi-schema.json were missing this blank line. Some places were using an indented line as a sort of single-item bulleted list, which in the texinfo output comes out all run onto a single line; use a real bulleted list instead. Some places unnecessarily indented lists, which confuses rST. guest-fstrim:minimum's documentation was indented the right amount to share a line with @minimum, but wasn't actually doing so. The indent on the bulleted list in the guest-set-vcpus Returns section meant rST misindented it. Changes to the generated texinfo are very minor (the new bulleted lists, and a few extra blank lines). Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- qga/qapi-schema.json | 94 ++++++++++++++++++++++++-------------------- 1 file changed, 51 insertions(+), 43 deletions(-) diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 7661b2b3b45..f6fcb59f34b 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -510,8 +510,7 @@ # # Discard (or "trim") blocks which are not in use by the filesystem. # -# @minimum: -# Minimum contiguous free range to discard, in bytes. Free ranges +# @minimum: Minimum contiguous free range to discard, in bytes. Free ranges # smaller than this may be ignored (this is a hint and the guest # may not respect it). By increasing this value, the fstrim # operation will complete more quickly for filesystems with badly @@ -546,7 +545,8 @@ # (or set its status to "shutdown") due to other reasons. # # The following errors may be returned: -# If suspend to disk is not supported, Unsupported +# +# - If suspend to disk is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command before # sending commands when the guest resumes @@ -575,12 +575,14 @@ # # This command does NOT return a response on success. There are two options # to check for success: -# 1. Wait for the SUSPEND QMP event from QEMU -# 2. Issue the query-status QMP command to confirm the VM status is -# "suspended" +# +# 1. Wait for the SUSPEND QMP event from QEMU +# 2. Issue the query-status QMP command to confirm the VM status is +# "suspended" # # The following errors may be returned: -# If suspend to ram is not supported, Unsupported +# +# - If suspend to ram is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command before # sending commands when the guest resumes @@ -607,12 +609,14 @@ # # This command does NOT return a response on success. There are two options # to check for success: -# 1. Wait for the SUSPEND QMP event from QEMU -# 2. Issue the query-status QMP command to confirm the VM status is -# "suspended" +# +# 1. Wait for the SUSPEND QMP event from QEMU +# 2. Issue the query-status QMP command to confirm the VM status is +# "suspended" # # The following errors may be returned: -# If hybrid suspend is not supported, Unsupported +# +# - If hybrid suspend is not supported, Unsupported # # Notes: It's strongly recommended to issue the guest-sync command before # sending commands when the guest resumes @@ -767,18 +771,22 @@ # Returns: The length of the initial sublist that has been successfully # processed. The guest agent maximizes this value. Possible cases: # -# - 0: if the @vcpus list was empty on input. Guest = state -# has not been changed. Otherwise, -# - Error: processing the first node of @vcpus failed fo= r the -# reason returned. Guest state has not been cha= nged. -# Otherwise, -# - < length(@vcpus): more than zero initial nodes have been proc= essed, -# but not the entire @vcpus list. Guest state h= as -# changed accordingly. To retrieve the error -# (assuming it persists), repeat the call with = the -# successfully processed initial sublist remove= d. -# Otherwise, -# - length(@vcpus): call successful. +# - 0: +# if the @vcpus list was empty on input. Guest state +# has not been changed. Otherwise, +# - Error: +# processing the first node of @vcpus failed for the +# reason returned. Guest state has not been changed. +# Otherwise, +# - < length(@vcpus): +# more than zero initial nodes have been processed, +# but not the entire @vcpus list. Guest state has +# changed accordingly. To retrieve the error +# (assuming it persists), repeat the call with the +# successfully processed initial sublist removed. +# Otherwise, +# - length(@vcpus): +# call successful. # # Since: 1.5 ## @@ -1182,35 +1190,35 @@ # @GuestOSInfo: # # @kernel-release: -# * POSIX: release field returned by uname(2) -# * Windows: build number of the OS +# * POSIX: release field returned by uname(2) +# * Windows: build number of the OS # @kernel-version: -# * POSIX: version field returned by uname(2) -# * Windows: version number of the OS +# * POSIX: version field returned by uname(2) +# * Windows: version number of the OS # @machine: -# * POSIX: machine field returned by uname(2) -# * Windows: one of x86, x86_64, arm, ia64 +# * POSIX: machine field returned by uname(2) +# * Windows: one of x86, x86_64, arm, ia64 # @id: -# * POSIX: as defined by os-release(5) -# * Windows: contains string "mswindows" +# * POSIX: as defined by os-release(5) +# * Windows: contains string "mswindows" # @name: -# * POSIX: as defined by os-release(5) -# * Windows: contains string "Microsoft Windows" +# * POSIX: as defined by os-release(5) +# * Windows: contains string "Microsoft Windows" # @pretty-name: -# * POSIX: as defined by os-release(5) -# * Windows: product name, e.g. "Microsoft Windows 10 Enterprise" +# * POSIX: as defined by os-release(5) +# * Windows: product name, e.g. "Microsoft Windows 10 Enterprise" # @version: -# * POSIX: as defined by os-release(5) -# * Windows: long version string, e.g. "Microsoft Windows Server 2008" +# * POSIX: as defined by os-release(5) +# * Windows: long version string, e.g. "Microsoft Windows Server 2008" # @version-id: -# * POSIX: as defined by os-release(5) -# * Windows: short version identifier, e.g. "7" or "20012r2" +# * POSIX: as defined by os-release(5) +# * Windows: short version identifier, e.g. "7" or "20012r2" # @variant: -# * POSIX: as defined by os-release(5) -# * Windows: contains string "server" or "client" +# * POSIX: as defined by os-release(5) +# * Windows: contains string "server" or "client" # @variant-id: -# * POSIX: as defined by os-release(5) -# * Windows: contains string "server" or "client" +# * POSIX: as defined by os-release(5) +# * Windows: contains string "server" or "client" # # Notes: # --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616869222149.74719401802372; Thu, 13 Feb 2020 10:01:09 -0800 (PST) Received: from localhost ([::1]:57182 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2InR-0005MT-8N for importer@patchew.org; Thu, 13 Feb 2020 13:01:05 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33722) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjY-0000JQ-NO for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:05 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjX-0002WQ-4w for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:04 -0500 Received: from mail-wr1-x42d.google.com ([2a00:1450:4864:20::42d]:43693) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjW-0002TL-UX for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:03 -0500 Received: by mail-wr1-x42d.google.com with SMTP id r11so7776296wrq.10 for ; Thu, 13 Feb 2020 09:57:01 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.56.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:56:59 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=4JzfbSfaGdZz4al+lIjrQuS06F81QxSYycFR01GlxW8=; b=t5uW4ITj/cw5tMyjge1kQlVt5gRdlEpwv57S6oX3TLm/Go14RT+R4TZNWDz2hnYvsK uplfLm4aGKSSOPLXcA/ATvvx62aw3PzhRtUKEVIUZjpkRoas6vC+0VJLjVkmsrc27/6x nZFf+Q7fOUPOgSzrY0EnNkVf5dHoHRZoN8Ofeddf9NvrDb7O6SgpbT4+eQTiQ7+Obp26 eEoM7pN2V8ne04LEU6XIP6KPRaSsJvvkI08YKVGxfdGhIA1/9MQEd9twz0hWKkmSI1Oi aoYuBawSyo7c1JRE9i6hNiAhYRHTjER7sl3XBFOPmWwS6MZ94uNJFs2ys/EuCDX3TFbF k8gA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=4JzfbSfaGdZz4al+lIjrQuS06F81QxSYycFR01GlxW8=; b=eyNiTaGZVBH+7Bd+T1DkCwNdSSY5d14LXHYNshkkZX+C4Ayx8RA02ZgRWz7mK+Tu4e c0tNev8RvLVhNPiN4wsHclQNeanRskCdO6TnfDOq3lOPrCoUQUf8FaoVtDzw2GznqA89 Sf6gHeYz90xiAN9wnFJff+xrv0sWiPVa8v5dKIoA6DShuTV7PBLeB/G35e4NwDnGAGxC tiDT5Pk4t6FB/5nKz3CZs7w3lSuLPut2dPDpvYwP5udDB+4rwQJkf7UAvUZYmcDWBxPj LBwU459CbbDb/C3CBXKp47J4tp3xCDNyg1G5ipL3OXQH6HArxMF1MQtyjPWIlxRoIZyM 3qgA== X-Gm-Message-State: APjAAAWOo1qWx0IlPRQGc2A84aD6+YEB56czYrKCCn3qigPEYrpaEMHL dPIQceVIETflwdms8YTu+Cm71ZYiZPY= X-Google-Smtp-Source: APXvYqyKj1rSYYrLvD2U51SDhrigyhTuQXBsIdOYZd/q8wyErv3fh/JAgD3vMUIJ8rn9dArBhhizfg== X-Received: by 2002:a5d:448c:: with SMTP id j12mr22422198wrq.125.1581616619927; Thu, 13 Feb 2020 09:56:59 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art Date: Thu, 13 Feb 2020 17:56:24 +0000 Message-Id: <20200213175647.17628-8-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42d X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The ascii-art graph in the BlockLatencyHistogramInfo documentation doesn't render correctly, because the whitespace is collapsed. Use the '|' format that emits a literal 'example' block so the graph is displayed correctly. Strictly the texinfo generated is still wrong because each line goes into its own @example environment, but it renders better than what we had before. Fixing this rendering is a necessary prerequisite for the rST generator, which otherwise complains about the inconsistent indentation in the ascii-art graph. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- v1->v2: tweaked commit message, made graph still line up with preceding paragraph text --- qapi/block-core.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index ef94a296868..db9ca688d49 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -550,13 +550,13 @@ # For the example above, @bins may be something like [3, 1, 5, 2], # and corresponding histogram looks like: # -# 5| * -# 4| * -# 3| * * -# 2| * * * -# 1| * * * * -# +------------------ -# 10 50 100 +# | 5| * +# | 4| * +# | 3| * * +# | 2| * * * +# | 1| * * * * +# | +------------------ +# | 10 50 100 # # Since: 4.0 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617165901327.4943024173465; Thu, 13 Feb 2020 10:06:05 -0800 (PST) Received: from localhost ([::1]:57300 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IsF-0004Si-D4 for importer@patchew.org; Thu, 13 Feb 2020 13:06:03 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33775) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IjZ-0000MD-Qk for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:09 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2IjX-0002XG-Bk for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:05 -0500 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]:55116) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2IjX-0002V6-22 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:03 -0500 Received: by mail-wm1-x332.google.com with SMTP id g1so7246107wmh.4 for ; Thu, 13 Feb 2020 09:57:02 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=vejfpe8tmTeOtD0T1idJ1yF06muHUSuIJ0JKc90oK5k=; b=a8FnFq0FdyXcQBKB79jagevKbkn4gNGuJ7mqUe9MuQM9+drUSpUWBTPTGu+ZPih7vD uZdF6KujbEkcIykFVv77XCrAqjhYq+8pXG6aQbzaf/dt96ixWF+RHrssXNJZbVEKXWmN TviIdSxSnFFqx+ogpxnhjW/Cnuf1GCOyffSI9tzreIinE0rmvIZPhSV/GTPxWLX5054c Cr/FIfxcTXlQFn4LqD17FubUuYAkQEXD4ABhv/VK74C9dztir8KzbdxTFsgQFShg2yP7 iiBCevns4kKACxsfCJRnHqBSn/4kbaLXC5FXNaQpVQw9JXo0pfSlb+t2vqxrvY/Pv109 hiDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=vejfpe8tmTeOtD0T1idJ1yF06muHUSuIJ0JKc90oK5k=; b=mVkSS02/CqAuuc197Rv9YSHu0bQNTZD61SfnAds9fXQfW/WSr6WlV5Dbnm+uBJ1KRA IQFWcFtFX3lXrZaZGxTBFlwDO4gVSNdKMuSFYwrqgsmec5U+4zPp47iN9IinMl6VIoxF agBy9oiQlu+DRRgNRW/GSMDuTDDfBMxFYa4CYn8k4lOTgQfjDELf9K8qNhh+GPx5ofbB 6DMBoca16HQ9h+jSrPIBGU/nUbHdKpASArnvwUpgq6srO8uHrJ4eP/q8WXKPTDG0/qaa miP6Y3j092/cvyJ2s9s2EzORpkxJMAWvJtp6fTeXn28sLPtMfrfnGk6/ZDmjxknuVLMq z6XA== X-Gm-Message-State: APjAAAVA1Q9M5tF1uQI1CAMLOyHiKNsJYQQ7mtqmhv+QqCWFml1eeODQ gohNuW6jGvc2PzSVtJ8LGlscXPijcr0= X-Google-Smtp-Source: APXvYqxatoixZIAkGTfUzQYPndM3c4lxzQ/7Yt1mLoYGUg0sQZV8EvPUoU7NEwxxxomdGgsEaJa6ng== X-Received: by 2002:a1c:4857:: with SMTP id v84mr6951355wma.8.1581616621280; Thu, 13 Feb 2020 09:57:01 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 08/30] qapi: Use ':' after @argument in doc comments Date: Thu, 13 Feb 2020 17:56:25 +0000 Message-Id: <20200213175647.17628-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::332 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Some qapi doc comments have forgotten the ':' after the @argument, like this: # @filename Filename for the new image file # @size Size of the virtual disk in bytes The result is that these are parsed as part of the body text and appear as a run-on line: filename Filename for the new image file size Size of the virtual disk in= bytes" followed by filename: string Not documented size: int Not documented in the 'Members' section. Correct the formatting. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- qapi/block-core.json | 236 +++++++++++++++++++++---------------------- 1 file changed, 118 insertions(+), 118 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index db9ca688d49..c617bc2af63 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -3235,9 +3235,9 @@ ## # @SshHostKeyCheckMode: # -# @none Don't check the host key at all -# @hash Compare the host key with a given hash -# @known_hosts Check the host key against the known_hosts file +# @none: Don't check the host key at all +# @hash: Compare the host key with a given hash +# @known_hosts: Check the host key against the known_hosts file # # Since: 2.12 ## @@ -3247,8 +3247,8 @@ ## # @SshHostKeyCheckHashType: # -# @md5 The given hash is an md5 hash -# @sha1 The given hash is an sha1 hash +# @md5: The given hash is an md5 hash +# @sha1: The given hash is an sha1 hash # # Since: 2.12 ## @@ -3258,8 +3258,8 @@ ## # @SshHostKeyHash: # -# @type The hash algorithm used for the hash -# @hash The expected hash value +# @type: The hash algorithm used for the hash +# @hash: The expected hash value # # Since: 2.12 ## @@ -4265,13 +4265,13 @@ # # Driver specific image creation options for file. # -# @filename Filename for the new image file -# @size Size of the virtual disk in bytes -# @preallocation Preallocation mode for the new image (default: off; -# allowed values: off, -# falloc (if defined CONFIG_POSIX_FALLOCATE), -# full (if defined CONFIG_POSIX)) -# @nocow Turn off copy-on-write (valid only on btrfs; default: = off) +# @filename: Filename for the new image file +# @size: Size of the virtual disk in bytes +# @preallocation: Preallocation mode for the new image (default: off; +# allowed values: off, +# falloc (if defined CONFIG_POSIX_FALLOCATE), +# full (if defined CONFIG_POSIX)) +# @nocow: Turn off copy-on-write (valid only on btrfs; default: off) # # Since: 2.12 ## @@ -4286,12 +4286,12 @@ # # Driver specific image creation options for gluster. # -# @location Where to store the new image file -# @size Size of the virtual disk in bytes -# @preallocation Preallocation mode for the new image (default: off; -# allowed values: off, -# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE), -# full (if defined CONFIG_GLUSTERFS_ZEROFILL)) +# @location: Where to store the new image file +# @size: Size of the virtual disk in bytes +# @preallocation: Preallocation mode for the new image (default: off; +# allowed values: off, +# falloc (if defined CONFIG_GLUSTERFS_FALLOCATE), +# full (if defined CONFIG_GLUSTERFS_ZEROFILL)) # # Since: 2.12 ## @@ -4305,11 +4305,11 @@ # # Driver specific image creation options for LUKS. # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @preallocation Preallocation mode for the new image -# (since: 4.2) -# (default: off; allowed values: off, metadata, falloc, = full) +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @preallocation: Preallocation mode for the new image +# (since: 4.2) +# (default: off; allowed values: off, metadata, falloc, fu= ll) # # Since: 2.12 ## @@ -4324,8 +4324,8 @@ # # Driver specific image creation options for NFS. # -# @location Where to store the new image file -# @size Size of the virtual disk in bytes +# @location: Where to store the new image file +# @size: Size of the virtual disk in bytes # # Since: 2.12 ## @@ -4338,9 +4338,9 @@ # # Driver specific image creation options for parallels. # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @cluster-size Cluster size in bytes (default: 1 MB) +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @cluster-size: Cluster size in bytes (default: 1 MB) # # Since: 2.12 ## @@ -4354,11 +4354,11 @@ # # Driver specific image creation options for qcow. # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @backing-file File name of the backing file if a backing file -# should be used -# @encrypt Encryption options if the image should be encrypted +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @backing-file: File name of the backing file if a backing file +# should be used +# @encrypt: Encryption options if the image should be encrypted # # Since: 2.12 ## @@ -4385,24 +4385,24 @@ # # Driver specific image creation options for qcow2. # -# @file Node to create the image format on -# @data-file Node to use as an external data file in which all guest -# data is stored so that only metadata remains in the qc= ow2 -# file (since: 4.0) -# @data-file-raw True if the external data file must stay valid as a -# standalone (read-only) raw image without looking at qc= ow2 -# metadata (default: false; since: 4.0) -# @size Size of the virtual disk in bytes -# @version Compatibility level (default: v3) -# @backing-file File name of the backing file if a backing file -# should be used -# @backing-fmt Name of the block driver to use for the backing file -# @encrypt Encryption options if the image should be encrypted -# @cluster-size qcow2 cluster size in bytes (default: 65536) -# @preallocation Preallocation mode for the new image (default: off; -# allowed values: off, falloc, full, metadata) -# @lazy-refcounts True if refcounts may be updated lazily (default: off) -# @refcount-bits Width of reference counts in bits (default: 16) +# @file: Node to create the image format on +# @data-file: Node to use as an external data file in which all guest +# data is stored so that only metadata remains in the qcow2 +# file (since: 4.0) +# @data-file-raw: True if the external data file must stay valid as a +# standalone (read-only) raw image without looking at qcow2 +# metadata (default: false; since: 4.0) +# @size: Size of the virtual disk in bytes +# @version: Compatibility level (default: v3) +# @backing-file: File name of the backing file if a backing file +# should be used +# @backing-fmt: Name of the block driver to use for the backing file +# @encrypt: Encryption options if the image should be encrypted +# @cluster-size: qcow2 cluster size in bytes (default: 65536) +# @preallocation: Preallocation mode for the new image (default: off; +# allowed values: off, falloc, full, metadata) +# @lazy-refcounts: True if refcounts may be updated lazily (default: off) +# @refcount-bits: Width of reference counts in bits (default: 16) # # Since: 2.12 ## @@ -4425,13 +4425,13 @@ # # Driver specific image creation options for qed. # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @backing-file File name of the backing file if a backing file -# should be used -# @backing-fmt Name of the block driver to use for the backing file -# @cluster-size Cluster size in bytes (default: 65536) -# @table-size L1/L2 table size (in clusters) +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @backing-file: File name of the backing file if a backing file +# should be used +# @backing-fmt: Name of the block driver to use for the backing file +# @cluster-size: Cluster size in bytes (default: 65536) +# @table-size: L1/L2 table size (in clusters) # # Since: 2.12 ## @@ -4448,10 +4448,10 @@ # # Driver specific image creation options for rbd/Ceph. # -# @location Where to store the new image file. This location cannot -# point to a snapshot. -# @size Size of the virtual disk in bytes -# @cluster-size RBD object size +# @location: Where to store the new image file. This location cannot +# point to a snapshot. +# @size: Size of the virtual disk in bytes +# @cluster-size: RBD object size # # Since: 2.12 ## @@ -4499,23 +4499,23 @@ # # Driver specific image creation options for VMDK. # -# @file Where to store the new image file. This refers to the image -# file for monolithcSparse and streamOptimized format, or the -# descriptor file for other formats. -# @size Size of the virtual disk in bytes -# @extents Where to store the data extents. Required for monolithcFla= t, -# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For -# monolithicFlat, only one entry is required; for -# twoGbMaxExtent* formats, the number of entries required is -# calculated as extent_number =3D virtual_size / 2GB. Provid= ing -# more extents than will be used is an error. -# @subformat The subformat of the VMDK image. Default: "monolithicSpars= e". -# @backing-file The path of backing file. Default: no backing file is used. -# @adapter-type The adapter type used to fill in the descriptor. Default: = ide. -# @hwversion Hardware version. The meaningful options are "4" or "6". -# Default: "4". -# @zeroed-grain Whether to enable zeroed-grain feature for sparse subforma= ts. -# Default: false. +# @file: Where to store the new image file. This refers to the image +# file for monolithcSparse and streamOptimized format, or the +# descriptor file for other formats. +# @size: Size of the virtual disk in bytes +# @extents: Where to store the data extents. Required for monolithcFlat, +# twoGbMaxExtentSparse and twoGbMaxExtentFlat formats. For +# monolithicFlat, only one entry is required; for +# twoGbMaxExtent* formats, the number of entries required is +# calculated as extent_number =3D virtual_size / 2GB. Providing +# more extents than will be used is an error. +# @subformat: The subformat of the VMDK image. Default: "monolithicSparse". +# @backing-file: The path of backing file. Default: no backing file is use= d. +# @adapter-type: The adapter type used to fill in the descriptor. Default:= ide. +# @hwversion: Hardware version. The meaningful options are "4" or "6". +# Default: "4". +# @zeroed-grain: Whether to enable zeroed-grain feature for sparse subform= ats. +# Default: false. # # Since: 4.0 ## @@ -4533,9 +4533,9 @@ ## # @SheepdogRedundancyType: # -# @full Create a fully replicated vdi with x copies -# @erasure-coded Create an erasure coded vdi with x data strips and -# y parity strips +# @full: Create a fully replicated vdi with x copies +# @erasure-coded: Create an erasure coded vdi with x data strips and +# y parity strips # # Since: 2.12 ## @@ -4545,7 +4545,7 @@ ## # @SheepdogRedundancyFull: # -# @copies Number of copies to use (between 1 and 31) +# @copies: Number of copies to use (between 1 and 31) # # Since: 2.12 ## @@ -4555,8 +4555,8 @@ ## # @SheepdogRedundancyErasureCoded: # -# @data-strips Number of data strips to use (one of {2,4,8,16}) -# @parity-strips Number of parity strips to use (between 1 and 15) +# @data-strips: Number of data strips to use (one of {2,4,8,16}) +# @parity-strips: Number of parity strips to use (between 1 and 15) # # Since: 2.12 ## @@ -4580,13 +4580,13 @@ # # Driver specific image creation options for Sheepdog. # -# @location Where to store the new image file -# @size Size of the virtual disk in bytes -# @backing-file File name of a base image -# @preallocation Preallocation mode for the new image (default: off; -# allowed values: off, full) -# @redundancy Redundancy of the image -# @object-size Object size of the image +# @location: Where to store the new image file +# @size: Size of the virtual disk in bytes +# @backing-file: File name of a base image +# @preallocation: Preallocation mode for the new image (default: off; +# allowed values: off, full) +# @redundancy: Redundancy of the image +# @object-size: Object size of the image # # Since: 2.12 ## @@ -4603,8 +4603,8 @@ # # Driver specific image creation options for SSH. # -# @location Where to store the new image file -# @size Size of the virtual disk in bytes +# @location: Where to store the new image file +# @size: Size of the virtual disk in bytes # # Since: 2.12 ## @@ -4617,10 +4617,10 @@ # # Driver specific image creation options for VDI. # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @preallocation Preallocation mode for the new image (default: off; -# allowed values: off, metadata) +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @preallocation: Preallocation mode for the new image (default: off; +# allowed values: off, metadata) # # Since: 2.12 ## @@ -4645,17 +4645,17 @@ # # Driver specific image creation options for vhdx. # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @log-size Log size in bytes, must be a multiple of 1 MB -# (default: 1 MB) -# @block-size Block size in bytes, must be a multiple of 1 MB and not -# larger than 256 MB (default: automatically choose a bl= ock -# size depending on the image size) -# @subformat vhdx subformat (default: dynamic) -# @block-state-zero Force use of payload blocks of type 'ZERO'. Non-standa= rd, -# but default. Do not set to 'off' when using 'qemu-img -# convert' with subformat=3Ddynamic. +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @log-size: Log size in bytes, must be a multiple of 1 MB +# (default: 1 MB) +# @block-size: Block size in bytes, must be a multiple of 1 MB and not +# larger than 256 MB (default: automatically choose a block +# size depending on the image size) +# @subformat: vhdx subformat (default: dynamic) +# @block-state-zero: Force use of payload blocks of type 'ZERO'. Non-stand= ard, +# but default. Do not set to 'off' when using 'qemu-img +# convert' with subformat=3Ddynamic. # # Since: 2.12 ## @@ -4683,12 +4683,12 @@ # # Driver specific image creation options for vpc (VHD). # -# @file Node to create the image format on -# @size Size of the virtual disk in bytes -# @subformat vhdx subformat (default: dynamic) -# @force-size Force use of the exact byte size instead of rounding t= o the -# next size that can be represented in CHS geometry -# (default: false) +# @file: Node to create the image format on +# @size: Size of the virtual disk in bytes +# @subformat: vhdx subformat (default: dynamic) +# @force-size: Force use of the exact byte size instead of rounding to the +# next size that can be represented in CHS geometry +# (default: false) # # Since: 2.12 ## @@ -4703,7 +4703,7 @@ # # Options for creating an image format on a given node. # -# @driver block driver to create the image format +# @driver: block driver to create the image format # # Since: 2.12 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617525549680.3516505608728; Thu, 13 Feb 2020 10:12:05 -0800 (PST) Received: from localhost ([::1]:57426 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Iy2-0004Kz-Vr for importer@patchew.org; Thu, 13 Feb 2020 13:12:03 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34223) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijp-0000hm-Kw for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ije-0002jG-AO for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:20 -0500 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]:35943) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijd-0002hD-OT for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:10 -0500 Received: by mail-wm1-x341.google.com with SMTP id p17so7784414wma.1 for ; Thu, 13 Feb 2020 09:57:09 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:03 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ZVIhi6sjaiMooqScS4V4vxSRW+co0jQUvUSmDDPQriU=; b=MIBFOy/N+OxOtnzJXdPTTRBVlwRm/avLyuWrSIZZW4yLIargOP/zZQMF0QFd8jyUAx DSctKhHDXurvXxvnzfDuEq7Ls2LNobPl4vYSkQy21PIopDUaaOp3/ulgxrm5sJib7wKU ixDfqGipLXHAl3Eto9pQcjnYyWDdPX+CRW4uvaO/kN84yT5nAcfihy1FD8Ux09IS8CoD qnSs4jdSNn0ZVGPTgQnVeUwPiJwgzujI/wEUYWSJBYkSSQ3ns9s4ikhlqrChl9R44JA6 QBKnyLO99QuZdyamDjfER6hIh3ngox6RizZKfiKqYEwtqv2Ggyj/Aor2c3meK/n2BX/+ YpaQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ZVIhi6sjaiMooqScS4V4vxSRW+co0jQUvUSmDDPQriU=; b=dAzd0FeYXhGwcW6rYbBzdx7l/RwOmdJpPyP3iXaTzXNdUnr3/QOsQeuHA8FIoJYVMj RdRkSlLqiPfgjMnbDV8TVw6X67lQfTYHm3o93hfx37bVv/oL6ZajveKjiE/0NR6/iNH0 +IFk1XjjvOpPEqV9dRJ/zRBNSMQNqNQnEWXayCx0YOES8PGc5K4fUN2YCBp7vbjmXMgU ShO2vRMpLuGoIKQXp12ZsNvIGaxVXfWFnxd6HX9V7jntdiOEBBFVG7dbc9C906qM9sua aPXjfJsvNoHl7L4Dt2Qp+sarMXWUb6iXYCKHX1MBNjjygX7zymGZEybzxrXx3f4NVMpV /UIw== X-Gm-Message-State: APjAAAVPQWwZZhknW8AA2GQgs8gOzs5jSchsPXGRtfzzwaCt2ywj0ubA BfRJ2hoSAn/Epl6vuk3Rr0hgnNkSCK0= X-Google-Smtp-Source: APXvYqxXX3gCPxhS76f7RrWbm0uxhP6FhwPg31L2oxrRy5x3hJrujv/5zWzDehZkvmEv0LrwPqY6Rw== X-Received: by 2002:a05:600c:1007:: with SMTP id c7mr6901977wmc.158.1581616624359; Thu, 13 Feb 2020 09:57:04 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 09/30] qapi: Fix indent level on doc comments in json files Date: Thu, 13 Feb 2020 17:56:26 +0000 Message-Id: <20200213175647.17628-10-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::341 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The texinfo doc generation doesn't care much about indentation levels, but we would like to add a rST backend, and rST does care about indentation. Make the doc comments more strongly consistent about indentation for multiline constructs like: @arg: description line 1 description line 2 Returns: line one line 2 so that there is always exactly one space after the colon, and subsequent lines align with the first. This commit is a purely whitespace change, and it does not alter the generated .texi files (because the texi generation code strips away all the extra whitespace). This does mean that we end up with some over-length lines. Note that when the documentation for an argument fits on a single line like this: @arg: one line only then stray extra spaces after the ':' don't affect the rST output, so I have not attempted to methodically fix them, though the preference is a single space here too. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- v1->v2: re-line-wrapped commit message; new indent for 'l2tpv3' line in @Netdev doc comment as it's no longer handled by the now-deleted 'Delete all the "foo: dropped in n.n" notes' patch. --- qapi/block-core.json | 776 +++++++++++++++++++-------------------- qapi/block.json | 14 +- qapi/char.json | 8 +- qapi/dump.json | 4 +- qapi/introspect.json | 12 +- qapi/job.json | 32 +- qapi/machine-target.json | 18 +- qapi/machine.json | 12 +- qapi/migration.json | 198 +++++----- qapi/misc-target.json | 8 +- qapi/misc.json | 102 ++--- qapi/net.json | 22 +- qapi/qdev.json | 10 +- qapi/qom.json | 4 +- qapi/rocker.json | 12 +- qapi/run-state.json | 34 +- qapi/sockets.json | 8 +- qapi/trace.json | 14 +- qapi/transaction.json | 4 +- qapi/ui.json | 36 +- 20 files changed, 664 insertions(+), 664 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index c617bc2af63..c62b7db2814 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -162,7 +162,7 @@ # @backing-image: info of the backing image (since 1.6) # # @format-specific: structure supplying additional format-specific -# information (since 1.7) +# information (since 1.7) # # Since: 1.3 # @@ -708,7 +708,7 @@ # Get a list of BlockInfo for all virtual block devices. # # Returns: a list of @BlockInfo describing each virtual block device. Filt= er -# nodes that were created implicitly are skipped over. +# nodes that were created implicitly are skipped over. # # Since: 0.14.0 # @@ -1352,8 +1352,8 @@ # @existing: QEMU should look for an existing image file. # # @absolute-paths: QEMU should create a new image with absolute paths -# for the backing file. If there is no backing file available, the new -# image will not be backed either. +# for the backing file. If there is no backing file avail= able, the new +# image will not be backed either. # # Since: 1.1 ## @@ -1370,8 +1370,8 @@ # @node-name: graph node name to generate the snapshot from (Since 2.0) # # @snapshot-file: the target of the new overlay image. If the file -# exists, or if it is a device, the overlay will be created in the -# existing file/device. Otherwise, a new file will be created. +# exists, or if it is a device, the overlay will be create= d in the +# existing file/device. Otherwise, a new file will be crea= ted. # # @snapshot-node-name: the graph node name of the new image (Since 2.0) # @@ -1456,8 +1456,8 @@ # a node name is autogenerated. (Since: 4.2) # # Note: @on-source-error and @on-target-error only affect background -# I/O. If an error occurs during a guest write request, the device's -# rerror/werror actions will be used. +# I/O. If an error occurs during a guest write request, the device's +# rerror/werror actions will be used. # # Since: 4.2 ## @@ -1578,13 +1578,13 @@ # to verify "image-node-name" is in the chain # described by "device". # -# @device: The device name or node-name of the root node that owns -# image-node-name. +# @device: The device name or node-name of the root node that owns +# image-node-name. # -# @backing-file: The string to write as the backing file. This -# string is not validated, so care should be taken -# when specifying the string or the image chain may -# not be able to be reopened again. +# @backing-file: The string to write as the backing file. This +# string is not validated, so care should be taken +# when specifying the string or the image chain may +# not be able to be reopened again. # # Returns: Nothing on success # @@ -1605,7 +1605,7 @@ # @job-id: identifier for the newly-created block job. If # omitted, the device name will be used. (Since 2.7) # -# @device: the device name or node-name of a root node +# @device: the device name or node-name of a root node # # @base-node: The node name of the backing image to write data into. # If not specified, this is the deepest backing image. @@ -1625,36 +1625,36 @@ # node; other strings, even if addressing the same file, are not # accepted (deprecated, use @base-node instead) # -# @backing-file: The backing file string to write into the overlay -# image of 'top'. If 'top' is the active layer, -# specifying a backing file string is an error. = This -# filename is not validated. +# @backing-file: The backing file string to write into the overlay +# image of 'top'. If 'top' is the active layer, +# specifying a backing file string is an error. This +# filename is not validated. # -# If a pathname string is such that it cannot be -# resolved by QEMU, that means that subsequent Q= MP or -# HMP commands must use node-names for the image= in -# question, as filename lookup methods will fail. +# If a pathname string is such that it cannot be +# resolved by QEMU, that means that subsequent QMP or +# HMP commands must use node-names for the image in +# question, as filename lookup methods will fail. # -# If not specified, QEMU will automatically dete= rmine -# the backing file string to use, or error out if -# there is no obvious choice. Care should be tak= en -# when specifying the string, to specify a valid -# filename or protocol. -# (Since 2.1) +# If not specified, QEMU will automatically determine +# the backing file string to use, or error out if +# there is no obvious choice. Care should be taken +# when specifying the string, to specify a valid +# filename or protocol. +# (Since 2.1) # -# If top =3D=3D base, that is an error. -# If top =3D=3D active, the job will not be completed b= y itself, -# user needs to complete the job with the block-job-com= plete -# command after getting the ready event. (Since 2.0) +# If top =3D=3D base, that is an error. +# If top =3D=3D active, the job will not be completed by it= self, +# user needs to complete the job with the block-job-complete +# command after getting the ready event. (Since 2.0) # -# If the base image is smaller than top, then the base = image -# will be resized to be the same size as top. If top is -# smaller than the base image, the base will not be -# truncated. If you want the base image size to match = the -# size of the smaller top, you can safely truncate it -# yourself once the commit operation successfully compl= etes. +# If the base image is smaller than top, then the base image +# will be resized to be the same size as top. If top is +# smaller than the base image, the base will not be +# truncated. If you want the base image size to match the +# size of the smaller top, you can safely truncate it +# yourself once the commit operation successfully completes. # -# @speed: the maximum speed, in bytes per second +# @speed: the maximum speed, in bytes per second # # @filter-node-name: the node name that should be assigned to the # filter driver that the commit job inserts into the gr= aph @@ -2439,52 +2439,52 @@ # @iops_wr: write I/O operations per second # # @bps_max: total throughput limit during bursts, -# in bytes (Since 1.7) +# in bytes (Since 1.7) # # @bps_rd_max: read throughput limit during bursts, -# in bytes (Since 1.7) +# in bytes (Since 1.7) # # @bps_wr_max: write throughput limit during bursts, -# in bytes (Since 1.7) +# in bytes (Since 1.7) # # @iops_max: total I/O operations per second during bursts, -# in bytes (Since 1.7) +# in bytes (Since 1.7) # # @iops_rd_max: read I/O operations per second during bursts, -# in bytes (Since 1.7) +# in bytes (Since 1.7) # # @iops_wr_max: write I/O operations per second during bursts, -# in bytes (Since 1.7) +# in bytes (Since 1.7) # # @bps_max_length: maximum length of the @bps_max burst -# period, in seconds. It must only -# be set if @bps_max is set as well. -# Defaults to 1. (Since 2.6) +# period, in seconds. It must only +# be set if @bps_max is set as well. +# Defaults to 1. (Since 2.6) # # @bps_rd_max_length: maximum length of the @bps_rd_max -# burst period, in seconds. It must only -# be set if @bps_rd_max is set as well. -# Defaults to 1. (Since 2.6) +# burst period, in seconds. It must only +# be set if @bps_rd_max is set as well. +# Defaults to 1. (Since 2.6) # # @bps_wr_max_length: maximum length of the @bps_wr_max -# burst period, in seconds. It must only -# be set if @bps_wr_max is set as well. -# Defaults to 1. (Since 2.6) +# burst period, in seconds. It must only +# be set if @bps_wr_max is set as well. +# Defaults to 1. (Since 2.6) # # @iops_max_length: maximum length of the @iops burst -# period, in seconds. It must only -# be set if @iops_max is set as well. -# Defaults to 1. (Since 2.6) +# period, in seconds. It must only +# be set if @iops_max is set as well. +# Defaults to 1. (Since 2.6) # # @iops_rd_max_length: maximum length of the @iops_rd_max -# burst period, in seconds. It must only -# be set if @iops_rd_max is set as well. -# Defaults to 1. (Since 2.6) +# burst period, in seconds. It must only +# be set if @iops_rd_max is set as well. +# Defaults to 1. (Since 2.6) # # @iops_wr_max_length: maximum length of the @iops_wr_max -# burst period, in seconds. It must only -# be set if @iops_wr_max is set as well. -# Defaults to 1. (Since 2.6) +# burst period, in seconds. It must only +# be set if @iops_wr_max is set as well. +# Defaults to 1. (Since 2.6) # # @iops_size: an I/O size in bytes (Since 1.7) # @@ -2511,31 +2511,31 @@ # transaction. All fields are optional. When setting limits, if a field is # missing the current value is not changed. # -# @iops-total: limit total I/O operations per second -# @iops-total-max: I/O operations burst -# @iops-total-max-length: length of the iops-total-max burst period, in s= econds -# It must only be set if @iops-total-max is set a= s well. -# @iops-read: limit read operations per second -# @iops-read-max: I/O operations read burst -# @iops-read-max-length: length of the iops-read-max burst period, in se= conds -# It must only be set if @iops-read-max is set as= well. -# @iops-write: limit write operations per second -# @iops-write-max: I/O operations write burst -# @iops-write-max-length: length of the iops-write-max burst period, in s= econds -# It must only be set if @iops-write-max is set a= s well. -# @bps-total: limit total bytes per second -# @bps-total-max: total bytes burst -# @bps-total-max-length: length of the bps-total-max burst period, in se= conds. -# It must only be set if @bps-total-max is set as= well. -# @bps-read: limit read bytes per second -# @bps-read-max: total bytes read burst -# @bps-read-max-length: length of the bps-read-max burst period, in sec= onds -# It must only be set if @bps-read-max is set as = well. -# @bps-write: limit write bytes per second -# @bps-write-max: total bytes write burst -# @bps-write-max-length: length of the bps-write-max burst period, in se= conds -# It must only be set if @bps-write-max is set as= well. -# @iops-size: when limiting by iops max size of an I/O in byt= es +# @iops-total: limit total I/O operations per second +# @iops-total-max: I/O operations burst +# @iops-total-max-length: length of the iops-total-max burst period, in se= conds +# It must only be set if @iops-total-max is set as= well. +# @iops-read: limit read operations per second +# @iops-read-max: I/O operations read burst +# @iops-read-max-length: length of the iops-read-max burst period, in seco= nds +# It must only be set if @iops-read-max is set as w= ell. +# @iops-write: limit write operations per second +# @iops-write-max: I/O operations write burst +# @iops-write-max-length: length of the iops-write-max burst period, in se= conds +# It must only be set if @iops-write-max is set as= well. +# @bps-total: limit total bytes per second +# @bps-total-max: total bytes burst +# @bps-total-max-length: length of the bps-total-max burst period, in seco= nds. +# It must only be set if @bps-total-max is set as w= ell. +# @bps-read: limit read bytes per second +# @bps-read-max: total bytes read burst +# @bps-read-max-length: length of the bps-read-max burst period, in seconds +# It must only be set if @bps-read-max is set as wel= l. +# @bps-write: limit write bytes per second +# @bps-write-max: total bytes write burst +# @bps-write-max-length: length of the bps-write-max burst period, in seco= nds +# It must only be set if @bps-write-max is set as w= ell. +# @iops-size: when limiting by iops max size of an I/O in bytes # # Since: 2.11 ## @@ -2582,28 +2582,28 @@ # # @device: the device or node name of the top image # -# @base: the common backing file name. -# It cannot be set if @base-node is also set. +# @base: the common backing file name. +# It cannot be set if @base-node is also set. # # @base-node: the node name of the backing file. -# It cannot be set if @base is also set. (Since 2.8) +# It cannot be set if @base is also set. (Since 2.8) # # @backing-file: The backing file string to write into the top -# image. This filename is not validated. +# image. This filename is not validated. # -# If a pathname string is such that it cannot be -# resolved by QEMU, that means that subsequent QM= P or -# HMP commands must use node-names for the image = in -# question, as filename lookup methods will fail. +# If a pathname string is such that it cannot be +# resolved by QEMU, that means that subsequent QMP or +# HMP commands must use node-names for the image in +# question, as filename lookup methods will fail. # -# If not specified, QEMU will automatically deter= mine -# the backing file string to use, or error out if= there -# is no obvious choice. Care should be taken when -# specifying the string, to specify a valid filen= ame or -# protocol. -# (Since 2.1) +# If not specified, QEMU will automatically determine +# the backing file string to use, or error out if there +# is no obvious choice. Care should be taken when +# specifying the string, to specify a valid filename or +# protocol. +# (Since 2.1) # -# @speed: the maximum speed, in bytes per second +# @speed: the maximum speed, in bytes per second # # @on-error: the action to take on an error (default report). # 'stop' and 'enospc' can only be used if the block device @@ -2653,8 +2653,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# @speed: the maximum speed, in bytes per second, or 0 for unlimited. -# Defaults to 0. +# @speed: the maximum speed, in bytes per second, or 0 for unlimited. +# Defaults to 0. # # Returns: Nothing on success # If no background operation is active on this device, DeviceNotA= ctive @@ -2820,8 +2820,8 @@ # # Determines how to handle discard requests. # -# @ignore: Ignore the request -# @unmap: Forward as an unmap request +# @ignore: Ignore the request +# @unmap: Forward as an unmap request # # Since: 2.9 ## @@ -2834,10 +2834,10 @@ # Describes the operation mode for the automatic conversion of plain # zero writes by the OS to driver specific optimized zero write commands. # -# @off: Disabled (default) -# @on: Enabled -# @unmap: Enabled and even try to unmap blocks if possible. This requir= es -# also that @BlockdevDiscardOptions is set to unmap for this de= vice. +# @off: Disabled (default) +# @on: Enabled +# @unmap: Enabled and even try to unmap blocks if possible. This requires +# also that @BlockdevDiscardOptions is set to unmap for this devic= e. # # Since: 2.1 ## @@ -2849,9 +2849,9 @@ # # Selects the AIO backend to handle I/O requests # -# @threads: Use qemu's thread pool -# @native: Use native AIO backend (only Linux and Windows) -# @io_uring: Use linux io_uring (since 5.0) +# @threads: Use qemu's thread pool +# @native: Use native AIO backend (only Linux and Windows) +# @io_uring: Use linux io_uring (since 5.0) # # Since: 2.9 ## @@ -2864,10 +2864,10 @@ # # Includes cache-related options for block devices # -# @direct: enables use of O_DIRECT (bypass the host page cache; -# default: false) -# @no-flush: ignore any flush requests for the device (default: -# false) +# @direct: enables use of O_DIRECT (bypass the host page cache; +# default: false) +# @no-flush: ignore any flush requests for the device (default: +# false) # # Since: 2.9 ## @@ -2905,18 +2905,18 @@ # # Driver specific block device options for the file backend. # -# @filename: path to the image file -# @pr-manager: the id for the object that will handle persistent reservat= ions -# for this device (default: none, forward the commands via S= G_IO; -# since 2.11) -# @aio: AIO backend (default: threads) (since: 2.8) -# @locking: whether to enable file locking. If set to 'auto', only ena= ble -# when Open File Descriptor (OFD) locking API is available -# (default: auto, since 2.10) -# @drop-cache: invalidate page cache during live migration. This prevents -# stale data on the migration destination with cache.direct= =3Doff. -# Currently only supported on Linux hosts. -# (default: on, since: 4.0) +# @filename: path to the image file +# @pr-manager: the id for the object that will handle persistent reservati= ons +# for this device (default: none, forward the commands via SG= _IO; +# since 2.11) +# @aio: AIO backend (default: threads) (since: 2.8) +# @locking: whether to enable file locking. If set to 'auto', only enable +# when Open File Descriptor (OFD) locking API is available +# (default: auto, since 2.10) +# @drop-cache: invalidate page cache during live migration. This prevents +# stale data on the migration destination with cache.direct= =3Doff. +# Currently only supported on Linux hosts. +# (default: on, since: 4.0) # @x-check-cache-dropped: whether to check that page cache was dropped on = live # migration. May cause noticeable delays if the i= mage # file is large, do not use in production. @@ -2949,7 +2949,7 @@ # # Driver specific block device options for the null backend. # -# @size: size of the device in bytes. +# @size: size of the device in bytes. # @latency-ns: emulated latency (in nanoseconds) in processing # requests. Default to zero which completes requests immediat= ely. # (Since 2.4) @@ -2966,8 +2966,8 @@ # # Driver specific block device options for the NVMe backend. # -# @device: PCI controller address of the NVMe device in -# format hhhh:bb:ss.f (host:bus:slot.function) +# @device: PCI controller address of the NVMe device in +# format hhhh:bb:ss.f (host:bus:slot.function) # @namespace: namespace number of the device, starting from 1. # # Note that the PCI @device must have been unbound from any host @@ -2983,15 +2983,15 @@ # # Driver specific block device options for the vvfat protocol. # -# @dir: directory to be exported as FAT image -# @fat-type: FAT type: 12, 16 or 32 -# @floppy: whether to export a floppy image (true) or -# partitioned hard disk (false; default) -# @label: set the volume label, limited to 11 bytes. FAT16 and -# FAT32 traditionally have some restrictions on labels, whic= h are -# ignored by most operating systems. Defaults to "QEMU VVFAT= ". -# (since 2.4) -# @rw: whether to allow write operations (default: false) +# @dir: directory to be exported as FAT image +# @fat-type: FAT type: 12, 16 or 32 +# @floppy: whether to export a floppy image (true) or +# partitioned hard disk (false; default) +# @label: set the volume label, limited to 11 bytes. FAT16 and +# FAT32 traditionally have some restrictions on labels, which are +# ignored by most operating systems. Defaults to "QEMU VVFAT". +# (since 2.4) +# @rw: whether to allow write operations (default: false) # # Since: 2.9 ## @@ -3005,7 +3005,7 @@ # Driver specific block device options for image format that have no option # besides their data source. # -# @file: reference to or definition of the data source block device +# @file: reference to or definition of the data source block device # # Since: 2.9 ## @@ -3034,9 +3034,9 @@ # Driver specific block device options for image format that have no option # besides their data source and an optional backing file. # -# @backing: reference to or definition of the backing file block -# device, null disables the backing file entirely. -# Defaults to the backing file stored the image file. +# @backing: reference to or definition of the backing file block +# device, null disables the backing file entirely. +# Defaults to the backing file stored the image file. # # Since: 2.9 ## @@ -3049,15 +3049,15 @@ # # General overlap check modes. # -# @none: Do not perform any checks +# @none: Do not perform any checks # -# @constant: Perform only checks which can be done in constant time and -# without reading anything from disk +# @constant: Perform only checks which can be done in constant time and +# without reading anything from disk # -# @cached: Perform only checks which can be done without reading anyt= hing -# from disk +# @cached: Perform only checks which can be done without reading anything +# from disk # -# @all: Perform all available overlap checks +# @all: Perform all available overlap checks # # Since: 2.9 ## @@ -3096,10 +3096,10 @@ # Specifies which metadata structures should be guarded against unintended # overwriting. # -# @flags: set of flags for separate specification of each metadata struc= ture -# type +# @flags: set of flags for separate specification of each metadata structu= re +# type # -# @mode: named mode which chooses a specific set of flags +# @mode: named mode which chooses a specific set of flags # # Since: 2.9 ## @@ -3132,9 +3132,9 @@ # # Driver specific block device options for qcow. # -# @encrypt: Image decryption options. Mandatory for -# encrypted images, except when doing a metadata-o= nly -# probe of the image. +# @encrypt: Image decryption options. Mandatory for +# encrypted images, except when doing a metadata-only +# probe of the image. # # Since: 2.10 ## @@ -3169,51 +3169,51 @@ # # Driver specific block device options for qcow2. # -# @lazy-refcounts: whether to enable the lazy refcounts -# feature (default is taken from the image file) +# @lazy-refcounts: whether to enable the lazy refcounts +# feature (default is taken from the image file) # -# @pass-discard-request: whether discard requests to the qcow2 -# device should be forwarded to the data source +# @pass-discard-request: whether discard requests to the qcow2 +# device should be forwarded to the data source # # @pass-discard-snapshot: whether discard requests for the data source # should be issued when a snapshot operation (e.g. # deleting a snapshot) frees clusters in the qcow2= file # -# @pass-discard-other: whether discard requests for the data source -# should be issued on other occasions where a clus= ter -# gets freed +# @pass-discard-other: whether discard requests for the data source +# should be issued on other occasions where a cluster +# gets freed # -# @overlap-check: which overlap checks to perform for writes -# to the image, defaults to 'cached' (since 2.2) +# @overlap-check: which overlap checks to perform for writes +# to the image, defaults to 'cached' (since 2.2) # -# @cache-size: the maximum total size of the L2 table and -# refcount block caches in bytes (since 2.2) +# @cache-size: the maximum total size of the L2 table and +# refcount block caches in bytes (since 2.2) # -# @l2-cache-size: the maximum size of the L2 table cache in -# bytes (since 2.2) +# @l2-cache-size: the maximum size of the L2 table cache in +# bytes (since 2.2) # -# @l2-cache-entry-size: the size of each entry in the L2 cache in -# bytes. It must be a power of two between 512 -# and the cluster size. The default value is -# the cluster size (since 2.12) +# @l2-cache-entry-size: the size of each entry in the L2 cache in +# bytes. It must be a power of two between 512 +# and the cluster size. The default value is +# the cluster size (since 2.12) # -# @refcount-cache-size: the maximum size of the refcount block cache -# in bytes (since 2.2) +# @refcount-cache-size: the maximum size of the refcount block cache +# in bytes (since 2.2) # -# @cache-clean-interval: clean unused entries in the L2 and refcount -# caches. The interval is in seconds. The default = value -# is 600 on supporting platforms, and 0 on other -# platforms. 0 disables this feature. (since 2.5) +# @cache-clean-interval: clean unused entries in the L2 and refcount +# caches. The interval is in seconds. The default v= alue +# is 600 on supporting platforms, and 0 on other +# platforms. 0 disables this feature. (since 2.5) # -# @encrypt: Image decryption options. Mandatory for -# encrypted images, except when doing a metadata-o= nly -# probe of the image. (since 2.10) +# @encrypt: Image decryption options. Mandatory for +# encrypted images, except when doing a metadata-only +# probe of the image. (since 2.10) # -# @data-file: reference to or definition of the external data = file. -# This may only be specified for images that requi= re an -# external data file. If it is not specified for s= uch -# an image, the data file name is loaded from the = image -# file. (since 4.0) +# @data-file: reference to or definition of the external data file. +# This may only be specified for images that require an +# external data file. If it is not specified for such +# an image, the data file name is loaded from the image +# file. (since 4.0) # # Since: 2.9 ## @@ -3304,8 +3304,8 @@ # # Trigger events supported by blkdebug. # -# @l1_shrink_write_table: write zeros to the l1 table to shrink image. -# (since 2.11) +# @l1_shrink_write_table: write zeros to the l1 table to shrink image. +# (since 2.11) # # @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11) # @@ -3363,25 +3363,25 @@ # # Describes a single error injection for blkdebug. # -# @event: trigger event +# @event: trigger event # -# @state: the state identifier blkdebug needs to be in to -# actually trigger the event; defaults to "any" +# @state: the state identifier blkdebug needs to be in to +# actually trigger the event; defaults to "any" # -# @iotype: the type of I/O operations on which this error should -# be injected; defaults to "all read, write, -# write-zeroes, discard, and flush operations" -# (since: 4.1) +# @iotype: the type of I/O operations on which this error should +# be injected; defaults to "all read, write, +# write-zeroes, discard, and flush operations" +# (since: 4.1) # -# @errno: error identifier (errno) to be returned; defaults to -# EIO +# @errno: error identifier (errno) to be returned; defaults to +# EIO # -# @sector: specifies the sector index which has to be affected -# in order to actually trigger the event; defaults to "any -# sector" +# @sector: specifies the sector index which has to be affected +# in order to actually trigger the event; defaults to "any +# sector" # -# @once: disables further events after this one has been -# triggered; defaults to false +# @once: disables further events after this one has been +# triggered; defaults to false # # @immediately: fail immediately; defaults to false # @@ -3401,13 +3401,13 @@ # # Describes a single state-change event for blkdebug. # -# @event: trigger event +# @event: trigger event # -# @state: the current state identifier blkdebug needs to be in; -# defaults to "any" +# @state: the current state identifier blkdebug needs to be in; +# defaults to "any" # -# @new_state: the state identifier blkdebug is supposed to assume if -# this event is triggered +# @new_state: the state identifier blkdebug is supposed to assume if +# this event is triggered # # Since: 2.9 ## @@ -3421,41 +3421,41 @@ # # Driver specific block device options for blkdebug. # -# @image: underlying raw block device (or image file) +# @image: underlying raw block device (or image file) # -# @config: filename of the configuration file +# @config: filename of the configuration file # -# @align: required alignment for requests in bytes, must be -# positive power of 2, or 0 for default +# @align: required alignment for requests in bytes, must be +# positive power of 2, or 0 for default # -# @max-transfer: maximum size for I/O transfers in bytes, must be -# positive multiple of @align and of the underlying -# file's request alignment (but need not be a power of -# 2), or 0 for default (since 2.10) +# @max-transfer: maximum size for I/O transfers in bytes, must be +# positive multiple of @align and of the underlying +# file's request alignment (but need not be a power of +# 2), or 0 for default (since 2.10) # -# @opt-write-zero: preferred alignment for write zero requests in bytes, -# must be positive multiple of @align and of the -# underlying file's request alignment (but need not be a -# power of 2), or 0 for default (since 2.10) +# @opt-write-zero: preferred alignment for write zero requests in bytes, +# must be positive multiple of @align and of the +# underlying file's request alignment (but need not be a +# power of 2), or 0 for default (since 2.10) # -# @max-write-zero: maximum size for write zero requests in bytes, must be -# positive multiple of @align, of @opt-write-zero, and of -# the underlying file's request alignment (but need not -# be a power of 2), or 0 for default (since 2.10) +# @max-write-zero: maximum size for write zero requests in bytes, must be +# positive multiple of @align, of @opt-write-zero, and of +# the underlying file's request alignment (but need not +# be a power of 2), or 0 for default (since 2.10) # -# @opt-discard: preferred alignment for discard requests in bytes, must -# be positive multiple of @align and of the underlying -# file's request alignment (but need not be a power of -# 2), or 0 for default (since 2.10) +# @opt-discard: preferred alignment for discard requests in bytes, must +# be positive multiple of @align and of the underlying +# file's request alignment (but need not be a power of +# 2), or 0 for default (since 2.10) # -# @max-discard: maximum size for discard requests in bytes, must be -# positive multiple of @align, of @opt-discard, and of -# the underlying file's request alignment (but need not -# be a power of 2), or 0 for default (since 2.10) +# @max-discard: maximum size for discard requests in bytes, must be +# positive multiple of @align, of @opt-discard, and of +# the underlying file's request alignment (but need not +# be a power of 2), or 0 for default (since 2.10) # -# @inject-error: array of error injection descriptions +# @inject-error: array of error injection descriptions # -# @set-state: array of state-change descriptions +# @set-state: array of state-change descriptions # # @take-child-perms: Permissions to take on @image in addition to what # is necessary anyway (which depends on how the @@ -3485,14 +3485,14 @@ # # Driver specific block device options for blklogwrites. # -# @file: block device +# @file: block device # -# @log: block device used to log writes to @file +# @log: block device used to log writes to @file # # @log-sector-size: sector size used in logging writes to @file, determines # granularity of offsets and sizes of writes (default: 5= 12) # -# @log-append: append to an existing log (default: false) +# @log-append: append to an existing log (default: false) # # @log-super-update-interval: interval of write requests after which the l= og # super block is updated to disk (default: 409= 6) @@ -3511,9 +3511,9 @@ # # Driver specific block device options for blkverify. # -# @test: block device to be tested +# @test: block device to be tested # -# @raw: raw image used for verification +# @raw: raw image used for verification # # Since: 2.9 ## @@ -3526,7 +3526,7 @@ # # Driver specific block device options for blkreplay. # -# @image: disk image which should be controlled with blkreplay +# @image: disk image which should be controlled with blkreplay # # Since: 4.2 ## @@ -3551,10 +3551,10 @@ # # Driver specific block device options for Quorum # -# @blkverify: true if the driver must print content mismatch +# @blkverify: true if the driver must print content mismatch # set to false by default # -# @children: the children block devices to use +# @children: the children block devices to use # # @vote-threshold: the vote limit under which a read will fail # @@ -3578,16 +3578,16 @@ # # Driver specific block device options for Gluster # -# @volume: name of gluster volume where VM image resides +# @volume: name of gluster volume where VM image resides # -# @path: absolute path to image file in gluster volume +# @path: absolute path to image file in gluster volume # -# @server: gluster servers description +# @server: gluster servers description # -# @debug: libgfapi log level (default '4' which is Error) -# (Since 2.8) +# @debug: libgfapi log level (default '4' which is Error) +# (Since 2.8) # -# @logfile: libgfapi log file (default /dev/stderr) (Since 2.8) +# @logfile: libgfapi log file (default /dev/stderr) (Since 2.8) # # Since: 2.9 ## @@ -3622,30 +3622,30 @@ ## # @BlockdevOptionsIscsi: # -# @transport: The iscsi transport type +# @transport: The iscsi transport type # -# @portal: The address of the iscsi portal +# @portal: The address of the iscsi portal # -# @target: The target iqn name +# @target: The target iqn name # -# @lun: LUN to connect to. Defaults to 0. +# @lun: LUN to connect to. Defaults to 0. # -# @user: User name to log in with. If omitted, no CHAP -# authentication is performed. +# @user: User name to log in with. If omitted, no CHAP +# authentication is performed. # # @password-secret: The ID of a QCryptoSecret object providing # the password for the login. This option is required if # @user is specified. # -# @initiator-name: The iqn name we want to identify to the target -# as. If this option is not specified, an initiator name= is -# generated automatically. +# @initiator-name: The iqn name we want to identify to the target +# as. If this option is not specified, an initiator name = is +# generated automatically. # -# @header-digest: The desired header digest. Defaults to -# none-crc32c. +# @header-digest: The desired header digest. Defaults to +# none-crc32c. # -# @timeout: Timeout in seconds after which a request will -# timeout. 0 means no timeout and is the default. +# @timeout: Timeout in seconds after which a request will +# timeout. 0 means no timeout and is the default. # # Driver specific block device options for iscsi # @@ -3674,29 +3674,29 @@ ## # @BlockdevOptionsRbd: # -# @pool: Ceph pool name. +# @pool: Ceph pool name. # -# @image: Image name in the Ceph pool. +# @image: Image name in the Ceph pool. # -# @conf: path to Ceph configuration file. Values -# in the configuration file will be overridden by -# options specified via QAPI. +# @conf: path to Ceph configuration file. Values +# in the configuration file will be overridden by +# options specified via QAPI. # -# @snapshot: Ceph snapshot name. +# @snapshot: Ceph snapshot name. # -# @user: Ceph id name. +# @user: Ceph id name. # # @auth-client-required: Acceptable authentication modes. -# This maps to Ceph configuration option -# "auth_client_required". (Since 3.0) +# This maps to Ceph configuration option +# "auth_client_required". (Since 3.0) # -# @key-secret: ID of a QCryptoSecret object providing a key -# for cephx authentication. -# This maps to Ceph configuration option -# "key". (Since 3.0) +# @key-secret: ID of a QCryptoSecret object providing a key +# for cephx authentication. +# This maps to Ceph configuration option +# "key". (Since 3.0) # -# @server: Monitor host address and port. This maps -# to the "mon_host" Ceph option. +# @server: Monitor host address and port. This maps +# to the "mon_host" Ceph option. # # Since: 2.9 ## @@ -3715,10 +3715,10 @@ # # Driver specific block device options for sheepdog # -# @vdi: Virtual disk image name -# @server: The Sheepdog server to connect to -# @snap-id: Snapshot ID -# @tag: Snapshot tag name +# @vdi: Virtual disk image name +# @server: The Sheepdog server to connect to +# @snap-id: Snapshot ID +# @tag: Snapshot tag name # # Only one of @snap-id and @tag may be present. # @@ -3768,7 +3768,7 @@ # # An enumeration of NFS transport types # -# @inet: TCP transport +# @inet: TCP transport # # Since: 2.9 ## @@ -3780,9 +3780,9 @@ # # Captures the address of the socket # -# @type: transport type used for NFS (only TCP supported) +# @type: transport type used for NFS (only TCP supported) # -# @host: host address for NFS server +# @host: host address for NFS server # # Since: 2.9 ## @@ -3795,29 +3795,29 @@ # # Driver specific block device option for NFS # -# @server: host address +# @server: host address # -# @path: path of the image on the host +# @path: path of the image on the host # -# @user: UID value to use when talking to the -# server (defaults to 65534 on Windows and getui= d() -# on unix) +# @user: UID value to use when talking to the +# server (defaults to 65534 on Windows and getuid() +# on unix) # -# @group: GID value to use when talking to the -# server (defaults to 65534 on Windows and getgi= d() -# in unix) +# @group: GID value to use when talking to the +# server (defaults to 65534 on Windows and getgid() +# in unix) # -# @tcp-syn-count: number of SYNs during the session -# establishment (defaults to libnfs default) +# @tcp-syn-count: number of SYNs during the session +# establishment (defaults to libnfs default) # -# @readahead-size: set the readahead size in bytes (defaults -# to libnfs default) +# @readahead-size: set the readahead size in bytes (defaults +# to libnfs default) # -# @page-cache-size: set the pagecache size in bytes (defaults -# to libnfs default) +# @page-cache-size: set the pagecache size in bytes (defaults +# to libnfs default) # -# @debug: set the NFS debug level (max 2) (defaults -# to libnfs default) +# @debug: set the NFS debug level (max 2) (defaults +# to libnfs default) # # Since: 2.9 ## @@ -3837,22 +3837,22 @@ # Driver specific block device options shared by all protocols supported b= y the # curl backend. # -# @url: URL of the image file +# @url: URL of the image file # -# @readahead: Size of the read-ahead cache; must be a multip= le of -# 512 (defaults to 256 kB) +# @readahead: Size of the read-ahead cache; must be a multiple of +# 512 (defaults to 256 kB) # -# @timeout: Timeout for connections, in seconds (defaults = to 5) +# @timeout: Timeout for connections, in seconds (defaults to 5) # -# @username: Username for authentication (defaults to none) +# @username: Username for authentication (defaults to none) # -# @password-secret: ID of a QCryptoSecret object providing a passw= ord -# for authentication (defaults to no password) +# @password-secret: ID of a QCryptoSecret object providing a password +# for authentication (defaults to no password) # -# @proxy-username: Username for proxy authentication (defaults to= none) +# @proxy-username: Username for proxy authentication (defaults to none) # -# @proxy-password-secret: ID of a QCryptoSecret object providing a passw= ord -# for proxy authentication (defaults to no passw= ord) +# @proxy-password-secret: ID of a QCryptoSecret object providing a password +# for proxy authentication (defaults to no passwor= d) # # Since: 2.9 ## @@ -3871,9 +3871,9 @@ # Driver specific block device options for HTTP connections over the curl # backend. URLs must start with "http://". # -# @cookie: List of cookies to set; format is -# "name1=3Dcontent1; name2=3Dcontent2;" as explained by -# CURLOPT_COOKIE(3). Defaults to no cookies. +# @cookie: List of cookies to set; format is +# "name1=3Dcontent1; name2=3Dcontent2;" as explained by +# CURLOPT_COOKIE(3). Defaults to no cookies. # # @cookie-secret: ID of a QCryptoSecret object providing the cookie data i= n a # secure way. See @cookie for the format. (since 2.10) @@ -3891,12 +3891,12 @@ # Driver specific block device options for HTTPS connections over the curl # backend. URLs must start with "https://". # -# @cookie: List of cookies to set; format is -# "name1=3Dcontent1; name2=3Dcontent2;" as explained by -# CURLOPT_COOKIE(3). Defaults to no cookies. +# @cookie: List of cookies to set; format is +# "name1=3Dcontent1; name2=3Dcontent2;" as explained by +# CURLOPT_COOKIE(3). Defaults to no cookies. # -# @sslverify: Whether to verify the SSL certificate's validity (defaults= to -# true) +# @sslverify: Whether to verify the SSL certificate's validity (defaults to +# true) # # @cookie-secret: ID of a QCryptoSecret object providing the cookie data i= n a # secure way. See @cookie for the format. (since 2.10) @@ -3927,8 +3927,8 @@ # Driver specific block device options for FTPS connections over the curl # backend. URLs must start with "ftps://". # -# @sslverify: Whether to verify the SSL certificate's validity (defaults= to -# true) +# @sslverify: Whether to verify the SSL certificate's validity (defaults to +# true) # # Since: 2.9 ## @@ -3941,11 +3941,11 @@ # # Driver specific block device options for NBD. # -# @server: NBD server address +# @server: NBD server address # -# @export: export name +# @export: export name # -# @tls-creds: TLS credentials ID +# @tls-creds: TLS credentials ID # # @x-dirty-bitmap: A "qemu:dirty-bitmap:NAME" string to query in place of # traditional "base:allocation" block status (see @@ -3973,8 +3973,8 @@ # # Driver specific block device options for the raw driver. # -# @offset: position where the block device starts -# @size: the assumed size of the device +# @offset: position where the block device starts +# @size: the assumed size of the device # # Since: 2.9 ## @@ -3987,9 +3987,9 @@ # # Driver specific block device options for VxHS # -# @vdisk-id: UUID of VxHS volume -# @server: vxhs server IP, port -# @tls-creds: TLS credentials ID +# @vdisk-id: UUID of VxHS volume +# @server: vxhs server IP, port +# @tls-creds: TLS credentials ID # # Since: 2.10 ## @@ -4003,9 +4003,9 @@ # # Driver specific block device options for the throttle driver # -# @throttle-group: the name of the throttle-group object to use. It -# must already exist. -# @file: reference to or definition of the data source block d= evice +# @throttle-group: the name of the throttle-group object to use. It +# must already exist. +# @file: reference to or definition of the data source block device # Since: 2.11 ## { 'struct': 'BlockdevOptionsThrottle', @@ -4018,19 +4018,19 @@ # Options for creating a block device. Many options are available for all # block devices, independent of the block driver: # -# @driver: block driver name -# @node-name: the node name of the new node (Since 2.0). -# This option is required on the top level of blockdev-add. -# Valid node names start with an alphabetic character and = may -# contain only alphanumeric characters, '-', '.' and '_'. = Their -# maximum length is 31 characters. -# @discard: discard-related options (default: ignore) -# @cache: cache-related options -# @read-only: whether the block device should be read-only (default: f= alse). -# Note that some block drivers support only read-only acce= ss, -# either generally or in certain configurations. In this c= ase, -# the default value does not work and the option must be -# specified explicitly. +# @driver: block driver name +# @node-name: the node name of the new node (Since 2.0). +# This option is required on the top level of blockdev-add. +# Valid node names start with an alphabetic character and may +# contain only alphanumeric characters, '-', '.' and '_'. Their +# maximum length is 31 characters. +# @discard: discard-related options (default: ignore) +# @cache: cache-related options +# @read-only: whether the block device should be read-only (default: false= ). +# Note that some block drivers support only read-only access, +# either generally or in certain configurations. In this case, +# the default value does not work and the option must be +# specified explicitly. # @auto-read-only: if true and @read-only is false, QEMU may automatically # decide not to open the image read-write as requested, b= ut # fall back to read-only instead (and switch between the = modes @@ -4039,8 +4039,8 @@ # (default: false, since 3.1) # @detect-zeroes: detect and optimize zero writes (Since 2.1) # (default: off) -# @force-share: force share all permission on added nodes. -# Requires read-only=3Dtrue. (Since 2.10) +# @force-share: force share all permission on added nodes. +# Requires read-only=3Dtrue. (Since 2.10) # # Remaining options are determined by the block driver. # @@ -4106,8 +4106,8 @@ # # Reference to a block device. # -# @definition: defines a new block device inline -# @reference: references the ID of an existing block device +# @definition: defines a new block device inline +# @reference: references the ID of an existing block device # # Since: 2.9 ## @@ -4120,11 +4120,11 @@ # # Reference to a block device. # -# @definition: defines a new block device inline -# @reference: references the ID of an existing block device. -# An empty string means that no block device should -# be referenced. Deprecated; use null instead. -# @null: No block device should be referenced (since 2.10) +# @definition: defines a new block device inline +# @reference: references the ID of an existing block device. +# An empty string means that no block device should +# be referenced. Deprecated; use null instead. +# @null: No block device should be referenced (since 2.10) # # Since: 2.9 ## @@ -4765,12 +4765,12 @@ # # @device: Block device name (deprecated, use @id instead) # -# @id: The name or QOM path of the guest device (since: 2.8) +# @id: The name or QOM path of the guest device (since: 2.8) # -# @force: if false (the default), an eject request will be sent to -# the guest if it has locked the tray (and the tray will not be o= pened -# immediately); if true, the tray will be opened regardless of wh= ether -# it is locked +# @force: if false (the default), an eject request will be sent to +# the guest if it has locked the tray (and the tray will not be op= ened +# immediately); if true, the tray will be opened regardless of whe= ther +# it is locked # # Since: 2.5 # @@ -4803,9 +4803,9 @@ # # If the tray was already closed before, this will be a no-op. # -# @device: Block device name (deprecated, use @id instead) +# @device: Block device name (deprecated, use @id instead) # -# @id: The name or QOM path of the guest device (since: 2.8) +# @id: The name or QOM path of the guest device (since: 2.8) # # Since: 2.5 # @@ -4837,7 +4837,7 @@ # # If the tray is open and there is no medium inserted, this will be a no-o= p. # -# @id: The name or QOM path of the guest device +# @id: The name or QOM path of the guest device # # Since: 2.12 # @@ -4877,7 +4877,7 @@ # device's tray must currently be open (unless there is no attached guest # device) and there must be no medium inserted already. # -# @id: The name or QOM path of the guest device +# @id: The name or QOM path of the guest device # # @node-name: name of a node in the block driver state graph # @@ -4911,11 +4911,11 @@ # Specifies the new read-only mode of a block device subject to the # @blockdev-change-medium command. # -# @retain: Retains the current read-only mode +# @retain: Retains the current read-only mode # -# @read-only: Makes the device read-only +# @read-only: Makes the device read-only # -# @read-write: Makes the device writable +# @read-write: Makes the device writable # # Since: 2.3 # @@ -4932,18 +4932,18 @@ # combines blockdev-open-tray, blockdev-remove-medium, blockdev-insert-med= ium # and blockdev-close-tray). # -# @device: Block device name (deprecated, use @id instead) +# @device: Block device name (deprecated, use @id instead) # -# @id: The name or QOM path of the guest device -# (since: 2.8) +# @id: The name or QOM path of the guest device +# (since: 2.8) # -# @filename: filename of the new image to be loaded +# @filename: filename of the new image to be loaded # -# @format: format to open the new image with (defaults to -# the probed format) +# @format: format to open the new image with (defaults to +# the probed format) # -# @read-only-mode: change the read-only mode of the device; defaults -# to 'retain' +# @read-only-mode: change the read-only mode of the device; defaults +# to 'retain' # # Since: 2.5 # @@ -5028,8 +5028,8 @@ # the access size # # @fatal: if set, the image is marked corrupt and therefore unusable after= this -# event and must be repaired (Since 2.2; before, every -# BLOCK_IMAGE_CORRUPTED event was fatal) +# event and must be repaired (Since 2.2; before, every +# BLOCK_IMAGE_CORRUPTED event was fatal) # # Note: If action is "stop", a STOP event will eventually follow the # BLOCK_IO_ERROR event. @@ -5077,10 +5077,10 @@ # # @reason: human readable string describing the error cause. # (This field is a debugging aid for humans, it should not -# be parsed by applications) (since: 2.2) +# be parsed by applications) (since: 2.2) # # Note: If action is "stop", a STOP event will eventually follow the -# BLOCK_IO_ERROR event +# BLOCK_IO_ERROR event # # Since: 0.13.0 # @@ -5222,7 +5222,7 @@ # @speed: rate limit, bytes per second # # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERR= OR -# event +# event # # Since: 1.3 # @@ -5356,15 +5356,15 @@ # @node: the name of the node that will be added. # # Note: this command is experimental, and its API is not stable. It -# does not support all kinds of operations, all kinds of children, nor -# all block drivers. +# does not support all kinds of operations, all kinds of children, n= or +# all block drivers. # -# FIXME Removing children from a quorum node means introducing gaps in the -# child indices. This cannot be represented in the 'children' list of -# BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename(). +# FIXME Removing children from a quorum node means introducing gaps = in the +# child indices. This cannot be represented in the 'children' list of +# BlockdevOptionsQuorum, as returned by .bdrv_refresh_filename(). # -# Warning: The data in a new quorum child MUST be consistent with that of -# the rest of the array. +# Warning: The data in a new quorum child MUST be consistent with th= at of +# the rest of the array. # # Since: 2.7 # @@ -5411,7 +5411,7 @@ # is already attached # # Note: this command is experimental and intended for test cases that need -# control over IOThreads only. +# control over IOThreads only. # # Since: 2.12 # diff --git a/qapi/block.json b/qapi/block.json index 7898104dae4..65eaacf31ad 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -190,12 +190,12 @@ # # Ejects a device from a removable drive. # -# @device: Block device name (deprecated, use @id instead) +# @device: Block device name (deprecated, use @id instead) # -# @id: The name or QOM path of the guest device (since: 2.8) +# @id: The name or QOM path of the guest device (since: 2.8) # -# @force: If true, eject regardless of whether the drive is locked. -# If not specified, the default value is false. +# @force: If true, eject regardless of whether the drive is locked. +# If not specified, the default value is false. # # Returns: Nothing on success # @@ -254,7 +254,7 @@ # (Since 5.0) # # @writable: Whether clients should be able to write to the device via the -# NBD connection (default false). +# NBD connection (default false). # # @bitmap: Also export the dirty bitmap reachable from @device, so the # NBD client can use NBD_OPT_SET_META_CONTEXT with @@ -281,10 +281,10 @@ # Potential additional modes to be added in the future: # # hide: Just hide export from new clients, leave existing connections as i= s. -# Remove export after all clients are disconnected. +# Remove export after all clients are disconnected. # # soft: Hide export from new clients, answer with ESHUTDOWN for all further -# requests from existing clients. +# requests from existing clients. # # Since: 2.12 ## diff --git a/qapi/char.json b/qapi/char.json index a6e81ac7bc6..8a9f1e75097 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -262,11 +262,11 @@ # @tn3270: enable tn3270 protocol on server # sockets (default: false) (Since: 2.10) # @websocket: enable websocket protocol on server -# sockets (default: false) (Since: 3.1) +# sockets (default: false) (Since: 3.1) # @reconnect: For a client socket, if a socket is disconnected, -# then attempt a reconnect after the given number of seconds. -# Setting this to zero disables this function. (default: 0) -# (Since: 2.2) +# then attempt a reconnect after the given number of seconds. +# Setting this to zero disables this function. (default: 0) +# (Since: 2.2) # # Since: 1.4 ## diff --git a/qapi/dump.json b/qapi/dump.json index 2b35409a7b2..a1eed7b15c5 100644 --- a/qapi/dump.json +++ b/qapi/dump.json @@ -38,8 +38,8 @@ # using gdb to process the core file. # # IMPORTANT: this option can make QEMU allocate several gigabytes -# of RAM. This can happen for a large guest, or a -# malicious guest pretending to be large. +# of RAM. This can happen for a large guest, or a +# malicious guest pretending to be large. # # Also, paging=3Dtrue has the following limitations: # diff --git a/qapi/introspect.json b/qapi/introspect.json index 031a954fa9a..8756e7920e1 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -34,15 +34,15 @@ # alternate that includes the original type alongside something else. # # Returns: array of @SchemaInfo, where each element describes an -# entity in the ABI: command, event, type, ... +# entity in the ABI: command, event, type, ... # -# The order of the various SchemaInfo is unspecified; however, all -# names are guaranteed to be unique (no name will be duplicated with -# different meta-types). +# The order of the various SchemaInfo is unspecified; however, all +# names are guaranteed to be unique (no name will be duplicated w= ith +# different meta-types). # # Note: the QAPI schema is also used to help define *internal* -# interfaces, by defining QAPI types. These are not part of the QMP -# wire ABI, and therefore not returned by this command. +# interfaces, by defining QAPI types. These are not part of the QMP +# wire ABI, and therefore not returned by this command. # # Since: 2.5 ## diff --git a/qapi/job.json b/qapi/job.json index a121b615fb0..5e658281f5c 100644 --- a/qapi/job.json +++ b/qapi/job.json @@ -214,28 +214,28 @@ # # Information about a job. # -# @id: The job identifier +# @id: The job identifier # -# @type: The kind of job that is being performed +# @type: The kind of job that is being performed # -# @status: Current job state/status +# @status: Current job state/status # -# @current-progress: Progress made until now. The unit is arbitrary and= the -# value can only meaningfully be used for the ratio = of -# @current-progress to @total-progress. The value is -# monotonically increasing. +# @current-progress: Progress made until now. The unit is arbitrary and the +# value can only meaningfully be used for the ratio of +# @current-progress to @total-progress. The value is +# monotonically increasing. # -# @total-progress: Estimated @current-progress value at the completio= n of -# the job. This value can arbitrarily change while t= he -# job is running, in both directions. +# @total-progress: Estimated @current-progress value at the completion of +# the job. This value can arbitrarily change while the +# job is running, in both directions. # -# @error: If this field is present, the job failed; if it is -# still missing in the CONCLUDED state, this indicat= es -# successful completion. +# @error: If this field is present, the job failed; if it is +# still missing in the CONCLUDED state, this indicates +# successful completion. # -# The value is a human-readable error message to des= cribe -# the reason for the job failure. It should not be p= arsed -# by applications. +# The value is a human-readable error message to describe +# the reason for the job failure. It should not be parsed +# by applications. # # Since: 3.0 ## diff --git a/qapi/machine-target.json b/qapi/machine-target.json index 04623224720..f2c82949d80 100644 --- a/qapi/machine-target.json +++ b/qapi/machine-target.json @@ -40,13 +40,13 @@ # model details. # # Note: When a non-migration-safe CPU model is expanded in static mode, so= me -# features enabled by the CPU model may be omitted, because they can't be -# implemented by a static CPU model definition (e.g. cache info passthroug= h and -# PMU passthrough in x86). If you need an accurate representation of the -# features enabled by a non-migration-safe CPU model, use @full. If you ne= ed a -# static representation that will keep ABI compatibility even when changin= g QEMU -# version or machine-type, use @static (but keep in mind that some feature= s may -# be omitted). +# features enabled by the CPU model may be omitted, because they can= 't be +# implemented by a static CPU model definition (e.g. cache info pass= through and +# PMU passthrough in x86). If you need an accurate representation of= the +# features enabled by a non-migration-safe CPU model, use @full. If = you need a +# static representation that will keep ABI compatibility even when c= hanging QEMU +# version or machine-type, use @static (but keep in mind that some f= eatures may +# be omitted). # # Since: 2.8.0 ## @@ -148,7 +148,7 @@ # with wrong types. # # Note: this command isn't specific to s390x, but is only implemented -# on this architecture currently. +# on this architecture currently. # # Since: 2.8.0 ## @@ -191,7 +191,7 @@ # with wrong types. # # Note: this command isn't specific to s390x, but is only implemented -# on this architecture currently. +# on this architecture currently. # # Since: 2.8.0 ## diff --git a/qapi/machine.json b/qapi/machine.json index b3d30bc8162..704b2b0fe31 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -680,7 +680,7 @@ # 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec. # # @none: None (no memory side cache in this proximity domain, -# or cache write policy unknown) +# or cache write policy unknown) # # @write-back: Write Back (WB) # @@ -706,7 +706,7 @@ # @level: the cache level described in this structure. # # @associativity: the cache associativity, -# none/direct-mapped/complex(complex cache indexing). +# none/direct-mapped/complex(complex cache indexing). # # @policy: the write policy, none/write-back/write-through. # @@ -823,10 +823,10 @@ # @core-id: core number within die the CPU belongs to# @thread-id: thread = number within core the CPU belongs to # # Note: currently there are 5 properties that could be present -# but management should be prepared to pass through other -# properties with device_add command to allow for future -# interface extension. This also requires the filed names to be kept in -# sync with the properties passed to -device/device_add. +# but management should be prepared to pass through other +# properties with device_add command to allow for future +# interface extension. This also requires the filed names to be kept= in +# sync with the properties passed to -device/device_add. # # Since: 2.7 ## diff --git a/qapi/migration.json b/qapi/migration.json index b7348d0c8bf..aa160e9e42d 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -28,22 +28,22 @@ # @normal-bytes: number of normal bytes sent (since 1.2) # # @dirty-pages-rate: number of pages dirtied by second by the -# guest (since 1.3) +# guest (since 1.3) # # @mbps: throughput in megabits/sec. (since 1.6) # # @dirty-sync-count: number of times that dirty ram was synchronized (sinc= e 2.1) # # @postcopy-requests: The number of page requests received from the destin= ation -# (since 2.7) +# (since 2.7) # # @page-size: The number of bytes per page for the various page-based -# statistics (since 2.10) +# statistics (since 2.10) # # @multifd-bytes: The number of bytes sent through multifd (since 3.0) # # @pages-per-second: the number of memory pages transferred per second -# (Since 4.0) +# (Since 4.0) # # Since: 0.14.0 ## @@ -131,7 +131,7 @@ # @pre-switchover: Paused before device serialisation. (since 2.11) # # @device: During device serialisation when pause-before-switchover is ena= bled -# (since 2.11) +# (since 2.11) # # @wait-unplug: wait for device unplug request by guest OS to be completed. # (since 4.2) @@ -167,41 +167,41 @@ # status is 'active' or 'completed' (since 1.2) # # @total-time: total amount of milliseconds since migration started. -# If migration has ended, it returns the total migration -# time. (since 1.2) +# If migration has ended, it returns the total migration +# time. (since 1.2) # # @downtime: only present when migration finishes correctly -# total downtime in milliseconds for the guest. -# (since 1.3) +# total downtime in milliseconds for the guest. +# (since 1.3) # # @expected-downtime: only present while migration is active -# expected downtime in milliseconds for the guest in last walk -# of the dirty bitmap. (since 1.3) +# expected downtime in milliseconds for the guest in l= ast walk +# of the dirty bitmap. (since 1.3) # # @setup-time: amount of setup time in milliseconds _before_ the -# iterations begin but _after_ the QMP command is issued. This is d= esigned -# to provide an accounting of any activities (such as RDMA pinning)= which -# may be expensive, but do not actually occur during the iterative -# migration rounds themselves. (since 1.6) +# iterations begin but _after_ the QMP command is issued. Thi= s is designed +# to provide an accounting of any activities (such as RDMA pi= nning) which +# may be expensive, but do not actually occur during the iter= ative +# migration rounds themselves. (since 1.6) # # @cpu-throttle-percentage: percentage of time guest cpus are being -# throttled during auto-converge. This is only present when auto-co= nverge -# has started throttling guest cpus. (Since 2.7) +# throttled during auto-converge. This is only p= resent when auto-converge +# has started throttling guest cpus. (Since 2.7) # # @error-desc: the human readable error description string, when # @status is 'failed'. Clients should not attempt to parse the # error strings. (Since 2.7) # # @postcopy-blocktime: total time when all vCPU were blocked during postco= py -# live migration. This is only present when the postcopy-blockti= me -# migration capability is enabled. (Since 3.0) +# live migration. This is only present when the postc= opy-blocktime +# migration capability is enabled. (Since 3.0) # # @postcopy-vcpu-blocktime: list of the postcopy blocktime per vCPU. This= is -# only present when the postcopy-blocktime migration capability -# is enabled. (Since 3.0) +# only present when the postcopy-blocktime migra= tion capability +# is enabled. (Since 3.0) # # @compression: migration compression statistics, only returned if compres= sion -# feature is on and status is 'active' or 'completed' (Since 3.1) +# feature is on and status is 'active' or 'completed' (Since= 3.1) # # @socket-address: Only used for tcp, to know what the real port is (Since= 4.0) # @@ -355,54 +355,54 @@ # loads, by sending compressed difference of the pages # # @rdma-pin-all: Controls whether or not the entire VM memory footprint is -# mlock()'d on demand or all at once. Refer to docs/rdma.txt for = usage. -# Disabled by default. (since 2.0) +# mlock()'d on demand or all at once. Refer to docs/rdma.tx= t for usage. +# Disabled by default. (since 2.0) # # @zero-blocks: During storage migration encode blocks of zeroes efficient= ly. This -# essentially saves 1MB of zeroes per block on the wire. Enabling= requires -# source and target VM to support this feature. To enable it is s= ufficient -# to enable the capability on the source VM. The feature is disab= led by -# default. (since 1.6) +# essentially saves 1MB of zeroes per block on the wire. Ena= bling requires +# source and target VM to support this feature. To enable it= is sufficient +# to enable the capability on the source VM. The feature is = disabled by +# default. (since 1.6) # # @compress: Use multiple compression threads to accelerate live migration. -# This feature can help to reduce the migration traffic, by sendi= ng -# compressed pages. Please note that if compress and xbzrle are b= oth -# on, compress only takes effect in the ram bulk stage, after tha= t, -# it will be disabled and only xbzrle takes effect, this can help= to -# minimize migration traffic. The feature is disabled by default. -# (since 2.4 ) +# This feature can help to reduce the migration traffic, by sen= ding +# compressed pages. Please note that if compress and xbzrle are= both +# on, compress only takes effect in the ram bulk stage, after t= hat, +# it will be disabled and only xbzrle takes effect, this can he= lp to +# minimize migration traffic. The feature is disabled by defaul= t. +# (since 2.4 ) # # @events: generate events for each migration state change # (since 2.4 ) # # @auto-converge: If enabled, QEMU will automatically throttle down the gu= est -# to speed up convergence of RAM migration. (since 1.6) +# to speed up convergence of RAM migration. (since 1.6) # # @postcopy-ram: Start executing on the migration target before all of RAM= has -# been migrated, pulling the remaining pages along as needed. The -# capacity must have the same setting on both source and target -# or migration will not even start. NOTE: If the migration fails = during -# postcopy the VM will fail. (since 2.6) +# been migrated, pulling the remaining pages along as neede= d. The +# capacity must have the same setting on both source and ta= rget +# or migration will not even start. NOTE: If the migration = fails during +# postcopy the VM will fail. (since 2.6) # # @x-colo: If enabled, migration will never end, and the state of the VM o= n the -# primary side will be migrated continuously to the VM on secondary -# side, this process is called COarse-Grain LOck Stepping (COLO) for -# Non-stop Service. (since 2.8) +# primary side will be migrated continuously to the VM on seconda= ry +# side, this process is called COarse-Grain LOck Stepping (COLO) = for +# Non-stop Service. (since 2.8) # # @release-ram: if enabled, qemu will free the migrated ram pages on the s= ource -# during postcopy-ram migration. (since 2.9) +# during postcopy-ram migration. (since 2.9) # # @block: If enabled, QEMU will also migrate the contents of all block -# devices. Default is disabled. A possible alternative uses -# mirror jobs to a builtin NBD server on the destination, which -# offers more flexibility. -# (Since 2.10) +# devices. Default is disabled. A possible alternative uses +# mirror jobs to a builtin NBD server on the destination, which +# offers more flexibility. +# (Since 2.10) # # @return-path: If enabled, migration will use the return path even # for precopy. (since 2.10) # # @pause-before-switchover: Pause outgoing migration before serialising de= vice -# state and before disabling block IO (since 2.11) +# state and before disabling block IO (since 2.1= 1) # # @multifd: Use more than one fd for migration (since 4.0) # @@ -410,11 +410,11 @@ # (since 2.12) # # @postcopy-blocktime: Calculate downtime for postcopy live migration -# (since 3.0) +# (since 3.0) # # @late-block-activate: If enabled, the destination will not activate block -# devices (and thus take locks) immediately at the end of migrat= ion. -# (since 3.0) +# devices (and thus take locks) immediately at the e= nd of migration. +# (since 3.0) # # @x-ignore-shared: If enabled, QEMU will not migrate shared memory (since= 4.0) # @@ -494,24 +494,24 @@ # Migration parameters enumeration # # @announce-initial: Initial delay (in milliseconds) before sending the fi= rst -# announce (Since 4.0) +# announce (Since 4.0) # # @announce-max: Maximum delay (in milliseconds) between packets in the -# announcement (Since 4.0) +# announcement (Since 4.0) # # @announce-rounds: Number of self-announce packets sent after migration -# (Since 4.0) +# (Since 4.0) # # @announce-step: Increase in delay (in milliseconds) between subsequent -# packets in the announcement (Since 4.0) +# packets in the announcement (Since 4.0) # # @compress-level: Set the compression level to be used in live migration, -# the compression level is an integer between 0 and 9, where 0 me= ans -# no compression, 1 means the best compression speed, and 9 means= best -# compression ratio which will consume more CPU. +# the compression level is an integer between 0 and 9, wh= ere 0 means +# no compression, 1 means the best compression speed, and= 9 means best +# compression ratio which will consume more CPU. # # @compress-threads: Set compression thread count to be used in live migra= tion, -# the compression thread count is an integer between 1 and 255. +# the compression thread count is an integer between 1 = and 255. # # @compress-wait-thread: Controls behavior when all compression threads are # currently busy. If true (default), wait for a free @@ -519,10 +519,10 @@ # send the page uncompressed. (Since 3.1) # # @decompress-threads: Set decompression thread count to be used in live -# migration, the decompression thread count is an integer between= 1 -# and 255. Usually, decompression is at least 4 times as fast as -# compression, so set the decompress-threads to the number about = 1/4 -# of compress-threads is adequate. +# migration, the decompression thread count is an int= eger between 1 +# and 255. Usually, decompression is at least 4 times= as fast as +# compression, so set the decompress-threads to the n= umber about 1/4 +# of compress-threads is adequate. # # @cpu-throttle-initial: Initial percentage of time guest cpus are throttl= ed # when migration auto-converge is activated. The @@ -560,14 +560,14 @@ # downtime in milliseconds (Since 2.8) # # @x-checkpoint-delay: The delay time (in ms) between two COLO checkpoints= in -# periodic mode. (Since 2.8) +# periodic mode. (Since 2.8) # # @block-incremental: Affects how much storage is migrated when the -# block migration capability is enabled. When false, the entire -# storage backing chain is migrated into a flattened image at -# the destination; when true, only the active qcow2 layer is -# migrated and the destination must already have access to the -# same backing chain as was used on the source. (since 2.10) +# block migration capability is enabled. When false, = the entire +# storage backing chain is migrated into a flattened i= mage at +# the destination; when true, only the active qcow2 la= yer is +# migrated and the destination must already have acces= s to the +# same backing chain as was used on the source. (sinc= e 2.10) # # @multifd-channels: Number of channels used to migrate data in # parallel. This is the same number that the @@ -580,8 +580,8 @@ # (Since 2.11) # # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy. -# Defaults to 0 (unlimited). In bytes per second. -# (Since 3.0) +# Defaults to 0 (unlimited). In bytes per second. +# (Since 3.0) # # @max-cpu-throttle: maximum cpu throttle percentage. # Defaults to 99. (Since 3.1) @@ -604,16 +604,16 @@ # @MigrateSetParameters: # # @announce-initial: Initial delay (in milliseconds) before sending the fi= rst -# announce (Since 4.0) +# announce (Since 4.0) # # @announce-max: Maximum delay (in milliseconds) between packets in the -# announcement (Since 4.0) +# announcement (Since 4.0) # # @announce-rounds: Number of self-announce packets sent after migration -# (Since 4.0) +# (Since 4.0) # # @announce-step: Increase in delay (in milliseconds) between subsequent -# packets in the announcement (Since 4.0) +# packets in the announcement (Since 4.0) # # @compress-level: compression level # @@ -665,11 +665,11 @@ # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since= 2.8) # # @block-incremental: Affects how much storage is migrated when the -# block migration capability is enabled. When false, the entire -# storage backing chain is migrated into a flattened image at -# the destination; when true, only the active qcow2 layer is -# migrated and the destination must already have access to the -# same backing chain as was used on the source. (since 2.10) +# block migration capability is enabled. When false, = the entire +# storage backing chain is migrated into a flattened i= mage at +# the destination; when true, only the active qcow2 la= yer is +# migrated and the destination must already have acces= s to the +# same backing chain as was used on the source. (sinc= e 2.10) # # @multifd-channels: Number of channels used to migrate data in # parallel. This is the same number that the @@ -682,8 +682,8 @@ # (Since 2.11) # # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy. -# Defaults to 0 (unlimited). In bytes per second. -# (Since 3.0) +# Defaults to 0 (unlimited). In bytes per second. +# (Since 3.0) # # @max-cpu-throttle: maximum cpu throttle percentage. # The default value is 99. (Since 3.1) @@ -737,16 +737,16 @@ # The optional members aren't actually optional. # # @announce-initial: Initial delay (in milliseconds) before sending the -# first announce (Since 4.0) +# first announce (Since 4.0) # # @announce-max: Maximum delay (in milliseconds) between packets in the -# announcement (Since 4.0) +# announcement (Since 4.0) # # @announce-rounds: Number of self-announce packets sent after migration -# (Since 4.0) +# (Since 4.0) # # @announce-step: Increase in delay (in milliseconds) between subsequent -# packets in the announcement (Since 4.0) +# packets in the announcement (Since 4.0) # # @compress-level: compression level # @@ -799,11 +799,11 @@ # @x-checkpoint-delay: the delay time between two COLO checkpoints. (Since= 2.8) # # @block-incremental: Affects how much storage is migrated when the -# block migration capability is enabled. When false, the entire -# storage backing chain is migrated into a flattened image at -# the destination; when true, only the active qcow2 layer is -# migrated and the destination must already have access to the -# same backing chain as was used on the source. (since 2.10) +# block migration capability is enabled. When false, = the entire +# storage backing chain is migrated into a flattened i= mage at +# the destination; when true, only the active qcow2 la= yer is +# migrated and the destination must already have acces= s to the +# same backing chain as was used on the source. (sinc= e 2.10) # # @multifd-channels: Number of channels used to migrate data in # parallel. This is the same number that the @@ -816,12 +816,12 @@ # (Since 2.11) # # @max-postcopy-bandwidth: Background transfer bandwidth during postcopy. -# Defaults to 0 (unlimited). In bytes per second. -# (Since 3.0) +# Defaults to 0 (unlimited). In bytes per second. +# (Since 3.0) # # @max-cpu-throttle: maximum cpu throttle percentage. # Defaults to 99. -# (Since 3.1) +# (Since 3.1) # # Since: 2.4 ## @@ -1047,8 +1047,8 @@ # The reason for a COLO exit. # # @none: failover has never happened. This state does not occur -# in the COLO_EXIT event, and is only visible in the result of -# query-colo-status. +# in the COLO_EXIT event, and is only visible in the result of +# query-colo-status. # # @request: COLO exit is due to an external request. # @@ -1281,11 +1281,11 @@ # of the VM are not saved by this command. # # @filename: the file to save the state of the devices to as binary -# data. See xen-save-devices-state.txt for a description of the binary -# format. +# data. See xen-save-devices-state.txt for a description of the= binary +# format. # # @live: Optional argument to ask QEMU to treat this command as part of a = live -# migration. Default to true. (since 2.11) +# migration. Default to true. (since 2.11) # # Returns: Nothing on success # diff --git a/qapi/misc-target.json b/qapi/misc-target.json index a00fd821ebc..dee3b459301 100644 --- a/qapi/misc-target.json +++ b/qapi/misc-target.json @@ -230,14 +230,14 @@ # QEMU/KVM software version, but also decided by the hardware that # the program is running upon. # -# @version: version of GIC to be described. Currently, only 2 and 3 -# are supported. +# @version: version of GIC to be described. Currently, only 2 and 3 +# are supported. # # @emulated: whether current QEMU/hardware supports emulated GIC # device in user space. # -# @kernel: whether current QEMU/hardware supports hardware -# accelerated GIC device in kernel. +# @kernel: whether current QEMU/hardware supports hardware +# accelerated GIC device in kernel. # # Since: 2.6 ## diff --git a/qapi/misc.json b/qapi/misc.json index 33b94e35896..626a342b008 100644 --- a/qapi/misc.json +++ b/qapi/misc.json @@ -14,11 +14,11 @@ # # Arguments: # -# @enable: An optional list of QMPCapability values to enable. The -# client must not enable any capability that is not -# mentioned in the QMP greeting message. If the field is not -# provided, it means no QMP capabilities will be enabled. -# (since 2.12) +# @enable: An optional list of QMPCapability values to enable. The +# client must not enable any capability that is not +# mentioned in the QMP greeting message. If the field is not +# provided, it means no QMP capabilities will be enabled. +# (since 2.12) # # Example: # @@ -27,11 +27,11 @@ # <- { "return": {} } # # Notes: This command is valid exactly when first connecting: it must be -# issued before any other command will be accepted, and will fail once the -# monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt) +# issued before any other command will be accepted, and will fail o= nce the +# monitor is accepting other commands. (see qemu docs/interop/qmp-s= pec.txt) # -# The QMP client needs to explicitly enable QMP capabilities, otherwise -# all the QMP capabilities will be turned off by default. +# The QMP client needs to explicitly enable QMP capabilities, other= wise +# all the QMP capabilities will be turned off by default. # # Since: 0.13 # @@ -46,8 +46,8 @@ # Enumeration of capabilities to be advertised during initial client # connection, used for agreeing on particular QMP extension behaviors. # -# @oob: QMP ability to support out-of-band requests. -# (Please refer to qmp-spec.txt for more information on OOB) +# @oob: QMP ability to support out-of-band requests. +# (Please refer to qmp-spec.txt for more information on OOB) # # Since: 2.12 # @@ -60,11 +60,11 @@ # # A three-part version number. # -# @major: The major version number. +# @major: The major version number. # -# @minor: The minor version number. +# @minor: The minor version number. # -# @micro: The micro version number. +# @micro: The micro version number. # # Since: 2.4 ## @@ -77,16 +77,16 @@ # # A description of QEMU's version. # -# @qemu: The version of QEMU. By current convention, a micro -# version of 50 signifies a development branch. A micro ver= sion -# greater than or equal to 90 signifies a release candidate = for -# the next minor version. A micro version of less than 50 -# signifies a stable release. +# @qemu: The version of QEMU. By current convention, a micro +# version of 50 signifies a development branch. A micro version +# greater than or equal to 90 signifies a release candidate for +# the next minor version. A micro version of less than 50 +# signifies a stable release. # -# @package: QEMU will always set this field to an empty string. Downs= tream -# versions of QEMU should set this to a non-empty string. T= he -# exact format depends on the downstream however it highly -# recommended that a unique name is used. +# @package: QEMU will always set this field to an empty string. Downstream +# versions of QEMU should set this to a non-empty string. The +# exact format depends on the downstream however it highly +# recommended that a unique name is used. # # Since: 0.14.0 ## @@ -98,7 +98,7 @@ # # Returns the current version of QEMU. # -# Returns: A @VersionInfo object describing the current version of QEMU. +# Returns: A @VersionInfo object describing the current version of QEMU. # # Since: 0.14.0 # @@ -321,7 +321,7 @@ # Since: 1.2.0 # # Note: This command is deprecated, because its output doesn't reflect -# compile-time configuration. Use query-qmp-schema instead. +# compile-time configuration. Use query-qmp-schema instead. # # Example: # @@ -375,8 +375,8 @@ # Returns a list of information about each iothread. # # Note: this list excludes the QEMU main loop thread, which is not declared -# using the -object iothread command-line option. It is always the main t= hread -# of the process. +# using the -object iothread command-line option. It is always the = main thread +# of the process. # # Returns: a list of @IOThreadInfo for each iothread # @@ -624,9 +624,9 @@ # Return information about the PCI bus topology of the guest. # # Returns: a list of @PciInfo for each PCI bus. Each bus is -# represented by a json-object, which has a key with a json-array of -# all PCI devices attached to it. Each device is represented by a -# json-object. +# represented by a json-object, which has a key with a json-array= of +# all PCI devices attached to it. Each device is represented by a +# json-object. # # Since: 0.14.0 # @@ -788,10 +788,10 @@ # # Since: 0.14.0 # -# Notes: This function will succeed even if the guest is already in the s= topped -# state. In "inmigrate" state, it will ensure that the guest -# remains paused once migration finishes, as if the -S option was -# passed on the command line. +# Notes: This function will succeed even if the guest is already in the st= opped +# state. In "inmigrate" state, it will ensure that the guest +# remains paused once migration finishes, as if the -S option was +# passed on the command line. # # Example: # @@ -847,7 +847,7 @@ # @filename: the file to save the memory to as binary data # # @cpu-index: the index of the virtual CPU to use for translating the -# virtual address (defaults to CPU 0) +# virtual address (defaults to CPU 0) # # Returns: Nothing on success # @@ -905,11 +905,11 @@ # # Returns: If successful, nothing # -# Notes: This command will succeed if the guest is currently running. It -# will also succeed if the guest is in the "inmigrate" state; in -# this case, the effect of the command is to make sure the guest -# starts once migration finishes, removing the effect of the -S -# command line option if it was passed. +# Notes: This command will succeed if the guest is currently running. It +# will also succeed if the guest is in the "inmigrate" state; in +# this case, the effect of the command is to make sure the guest +# starts once migration finishes, removing the effect of the -S +# command line option if it was passed. # # Example: # @@ -955,7 +955,7 @@ # Returns: nothing. # # Note: prior to 4.0, this command does nothing in case the guest -# isn't suspended. +# isn't suspended. # # Example: # @@ -1069,18 +1069,18 @@ # change password command. Otherwise, this specifies a new serv= er URI # address to listen to for VNC connections. # -# @arg: If @device is a block device, then this is an optional format t= o open -# the device with. -# If @device is 'vnc' and @target is 'password', this is the new = VNC -# password to set. See change-vnc-password for additional notes. +# @arg: If @device is a block device, then this is an optional format to o= pen +# the device with. +# If @device is 'vnc' and @target is 'password', this is the new VNC +# password to set. See change-vnc-password for additional notes. # # Returns: Nothing on success. # If @device is not a valid block device, DeviceNotFound # -# Notes: This interface is deprecated, and it is strongly recommended tha= t you -# avoid using it. For changing block devices, use -# blockdev-change-medium; for changing VNC parameters, use -# change-vnc-password. +# Notes: This interface is deprecated, and it is strongly recommended that= you +# avoid using it. For changing block devices, use +# blockdev-change-medium; for changing VNC parameters, use +# change-vnc-password. # # Since: 0.14.0 # @@ -1719,8 +1719,8 @@ # of the VM are not loaded by this command. # # @filename: the file to load the state of the devices from as binary -# data. See xen-save-devices-state.txt for a description of the binary -# format. +# data. See xen-save-devices-state.txt for a description of the= binary +# format. # # Since: 2.7 # diff --git a/qapi/net.json b/qapi/net.json index 335295be506..80dcf0df06e 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -47,9 +47,9 @@ # Additional arguments depend on the type. # # TODO: This command effectively bypasses QAPI completely due to its -# "additional arguments" business. It shouldn't have been added to -# the schema in this form. It should be qapified properly, or -# replaced by a properly qapified command. +# "additional arguments" business. It shouldn't have been added to +# the schema in this form. It should be qapified properly, or +# replaced by a properly qapified command. # # Since: 0.14.0 # @@ -213,7 +213,7 @@ # @fd: file descriptor of an already opened tap # # @fds: multiple file descriptors of already opened multiqueue capable -# tap +# tap # # @script: script to initialize the interface # @@ -232,14 +232,14 @@ # @vhostfd: file descriptor of an already opened vhost net device # # @vhostfds: file descriptors of multiple already opened vhost net -# devices +# devices # # @vhostforce: vhost on for non-MSIX virtio guests # # @queues: number of queues to be created for multiqueue capable tap # # @poll-us: maximum number of microseconds that could -# be spent on busy polling for tap (since 2.7) +# be spent on busy polling for tap (since 2.7) # # Since: 1.2 ## @@ -464,7 +464,7 @@ # # Since: 1.2 # -# 'l2tpv3' - since 2.1 +# 'l2tpv3' - since 2.1 ## { 'union': 'Netdev', 'base': { 'id': 'str', 'type': 'NetClientDriver' }, @@ -691,7 +691,7 @@ # Parameters for self-announce timers # # @initial: Initial delay (in ms) before sending the first GARP/RARP -# announcement +# announcement # # @max: Maximum delay (in ms) between GARP/RARP announcement packets # @@ -700,11 +700,11 @@ # @step: Delay increase (in ms) after each self-announcement attempt # # @interfaces: An optional list of interface names, which restricts the -# announcement to the listed interfaces. (Since 4.1) +# announcement to the listed interfaces. (Since 4.1) # # @id: A name to be used to identify an instance of announce-timers -# and to allow it to modified later. Not for use as -# part of the migration parameters. (Since 4.1) +# and to allow it to modified later. Not for use as +# part of the migration parameters. (Since 4.1) # # Since: 4.0 ## diff --git a/qapi/qdev.json b/qapi/qdev.json index c6d05032f4a..f4ed9735c43 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -19,8 +19,8 @@ # Returns: a list of ObjectPropertyInfo describing a devices properties # # Note: objects can create properties at runtime, for example to describe -# links between different devices and/or objects. These properties -# are not included in the output of this command. +# links between different devices and/or objects. These properties +# are not included in the output of this command. # # Since: 1.2 ## @@ -58,9 +58,9 @@ # <- { "return": {} } # # TODO: This command effectively bypasses QAPI completely due to its -# "additional arguments" business. It shouldn't have been added to -# the schema in this form. It should be qapified properly, or -# replaced by a properly qapified command. +# "additional arguments" business. It shouldn't have been added to +# the schema in this form. It should be qapified properly, or +# replaced by a properly qapified command. # # Since: 0.13 ## diff --git a/qapi/qom.json b/qapi/qom.json index 1e3c2ad5556..ecc60c4401c 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -189,8 +189,8 @@ # @typename: the type name of an object # # Note: objects can create properties at runtime, for example to describe -# links between different devices and/or objects. These properties -# are not included in the output of this command. +# links between different devices and/or objects. These properties +# are not included in the output of this command. # # Returns: a list of ObjectPropertyInfo describing object properties # diff --git a/qapi/rocker.json b/qapi/rocker.json index 3587661161d..52597db491a 100644 --- a/qapi/rocker.json +++ b/qapi/rocker.json @@ -140,7 +140,7 @@ # @ip-dst: IP header destination address # # Note: optional members may or may not appear in the flow key -# depending if they're relevant to the flow key. +# depending if they're relevant to the flow key. # # Since: 2.4 ## @@ -170,7 +170,7 @@ # @ip-tos: IP header TOS field # # Note: optional members may or may not appear in the flow mask -# depending if they're relevant to the flow mask. +# depending if they're relevant to the flow mask. # # Since: 2.4 ## @@ -197,7 +197,7 @@ # @out-pport: physical output port # # Note: optional members may or may not appear in the flow action -# depending if they're relevant to the flow action. +# depending if they're relevant to the flow action. # # Since: 2.4 ## @@ -235,7 +235,7 @@ # @name: switch name # # @tbl-id: flow table ID. If tbl-id is not specified, returns -# flow information for all tables. +# flow information for all tables. # # Returns: rocker OF-DPA flow information # @@ -291,7 +291,7 @@ # @ttl-check: perform TTL check # # Note: optional members may or may not appear in the group depending -# if they're relevant to the group type. +# if they're relevant to the group type. # # Since: 2.4 ## @@ -311,7 +311,7 @@ # @name: switch name # # @type: group type. If type is not specified, returns -# group information for all group types. +# group information for all group types. # # Returns: rocker OF-DPA group information # diff --git a/qapi/run-state.json b/qapi/run-state.json index b83a436a3e6..2e229077400 100644 --- a/qapi/run-state.json +++ b/qapi/run-state.json @@ -15,16 +15,16 @@ # @finish-migrate: guest is paused to finish the migration process # # @inmigrate: guest is paused waiting for an incoming migration. Note -# that this state does not tell whether the machine will start at the -# end of the migration. This depends on the command-line -S option and -# any invocation of 'stop' or 'cont' that has happened since QEMU was -# started. +# that this state does not tell whether the machine will start= at the +# end of the migration. This depends on the command-line -S o= ption and +# any invocation of 'stop' or 'cont' that has happened since Q= EMU was +# started. # # @internal-error: An internal error that prevents further guest execution -# has occurred +# has occurred # # @io-error: the last IOP has failed and the device is configured to pause -# on I/O errors +# on I/O errors # # @paused: guest has been paused via the 'stop' command # @@ -85,8 +85,8 @@ # @guest-panic: Guest panicked, and command line turns that into a shutdown # # @subsystem-reset: Partial guest reset that does not trigger QMP events a= nd -# ignores --no-reboot. This is useful for sanitizing -# hypercalls on s390 that are used during kexec/kdump/boot +# ignores --no-reboot. This is useful for sanitizing +# hypercalls on s390 that are used during kexec/kdump/bo= ot # ## { 'enum': 'ShutdownCause', @@ -140,13 +140,13 @@ # about to exit. # # @guest: If true, the shutdown was triggered by a guest request (such as -# a guest-initiated ACPI shutdown request or other hardware-specific actio= n) -# rather than a host request (such as sending qemu a SIGINT). (since 2.10) +# a guest-initiated ACPI shutdown request or other hardware-specif= ic action) +# rather than a host request (such as sending qemu a SIGINT). (sin= ce 2.10) # # @reason: The @ShutdownCause which resulted in the SHUTDOWN. (since 4.0) # # Note: If the command-line option "-no-shutdown" has been specified, qemu= will -# not exit, and a STOP event will eventually follow the SHUTDOWN event +# not exit, and a STOP event will eventually follow the SHUTDOWN eve= nt # # Since: 0.12.0 # @@ -180,9 +180,9 @@ # Emitted when the virtual machine is reset # # @guest: If true, the reset was triggered by a guest request (such as -# a guest-initiated ACPI reboot request or other hardware-specific action) -# rather than a host request (such as the QMP command system_reset). -# (since 2.10) +# a guest-initiated ACPI reboot request or other hardware-specific= action) +# rather than a host request (such as the QMP command system_reset= ). +# (since 2.10) # # @reason: The @ShutdownCause of the RESET. (since 4.0) # @@ -283,7 +283,7 @@ # @action: action that has been taken # # Note: If action is "reset", "shutdown", or "pause" the WATCHDOG event is -# followed respectively by the RESET, SHUTDOWN, or STOP events +# followed respectively by the RESET, SHUTDOWN, or STOP events # # Note: This event is rate-limited. # @@ -441,12 +441,12 @@ # @disabled-wait: the CPU has entered a disabled wait state # # @extint-loop: clock comparator or cpu timer interrupt with new PSW enabl= ed -# for external interrupts +# for external interrupts # # @pgmint-loop: program interrupt with BAD new PSW # # @opint-loop: operation exception interrupt with invalid code at the prog= ram -# interrupt new PSW +# interrupt new PSW # # Since: 2.12 ## diff --git a/qapi/sockets.json b/qapi/sockets.json index 32375f3a361..ea933ed4b2b 100644 --- a/qapi/sockets.json +++ b/qapi/sockets.json @@ -89,7 +89,7 @@ # @port: port # # Note: string types are used to allow for possible future hostname or -# service resolution support. +# service resolution support. # # Since: 2.8 ## @@ -104,9 +104,9 @@ # Captures the address of a socket, which could also be a named file descr= iptor # # Note: This type is deprecated in favor of SocketAddress. The -# difference between SocketAddressLegacy and SocketAddress is that the -# latter is a flat union rather than a simple union. Flat is nicer -# because it avoids nesting on the wire, i.e. that form has fewer {}. +# difference between SocketAddressLegacy and SocketAddress is that t= he +# latter is a flat union rather than a simple union. Flat is nicer +# because it avoids nesting on the wire, i.e. that form has fewer {}. =20 # # Since: 1.3 diff --git a/qapi/trace.json b/qapi/trace.json index 799b254a186..4955e5a7503 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -52,14 +52,14 @@ # # Returns: a list of @TraceEventInfo for the matching events # -# An event is returned if: -# - its name matches the @name pattern, and -# - if @vcpu is given, the event has the "vcpu" property. +# An event is returned if: +# - its name matches the @name pattern, and +# - if @vcpu is given, the event has the "vcpu" property. # -# Therefore, if @vcpu is given, the operation will only match per-vCPU eve= nts, -# returning their state on the specified vCPU. Special case: if @name is an -# exact match, @vcpu is given and the event does not have the "vcpu" prope= rty, -# an error is returned. +# Therefore, if @vcpu is given, the operation will only match per= -vCPU events, +# returning their state on the specified vCPU. Special case: if @= name is an +# exact match, @vcpu is given and the event does not have the "vc= pu" property, +# an error is returned. # # Since: 2.2 # diff --git a/qapi/transaction.json b/qapi/transaction.json index 0590dbcd1ae..04301f1be79 100644 --- a/qapi/transaction.json +++ b/qapi/transaction.json @@ -132,8 +132,8 @@ # Errors depend on the operations of the transaction # # Note: The transaction aborts on the first failure. Therefore, there wil= l be -# information on only one failed operation returned in an error condition,= and -# subsequent actions will not have been attempted. +# information on only one failed operation returned in an error cond= ition, and +# subsequent actions will not have been attempted. # # Since: 1.1 # diff --git a/qapi/ui.json b/qapi/ui.json index f8c803fe432..ba873e1e298 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -18,10 +18,10 @@ # @password: the new password # # @connected: how to handle existing clients when changing the -# password. If nothing is specified, defaults to `k= eep' -# `fail' to fail the command if clients are connected -# `disconnect' to disconnect existing clients -# `keep' to maintain existing clients +# password. If nothing is specified, defaults to `keep' +# `fail' to fail the command if clients are connected +# `disconnect' to disconnect existing clients +# `keep' to maintain existing clients # # Returns: Nothing on success # If Spice is not enabled, DeviceNotFound @@ -591,12 +591,12 @@ # # Change the VNC server password. # -# @password: the new password to use with VNC authentication +# @password: the new password to use with VNC authentication # # Since: 1.1 # -# Notes: An empty password in this command will set the password to the e= mpty -# string. Existing clients are unaffected by executing this comma= nd. +# Notes: An empty password in this command will set the password to the em= pty +# string. Existing clients are unaffected by executing this comman= d. ## { 'command': 'change-vnc-password', 'data': { 'password': 'str' }, @@ -612,7 +612,7 @@ # @client: client information # # Note: This event is emitted before any authentication takes place, thus -# the authentication ID is not provided +# the authentication ID is not provided # # Since: 0.13.0 # @@ -915,9 +915,9 @@ # # Pointer motion input event. # -# @axis: Which axis is referenced by @value. -# @value: Pointer position. For absolute coordinates the -# valid range is 0 -> 0x7ffff +# @axis: Which axis is referenced by @value. +# @value: Pointer position. For absolute coordinates the +# valid range is 0 -> 0x7ffff # # Since: 2.0 ## @@ -931,10 +931,10 @@ # Input event union. # # @type: the input type, one of: -# - 'key': Input event of Keyboard -# - 'btn': Input event of pointer buttons -# - 'rel': Input event of relative pointer motion -# - 'abs': Input event of absolute pointer motion +# - 'key': Input event of Keyboard +# - 'btn': Input event of pointer buttons +# - 'rel': Input event of relative pointer motion +# - 'abs': Input event of absolute pointer motion # # Since: 2.0 ## @@ -970,9 +970,9 @@ # Since: 2.6 # # Note: The consoles are visible in the qom tree, under -# /backend/console[$index]. They have a device link and head property, -# so it is possible to map which console belongs to which device and -# display. +# /backend/console[$index]. They have a device link and head propert= y, +# so it is possible to map which console belongs to which device and +# display. # # Example: # --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616727818928.0480007210843; Thu, 13 Feb 2020 09:58:47 -0800 (PST) Received: from localhost ([::1]:57126 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IlC-0002KU-IA for importer@patchew.org; Thu, 13 Feb 2020 12:58:46 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33856) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijd-0000Ux-51 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ija-0002du-Ub for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:09 -0500 Received: from mail-wm1-x32a.google.com ([2a00:1450:4864:20::32a]:55109) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ija-0002cH-Ny for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:06 -0500 Received: by mail-wm1-x32a.google.com with SMTP id g1so7246285wmh.4 for ; Thu, 13 Feb 2020 09:57:06 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=VQc7coEXjD/CTx7TtXjHvTSiKBr3RUfeg+AIAbQDHCI=; b=kZg4x9atRG1/nKaacg5/a9gSGsZLc/zqZIJBt9TFSvsuZljuLYhh/rW+l6jmp7n1YC 5zAaxDOIwOw+bxAYG1nkell76ttDDiJd21hi6nYgM1yH9ZfmYSDjAt/k+qyRPPUZ1MVK rpqsgUIRKcewwWm1TuQEtGHNgGKoKeB+bBVyopXb1AjwhHp1U0JgQwXrkiWOB2nkxBIe NX0maEJXU9sL9joCgDqwwNflnXE9qC1W9rA2OcI+lIHLSYeUYSAKb08FbTEfpMmLumq8 SLhQKxZ9aRzpnj1w7CV/uT3bOs954oKsTXlAhlsNZTlwkgnRgVV7NOupQSRdpJDtbMSG VcIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=VQc7coEXjD/CTx7TtXjHvTSiKBr3RUfeg+AIAbQDHCI=; b=DOlZT9qloI9MxPNCCv5TXaEQR9mbWWq2cD6VRvJL5itO3xif/kL1j2Ss0KhUj5RkPA ScBQN0mwB4TXHGBW+z1/lP1+Ii6mJLoRWEgasGjRLrxLUJ0HakQChlZ2XNgnOOPbwpYn WQlHVfZK1dpEAnRLdH1ufOdUErGq5qdadicO4n/pYYenLIxWbbP0KkIHP/qh3lvNDAPo Rtmk6DADi8pU3YhvW1fj9GIGcdJq/ZvSy4JumsDJ8dJwY8a0CpuH9jy9WdOO3SWkAuA3 eU6Hi3MaFLFEUuKj+fda2IZkEGVh3gaEFauSq/lFD+rcggYZ0ovHssDx1F7CL9tx9hgQ Sxnw== X-Gm-Message-State: APjAAAWc2KbquoLa38j0RnwK8NB7nnPpERRZhH94oHD+ViMYhHsV6M+d gImdrQlOJUrmuM/503CQdPIAPoZ99h0= X-Google-Smtp-Source: APXvYqxHBlcZgPmcfNTXohDrcoeWfB61I5PBsk2j4hlxm98iAteZeVQZRALqOQAr/ok2tL3xqCKe9w== X-Received: by 2002:a7b:cbcf:: with SMTP id n15mr6930192wmi.21.1581616625486; Thu, 13 Feb 2020 09:57:05 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 10/30] qapi: Remove hardcoded tabs Date: Thu, 13 Feb 2020 17:56:27 +0000 Message-Id: <20200213175647.17628-11-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32a X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" There are some stray hardcoded tabs in some of our json files; remove them. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- Most of the hardcoded tabs got removed in passing in fixing the indent in lines that they were in, but these are not part of doc comments. --- qapi/block-core.json | 4 ++-- qapi/migration.json | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index c62b7db2814..31f7a1281c6 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -2938,8 +2938,8 @@ '*pr-manager': 'str', '*locking': 'OnOffAuto', '*aio': 'BlockdevAioOptions', - '*drop-cache': {'type': 'bool', - 'if': 'defined(CONFIG_LINUX)'}, + '*drop-cache': {'type': 'bool', + 'if': 'defined(CONFIG_LINUX)'}, '*x-check-cache-dropped': 'bool' }, 'features': [ { 'name': 'dynamic-auto-read-only', 'if': 'defined(CONFIG_POSIX)' } ] } diff --git a/qapi/migration.json b/qapi/migration.json index aa160e9e42d..11033b7a8e6 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -98,7 +98,7 @@ ## { 'struct': 'CompressionStats', 'data': {'pages': 'int', 'busy': 'int', 'busy-rate': 'number', - 'compressed-size': 'int', 'compression-rate': 'number' } } + 'compressed-size': 'int', 'compression-rate': 'number' } } =20 ## # @MigrationStatus: @@ -713,7 +713,7 @@ '*multifd-channels': 'int', '*xbzrle-cache-size': 'size', '*max-postcopy-bandwidth': 'size', - '*max-cpu-throttle': 'int' } } + '*max-cpu-throttle': 'int' } } =20 ## # @migrate-set-parameters: @@ -845,7 +845,7 @@ '*block-incremental': 'bool' , '*multifd-channels': 'uint8', '*xbzrle-cache-size': 'size', - '*max-postcopy-bandwidth': 'size', + '*max-postcopy-bandwidth': 'size', '*max-cpu-throttle':'uint8'} } =20 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581616900071730.8150822498011; Thu, 13 Feb 2020 10:01:40 -0800 (PST) Received: from localhost ([::1]:57198 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Iny-0005uq-Fe for importer@patchew.org; Thu, 13 Feb 2020 13:01:38 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33896) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ije-0000Wa-7d for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:11 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijd-0002h5-5n for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:10 -0500 Received: from mail-wr1-x42a.google.com ([2a00:1450:4864:20::42a]:39254) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijc-0002em-Ua for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:09 -0500 Received: by mail-wr1-x42a.google.com with SMTP id y11so7799656wrt.6 for ; Thu, 13 Feb 2020 09:57:08 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.05 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=sGzD1fnYqJucooAWR/6jjHsELD6Wua5qgxiKhqNXiBA=; b=Bdkwvjf1Ht6ZzhUErzkXSHz+tHXmVxhMT92XnMbCvMn2ykoOwccQzVEYSELyoRVIWU 5sHbYqLgz+14duGha+TuD2tdKvMOcdxcrsXMw2rMXZ21BJNMyx3wg64rPryjiWGdajYT rxiyPVMlX5oF8hBA5SA9qJrI4TxFaHQA5ry+C+hJDfwJ8m6UuaefLURrKyd5wD2Y9eIB MBx4d1f3QF8V0TeFP8CbBsaJY6a7xBA617u0N7AvBdbYXhPpx84gK5mCFV+98/3PfcMI y8H1xuLotDKjig1wCunOpBC9YpELDuRePIRb84Osm0Tv0/v9s5Dl9Ol1m0Qsku76s3Rs SHGQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=sGzD1fnYqJucooAWR/6jjHsELD6Wua5qgxiKhqNXiBA=; b=DhxzFnv2WVFLvd+TrCEbbLYbLL14sOfp1UJ5IWZmbeLytn7wx0CN/SW/kV3mdv/AeS oY2IyfR821bt05UrV980vo3MiaP/kolWw+lnUIsroYNwMa8fKAfHpCS+3DX9hMVktzTm D7uVTLsJ0xA9plIJg3974dbfFiUlo0VKcy40bzNguHfHx/W1vejctHIXkKN2kISFLfes 4A8DzwOYr+mIPEEPaF1UuDN4KnEctGI0XKTd5kXFcr2ThO3O8Hx/CpMb31QOOn3kVyUK PUrkaAC7XQJBcjp4VVQW5X0FzNHt+mm9k6Y2X9pMMzbKCCHB/dHhUrFpUUbtdxBrrd4V Hz0g== X-Gm-Message-State: APjAAAVDJuFEmDfeeQl5JswSSg1Kp+fxx2IazIB8b5FQfwLyOfbxHBIM O2HyEXEXSzV29mUW2cBxf6US70+stxo= X-Google-Smtp-Source: APXvYqyp5vIV6tJ6nys+Ep0AEdSKpp17crvqiwpngqCkRkiYs9XAGF4WZiianZn1YvXrmQE8c0wBsg== X-Received: by 2002:a5d:614a:: with SMTP id y10mr8406616wrt.73.1581616626610; Thu, 13 Feb 2020 09:57:06 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 11/30] qapi/ui.json: Put input-send-event body text in the right place Date: Thu, 13 Feb 2020 17:56:28 +0000 Message-Id: <20200213175647.17628-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42a X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" In the doc comment for input-send-event, there is a multi-line chunk of text ("The @device...take precedence") which is intended to be the main body text describing the event. However it has been placed after the arguments and Returns: section, which means that the parser actually thinks that this text is part of the "Returns" section text. Move the body text up to the top so that the parser correctly classifies it as body. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- qapi/ui.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/qapi/ui.json b/qapi/ui.json index ba873e1e298..e8b8b708c72 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -949,13 +949,6 @@ # # Send input event(s) to guest. # -# @device: display device to send event(s) to. -# @head: head to send event(s) to, in case the -# display device supports multiple scanouts. -# @events: List of InputEvent union. -# -# Returns: Nothing on success. -# # The @device and @head parameters can be used to send the input event # to specific input devices in case (a) multiple input devices of the # same kind are added to the virtual machine and (b) you have @@ -967,6 +960,13 @@ # are admissible, but devices with input routing config take # precedence. # +# @device: display device to send event(s) to. +# @head: head to send event(s) to, in case the +# display device supports multiple scanouts. +# @events: List of InputEvent union. +# +# Returns: Nothing on success. +# # Since: 2.6 # # Note: The consoles are visible in the qom tree, under --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617023248244.18082605067104; Thu, 13 Feb 2020 10:03:43 -0800 (PST) Received: from localhost ([::1]:57248 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ipx-00011D-NT for importer@patchew.org; Thu, 13 Feb 2020 13:03:41 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33905) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ije-0000X4-FJ for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:12 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijd-0002hH-7I for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:10 -0500 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:44420) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijd-0002g3-0r for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:09 -0500 Received: by mail-wr1-x443.google.com with SMTP id m16so7782756wrx.11 for ; Thu, 13 Feb 2020 09:57:08 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=yvaniTNaVZq0Mihik+Rp3oNaMwVKeXRTQ0KV3KgYMSs=; b=Jrn04ao4kz1sf2I87ukxuP+3d1j9SrtJLv/gX70tylZGk3nbluTBiJG8iiPoc0VZdu Sp9Fg8aFui1RlyaNvS+ih7zWN/DJeckphHjw1qeY4E9V3iE4zaRLythZ47YmFSpzx7JO mKUZsZLRwBuE4RHPtreWe3wtZHkt9LGLp+OB+AmssqzYe8SyQp+LnVboUcnajlSeAvH5 jEAygADwIWTryf7exIKJsIczVvUfp1+cZ3eDpacb4H7tyhtOx6zZb4Gfpv731Y2Kp47K G+LE3SBRyRbRzo0AVNpnOj1CEgva4q8rxRvHvqEfTv+U1gwZZ4GhZ6WrEMJgNgLv/8Ng YVEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=yvaniTNaVZq0Mihik+Rp3oNaMwVKeXRTQ0KV3KgYMSs=; b=T4b1Sq0QcaCCUoF9vg/ln9T9GHD3pUdWtpI+uVkn4re0OpVXdFMFtsKailpfzqzTIL wqRQHwirl+N9gzcXDHRTJQst8X8ORe6rp3CVyTtoCR4BmfI0HOa7cNI0HnEznP4NT8W9 LHLX4oFpEqODuvmb2gFEjQFyeb8rFSnUYgJZBVkKu7hX8hDP3btelUljhw0hUvdfF5br vQJjLslqrKk2o9n2Vg67kzO9bVAqeZHs3Hd1JhJiG6yClSWDXyuf/1qg6ZiIHt6VG8WL CwgIbI6J1QWUZ8XmV0l/t/Y8lQxvLjV8W4K/OxEE10jYpPFbhZGCxbBAVx/QxyP2p6hT MNwg== X-Gm-Message-State: APjAAAWCeZ0k+AmWOTNShzaxs3Np/NRSd/iBxGRFuux5COxTfHVkeEcC 5kzHLKP8qENMmruAd9laVXApjZ4HHcM= X-Google-Smtp-Source: APXvYqxpcHid7/tGU+ylIuNZdLr8vJmCJh5CWcxleKKuxKKnkXDd7MgGf4Daf8Nrn3NL8JOQemGofQ== X-Received: by 2002:adf:cd92:: with SMTP id q18mr22439671wrj.261.1581616627772; Thu, 13 Feb 2020 09:57:07 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 12/30] qapi/ui.json: Avoid `...' texinfo style quoting Date: Thu, 13 Feb 2020 17:56:29 +0000 Message-Id: <20200213175647.17628-13-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::443 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Avoid texinfo style quoting with `...', because rST treats it as a syntax error. Use '...' instead, as we do in other doc comments. This looks OK in texinfo, and rST formats it as paired-quotation-marks. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- qapi/ui.json | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/qapi/ui.json b/qapi/ui.json index e8b8b708c72..088a8680efb 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -12,16 +12,16 @@ # # Sets the password of a remote display session. # -# @protocol: `vnc' to modify the VNC server password -# `spice' to modify the Spice server password +# @protocol: 'vnc' to modify the VNC server password +# 'spice' to modify the Spice server password # # @password: the new password # # @connected: how to handle existing clients when changing the -# password. If nothing is specified, defaults to `keep' -# `fail' to fail the command if clients are connected -# `disconnect' to disconnect existing clients -# `keep' to maintain existing clients +# password. If nothing is specified, defaults to 'keep' +# 'fail' to fail the command if clients are connected +# 'disconnect' to disconnect existing clients +# 'keep' to maintain existing clients # # Returns: Nothing on success # If Spice is not enabled, DeviceNotFound @@ -43,16 +43,16 @@ # # Expire the password of a remote display server. # -# @protocol: the name of the remote display protocol `vnc' or `spice' +# @protocol: the name of the remote display protocol 'vnc' or 'spice' # # @time: when to expire the password. -# `now' to expire the password immediately -# `never' to cancel password expiration -# `+INT' where INT is the number of seconds from now (integer) -# `INT' where INT is the absolute time in seconds +# 'now' to expire the password immediately +# 'never' to cancel password expiration +# '+INT' where INT is the number of seconds from now (integer) +# 'INT' where INT is the absolute time in seconds # # Returns: Nothing on success -# If @protocol is `spice' and Spice is not active, DeviceNotFound +# If @protocol is 'spice' and Spice is not active, DeviceNotFound # # Since: 0.14.0 # --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617467133497.77844918915946; Thu, 13 Feb 2020 10:11:07 -0800 (PST) Received: from localhost ([::1]:57402 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ix7-00039W-7o for importer@patchew.org; Thu, 13 Feb 2020 13:11:05 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:33982) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijg-0000aZ-RF for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:14 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ije-0002kT-Mi for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:12 -0500 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:39259) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ije-0002i3-FS for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:10 -0500 Received: by mail-wr1-x42f.google.com with SMTP id y11so7799805wrt.6 for ; Thu, 13 Feb 2020 09:57:10 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=mu3MkvlL4TJMpHa8jn/jjpDGQdQ8pv8OsHnWYrWoDqc=; b=U4TnXLX90XXMV2WdPCsrWE+e9/UtZoiIRLQHYGsYarcEufmuRhJy2eISqhnxib1TEj gJLYJL9gi2/o9lXyw9VT2Lu1fy0Bc0KQFaqF9Ewd5l+xZMkiyt7yrLM4dR5ykjcSUENJ 0HcXtuIHofsWeh9rqd09jGmt1wTsPGp1c28i369Ii/KFr9B3MeYNgZ6VrCyW4MS1Pshs AHCSNhR2Id/oSL2Y5I1tkpd2W2xWR87vhDmOHAkRtnzkcSq1X+d/1wk7WvF0g76cBz1G eb1JmfsQAoHw9voFVlATtbevDutPGdLHzX8n89GP4MQ7QIHEA18TfkQILa74MB0XAabd sC4w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=mu3MkvlL4TJMpHa8jn/jjpDGQdQ8pv8OsHnWYrWoDqc=; b=blAvuUGKTPFSOjkKCqSDWnAnpD53GtyWkn9jR/nCHK3virT7gqnlYL98E54nUJ0ffX ch6UIRhVkHzyfMVwMKi+KHSQnYP0G8NuZ0SOlECUjyyc3FPh91NFrg3pQiWNw0mC3IJe VD1M9D3I04oIjDP0dxqgHtY2jzvGoMhlpxdkpyEq6K231qMENKk1PcdmokdHn6/G7qcd AtdSUxVgwy8f7WFIKccdrScDRcCocv5d0jzrGYhYAVS90Et1lvDveMrsYEwNlGg8DSu7 f1yUtAMziRXTacSTNkJM/VDUt7mST6nd5cxZoi97RKL87jGw3/MmrhbsEm11+8yqiE8/ i3oA== X-Gm-Message-State: APjAAAWyjBvHWwPjado6ubuf/A9a4tM7pnjn1R9YnHqtgV59ompv5DVS l1xgcKL176ns/yrbKd8SNpX5xGkpTYg= X-Google-Smtp-Source: APXvYqy0W4M2wcNg88Qiiym1yJKifncOYzw7oi0464jSEpr3YqhjaRF6+HBPXa4LOWg5uYwzlXZoFw== X-Received: by 2002:adf:e610:: with SMTP id p16mr24461231wrm.81.1581616629063; Thu, 13 Feb 2020 09:57:09 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 13/30] qapi/block-core.json: Use explicit bulleted lists Date: Thu, 13 Feb 2020 17:56:30 +0000 Message-Id: <20200213175647.17628-14-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42f X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" A JSON block comment like this: Returns: nothing on success If @node is not a valid block device, DeviceNotFound If @name is not found, GenericError with an explanation renders like this: Returns: nothing on success If node is not a valid block device, DeviceNotFound If name is not found, GenericError with an explanation because whitespace is not significant. Use an actual bulleted list, so that the formatting is correct. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- v1->v2: minor commit msg tweak as suggested by Markus --- qapi/block-core.json | 108 +++++++++++++++++++++---------------------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index 31f7a1281c6..082aca3f699 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1326,8 +1326,8 @@ # # @size: new image size in bytes # -# Returns: nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 0.14.0 # @@ -1510,8 +1510,8 @@ # # For the arguments, see the documentation of BlockdevSnapshotSync. # -# Returns: nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 0.14.0 # @@ -1586,9 +1586,8 @@ # when specifying the string or the image chain may # not be able to be reopened again. # -# Returns: Nothing on success -# -# If "device" does not exist or cannot be determined, DeviceNotFo= und +# Returns: - Nothing on success +# - If "device" does not exist or cannot be determined, DeviceNot= Found # # Since: 2.1 ## @@ -1674,9 +1673,9 @@ # list without user intervention. # Defaults to true. (Since 3.1) # -# Returns: Nothing on success -# If @device does not exist, DeviceNotFound -# Any other error returns a GenericError. +# Returns: - Nothing on success +# - If @device does not exist, DeviceNotFound +# - Any other error returns a GenericError. # # Since: 1.3 # @@ -1704,8 +1703,8 @@ # The operation can be stopped before it has completed using the # block-job-cancel command. # -# Returns: nothing on success -# If @device is not a valid block device, GenericError +# Returns: - nothing on success +# - If @device is not a valid block device, GenericError # # Since: 1.6 # @@ -1730,8 +1729,8 @@ # The operation can be stopped before it has completed using the # block-job-cancel command. # -# Returns: nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 2.3 # @@ -1925,8 +1924,8 @@ # format of the mirror image, default is to probe if mode=3D'existing', # else the format of the source. # -# Returns: nothing on success -# If @device is not a valid block device, GenericError +# Returns: - nothing on success +# - If @device is not a valid block device, GenericError # # Since: 1.3 # @@ -2097,9 +2096,9 @@ # # Create a dirty bitmap with a name on the node, and start tracking the wr= ites. # -# Returns: nothing on success -# If @node is not a valid block device or node, DeviceNotFound -# If @name is already taken, GenericError with an explanation +# Returns: - nothing on success +# - If @node is not a valid block device or node, DeviceNotFound +# - If @name is already taken, GenericError with an explanation # # Since: 2.4 # @@ -2120,10 +2119,10 @@ # with block-dirty-bitmap-add. If the bitmap is persistent, remove it from= its # storage too. # -# Returns: nothing on success -# If @node is not a valid block device or node, DeviceNotFound -# If @name is not found, GenericError with an explanation -# if @name is frozen by an operation, GenericError +# Returns: - nothing on success +# - If @node is not a valid block device or node, DeviceNotFound +# - If @name is not found, GenericError with an explanation +# - if @name is frozen by an operation, GenericError # # Since: 2.4 # @@ -2144,9 +2143,9 @@ # backup from this point in time forward will only backup clusters # modified after this clear operation. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found, GenericError with an explanation +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found, GenericError with an explanation # # Since: 2.4 # @@ -2165,9 +2164,9 @@ # # Enables a dirty bitmap so that it will begin tracking disk changes. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found, GenericError with an explanation +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found, GenericError with an explanation # # Since: 4.0 # @@ -2186,9 +2185,9 @@ # # Disables a dirty bitmap so that it will stop tracking disk changes. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found, GenericError with an explanation +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found, GenericError with an explanation # # Since: 4.0 # @@ -2215,11 +2214,11 @@ # of the source bitmaps. This can be used to achieve backup checkpoints, o= r in # simpler usages, to copy bitmaps. # -# Returns: nothing on success -# If @node is not a valid block device, DeviceNotFound -# If any bitmap in @bitmaps or @target is not found, GenericError -# If any of the bitmaps have different sizes or granularities, -# GenericError +# Returns: - nothing on success +# - If @node is not a valid block device, DeviceNotFound +# - If any bitmap in @bitmaps or @target is not found, GenericErr= or +# - If any of the bitmaps have different sizes or granularities, +# GenericError # # Since: 4.0 # @@ -2251,10 +2250,10 @@ # # Get bitmap SHA256. # -# Returns: BlockDirtyBitmapSha256 on success -# If @node is not a valid block device, DeviceNotFound -# If @name is not found or if hashing has failed, GenericError wi= th an -# explanation +# Returns: - BlockDirtyBitmapSha256 on success +# - If @node is not a valid block device, DeviceNotFound +# - If @name is not found or if hashing has failed, GenericError = with an +# explanation # # Since: 2.10 ## @@ -2371,8 +2370,8 @@ # the device will be removed from its group and the rest of its # members will not be affected. The 'group' parameter is ignored. # -# Returns: Nothing on success -# If @device is not a valid block device, DeviceNotFound +# Returns: - Nothing on success +# - If @device is not a valid block device, DeviceNotFound # # Since: 1.1 # @@ -2622,7 +2621,8 @@ # list without user intervention. # Defaults to true. (Since 3.1) # -# Returns: Nothing on success. If @device does not exist, DeviceNotFound. +# Returns: - Nothing on success. +# - If @device does not exist, DeviceNotFound. # # Since: 1.1 # @@ -2656,8 +2656,8 @@ # @speed: the maximum speed, in bytes per second, or 0 for unlimited. # Defaults to 0. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotA= ctive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNo= tActive # # Since: 1.1 ## @@ -2696,8 +2696,8 @@ # abandon the job immediately (even if it is paused) instead of wa= iting # for the destination to complete its final synchronization (since= 1.3) # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotA= ctive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNo= tActive # # Since: 1.1 ## @@ -2720,8 +2720,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotA= ctive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNo= tActive # # Since: 1.3 ## @@ -2742,8 +2742,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotA= ctive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNo= tActive # # Since: 1.3 ## @@ -2770,8 +2770,8 @@ # the name of the parameter), but since QEMU 2.7 it can have # other values. # -# Returns: Nothing on success -# If no background operation is active on this device, DeviceNotA= ctive +# Returns: - Nothing on success +# - If no background operation is active on this device, DeviceNo= tActive # # Since: 1.3 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617048543193.8657939971314; Thu, 13 Feb 2020 10:04:08 -0800 (PST) Received: from localhost ([::1]:57252 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IqM-0001m4-Jz for importer@patchew.org; Thu, 13 Feb 2020 13:04:06 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34049) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Iji-0000cZ-C8 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:19 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijg-0002oZ-Pn for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:14 -0500 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:38560) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijg-0002mD-FS for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:12 -0500 Received: by mail-wr1-x441.google.com with SMTP id y17so7808311wrh.5 for ; Thu, 13 Feb 2020 09:57:12 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=4LajsEXnh86T0w1vg82Lrkoo26G75hwMO4oMmN11qAc=; b=kb54xXtc7RJX8XVCbxg40+dIhbauaqx9Tww9zaQt51zP1QopStJzoJckcNFDYqbR1F 1Itm4ZVvSpR/+1fs+Hvx8kChukL1cCjWzTv6nnkQ75aSHBDDWqDpMJPp624Nvn9DEfUd 4FfA8Zihvf+q8nam9sb/1ugLh+k9VkJBRnFOqYbGVw87EQV9dUfMzFQQ+b1uBLKM0vy3 nOaIIoPFgE14OjU7VpTE8c/QyBP7yQ/Mabx/F6KUb+SHkrt99a9qy3qHh+FhpGQxqCTj X+lAHJy+PLC18UeiG+L6jhgjwmJWqN0Fs4Y9cAjEIsF9NFZjiXWYIik2PPcf9jVYa9pb DIjw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=4LajsEXnh86T0w1vg82Lrkoo26G75hwMO4oMmN11qAc=; b=fe7zxJQ9nKVfdI3MusdvUQ9pNDo/3lsnL12tOQQXfcj7yBQrF8Vx1PQ8PFCq6EKBVb 2dY0eN2ECYQNZFtAGH9a8kWVlhxrFsw1CBzrkHlgiEQwzpw9vPlgvxGRVnYknlnVl6Bt XFR8iviY1HgTIgAA6ti4USFAGUUw2G7oAU0fVTiBmMA38UAx3Q3y8oE+Kl4waGHzmDQu 47/0TzcdyIG81PmGcQmOexl7CRxtXlFMrw3z9LEjC4nwjRTaMcdnTHHEQ2KU+kugDcn/ MUJIJDWISq09etImKfUGNo+pnNoloYh3INoN3+uBNPkmyzNT2VNM/Nxf4bV7ZZmJ5z3d 6wJQ== X-Gm-Message-State: APjAAAXMngF4mvjVC+tB8ChWIkXaqOrE/c60wtNDbR9PwDx/23XFIL51 N7QO31E3dmx3oiGQHMAD1DGaCbYWZCA= X-Google-Smtp-Source: APXvYqxkS/RlD3x5yZSbU+s8h7a0nQYc9pLTThSf9jPh9bGApQ4fFPLe89gAovIKCa/qrQIQLBYz3g== X-Received: by 2002:adf:e8c9:: with SMTP id k9mr23234937wrn.168.1581616630810; Thu, 13 Feb 2020 09:57:10 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 14/30] qapi/ui.json: Use explicit bulleted lists Date: Thu, 13 Feb 2020 17:56:31 +0000 Message-Id: <20200213175647.17628-15-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::441 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" A JSON block comment like this: Returns: nothing on success If @node is not a valid block device, DeviceNotFound If @name is not found, GenericError with an explanation renders like this: Returns: nothing on success If node is not a valid block device, DeviceNotFound If name is not found, GenericError with an explanation because whitespace is not significant. Use an actual bulleted list, so that the formatting is correct. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- v1->v2: commit message tweak as suggested by Markus --- qapi/ui.json | 63 +++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 30 deletions(-) diff --git a/qapi/ui.json b/qapi/ui.json index 088a8680efb..e4bd3d8ea76 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -12,8 +12,8 @@ # # Sets the password of a remote display session. # -# @protocol: 'vnc' to modify the VNC server password -# 'spice' to modify the Spice server password +# @protocol: - 'vnc' to modify the VNC server password +# - 'spice' to modify the Spice server password # # @password: the new password # @@ -23,8 +23,8 @@ # 'disconnect' to disconnect existing clients # 'keep' to maintain existing clients # -# Returns: Nothing on success -# If Spice is not enabled, DeviceNotFound +# Returns: - Nothing on success +# - If Spice is not enabled, DeviceNotFound # # Since: 0.14.0 # @@ -46,13 +46,14 @@ # @protocol: the name of the remote display protocol 'vnc' or 'spice' # # @time: when to expire the password. -# 'now' to expire the password immediately -# 'never' to cancel password expiration -# '+INT' where INT is the number of seconds from now (integer) -# 'INT' where INT is the absolute time in seconds # -# Returns: Nothing on success -# If @protocol is 'spice' and Spice is not active, DeviceNotFound +# - 'now' to expire the password immediately +# - 'never' to cancel password expiration +# - '+INT' where INT is the number of seconds from now (integer) +# - 'INT' where INT is the absolute time in seconds +# +# Returns: - Nothing on success +# - If @protocol is 'spice' and Spice is not active, DeviceNotFou= nd # # Since: 0.14.0 # @@ -201,9 +202,10 @@ # @tls-port: The SPICE server's TLS port number. # # @auth: the current authentication type used by the server -# 'none' if no authentication is being used -# 'spice' uses SASL or direct TLS authentication, depending on comm= and -# line options +# +# - 'none' if no authentication is being used +# - 'spice' uses SASL or direct TLS authentication, depending on co= mmand +# line options # # @mouse-mode: The mode in which the mouse cursor is displayed currently. = Can # be determined by the client or the server, or unknown if sp= ice @@ -433,27 +435,28 @@ # @host: The hostname the VNC server is bound to. This depends on # the name resolution on the host and may be an IP address. # -# @family: 'ipv6' if the host is listening for IPv6 connections -# 'ipv4' if the host is listening for IPv4 connections -# 'unix' if the host is listening on a unix domain sock= et -# 'unknown' otherwise +# @family: - 'ipv6' if the host is listening for IPv6 connections +# - 'ipv4' if the host is listening for IPv4 connections +# - 'unix' if the host is listening on a unix domain socket +# - 'unknown' otherwise # # @service: The service name of the server's port. This may depends # on the host system's service database so symbolic names should= not # be relied on. # # @auth: the current authentication type used by the server -# 'none' if no authentication is being used -# 'vnc' if VNC authentication is being used -# 'vencrypt+plain' if VEncrypt is used with plain text authenticati= on -# 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentic= ation -# 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentic= ation -# 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text = auth -# 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth -# 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth -# 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain tex= t auth -# 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth -# 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth +# +# - 'none' if no authentication is being used +# - 'vnc' if VNC authentication is being used +# - 'vencrypt+plain' if VEncrypt is used with plain text authentica= tion +# - 'vencrypt+tls+none' if VEncrypt is used with TLS and no authent= ication +# - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authent= ication +# - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain tex= t auth +# - 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth +# - 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth +# - 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain t= ext auth +# - 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth +# - 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth # # @clients: a list of @VncClientInfo of all currently connected clients # @@ -840,8 +843,8 @@ # @hold-time: time to delay key up events, milliseconds. Defaults # to 100 # -# Returns: Nothing on success -# If key is unknown or redundant, InvalidParameter +# Returns: - Nothing on success +# - If key is unknown or redundant, InvalidParameter # # Since: 1.3.0 # --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617012213267.31633492821015; Thu, 13 Feb 2020 10:03:32 -0800 (PST) Received: from localhost ([::1]:57244 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ipl-0000mU-EG for importer@patchew.org; Thu, 13 Feb 2020 13:03:29 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34219) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijp-0000hi-JP for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijn-000304-US for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:21 -0500 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:44779) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijn-0002vV-Lu for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:19 -0500 Received: by mail-wr1-x432.google.com with SMTP id m16so7783223wrx.11 for ; Thu, 13 Feb 2020 09:57:17 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=WG/jZg+6Ema0IEye1yAbgm9SmgPhpVrIhKYh9qk0Xfs=; b=tGwlv/+UqN4qdPmNebjLy5ZzPY0u+Eun/MdjMic5tj70EOCfrKbrZfbgPA8Ie3acGQ zmc27OEVXzXo1O1O8ZkfC6RmHxpXhA0D4cCPmshhMQ8gPyjEYkCb0QlQ8Rxzsqq3pAPb z39ETamZGVDjB9DHBJh9fbzBougvxNVHdJA0wvjI86UkUsE+NVlJuXnNjj70FreR3aBZ 5lrAohY1/81WXo0hY/g9LS3roCI4sbvnd1ajsdbUtSySp9H89q96AAK6LBJx8R6W2PBs rvxfFRlyCN+USwFR3WXr+OiCjX1ECL+I8QGWsqMZMBieOCUdlnu6g/hsHfTgQ2onxo2V OHeQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=WG/jZg+6Ema0IEye1yAbgm9SmgPhpVrIhKYh9qk0Xfs=; b=dM8M0FJteGHLguqcA8FBJbgUCypqFwhYzuxA+ZSu58hK4CURfUuP8n7dhi1uEhXoj6 HsKcW6tS71NX6vga9LLKZxVb+G/1U4dBDYCMe6bAiJyVJRuTxHLNHtljLPQ/7lI+0qk4 7QwLiJT90FNtdi66qxC6X0QtoOfKVdLeJf3S9KXVVxK6ELTqpQYX6vYQG9qEq8fxJkiQ xw2yrGQpO1ZsNopI0UV9GW7+Q9DXlthN4I1/AQWI1qSwK4KukS6dGhrcV5KLXgzaYMF0 Dg2hx1dAmdQDrK08+jImgLKYacVQwRScaIoVkG3LrwRETagPyQD5ncvHDpG7OYkkQAU4 SKDg== X-Gm-Message-State: APjAAAX+hJocSTgqJAB0Iql868au6GaqWJKlW8jnecz4TUzUZxqd+I7Q mK0XjhDGsQgoRmI38/DlnOiG4naJtlw= X-Google-Smtp-Source: APXvYqwXE0njSEe2USltb+IakH4cDPz2qDiqRPzhSgHNttD9hrIN2f8wvlQOpjNGbT94eYYZ38Lq6Q== X-Received: by 2002:adf:db84:: with SMTP id u4mr23300767wri.317.1581616632071; Thu, 13 Feb 2020 09:57:12 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 15/30] qapi/{block, misc, tmp, net}.json: Use explicit bulleted lists Date: Thu, 13 Feb 2020 17:56:32 +0000 Message-Id: <20200213175647.17628-16-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::432 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" A JSON block comment like this: Returns: nothing on success If @node is not a valid block device, DeviceNotFound If @name is not found, GenericError with an explanation renders like this: Returns: nothing on success If node is not a valid block device, DeviceNotFound If name is not found, GenericError with an explanation because whitespace is not significant. Use an actual bulleted list, so that the formatting is correct. This commit gathers up the remaining json files which had places needing this fix. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- v1->v2: minor commit msg tweak --- qapi/block.json | 33 ++++++++++++++------------------- qapi/misc.json | 36 ++++++++++++++++-------------------- qapi/tpm.json | 4 ++-- 3 files changed, 32 insertions(+), 41 deletions(-) diff --git a/qapi/block.json b/qapi/block.json index 65eaacf31ad..da19834db41 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -115,15 +115,12 @@ # # For the arguments, see the documentation of BlockdevSnapshotInternal. # -# Returns: nothing on success -# -# If @device is not a valid block device, GenericError -# -# If any snapshot matching @name exists, or @name is empty, -# GenericError -# -# If the format of the image used does not support it, -# BlockFormatFeatureNotSupported +# Returns: - nothing on success +# - If @device is not a valid block device, GenericError +# - If any snapshot matching @name exists, or @name is empty, +# GenericError +# - If the format of the image used does not support it, +# BlockFormatFeatureNotSupported # # Since: 1.7 # @@ -154,12 +151,12 @@ # # @name: optional the snapshot's name to be deleted # -# Returns: SnapshotInfo on success -# If @device is not a valid block device, GenericError -# If snapshot not found, GenericError -# If the format of the image used does not support it, -# BlockFormatFeatureNotSupported -# If @id and @name are both not specified, GenericError +# Returns: - SnapshotInfo on success +# - If @device is not a valid block device, GenericError +# - If snapshot not found, GenericError +# - If the format of the image used does not support it, +# BlockFormatFeatureNotSupported +# - If @id and @name are both not specified, GenericError # # Since: 1.7 # @@ -197,10 +194,8 @@ # @force: If true, eject regardless of whether the drive is locked. # If not specified, the default value is false. # -# Returns: Nothing on success -# -# If @device is not a valid block device, DeviceNotFound -# +# Returns: - Nothing on success +# - If @device is not a valid block device, DeviceNotFound # Notes: Ejecting a device with no media results in success # # Since: 0.14.0 diff --git a/qapi/misc.json b/qapi/misc.json index 626a342b008..06c80b58a24 100644 --- a/qapi/misc.json +++ b/qapi/misc.json @@ -418,12 +418,10 @@ # # Return information about the balloon device. # -# Returns: @BalloonInfo on success -# -# If the balloon driver is enabled but not functional because the= KVM -# kernel module cannot support it, KvmMissingCap -# -# If no balloon device is present, DeviceNotActive +# Returns: - @BalloonInfo on success +# - If the balloon driver is enabled but not functional because t= he KVM +# kernel module cannot support it, KvmMissingCap +# - If no balloon device is present, DeviceNotActive # # Since: 0.14.0 # @@ -480,8 +478,8 @@ # # @bar: the index of the Base Address Register for this region # -# @type: 'io' if the region is a PIO region -# 'memory' if the region is a MMIO region +# @type: - 'io' if the region is a PIO region +# - 'memory' if the region is a MMIO region # # @size: memory size # @@ -992,10 +990,10 @@ # # @value: the target size of the balloon in bytes # -# Returns: Nothing on success -# If the balloon driver is enabled but not functional because the= KVM +# Returns: - Nothing on success +# - If the balloon driver is enabled but not functional because t= he KVM # kernel module cannot support it, KvmMissingCap -# If no balloon device is present, DeviceNotActive +# - If no balloon device is present, DeviceNotActive # # Notes: This command just issues a request to the guest. When it returns, # the balloon size may not have changed. A guest can change the ba= lloon @@ -1074,8 +1072,8 @@ # If @device is 'vnc' and @target is 'password', this is the new VNC # password to set. See change-vnc-password for additional notes. # -# Returns: Nothing on success. -# If @device is not a valid block device, DeviceNotFound +# Returns: - Nothing on success. +# - If @device is not a valid block device, DeviceNotFound # # Notes: This interface is deprecated, and it is strongly recommended that= you # avoid using it. For changing block devices, use @@ -1225,11 +1223,9 @@ # # @opaque: A free-form string that can be used to describe the fd. # -# Returns: @AddfdInfo on success -# -# If file descriptor was not received, FdNotSupplied -# -# If @fdset-id is a negative value, InvalidParameterValue +# Returns: - @AddfdInfo on success +# - If file descriptor was not received, FdNotSupplied +# - If @fdset-id is a negative value, InvalidParameterValue # # Notes: The list of fd sets is shared by all monitor connections. # @@ -1257,8 +1253,8 @@ # # @fd: The file descriptor that is to be removed. # -# Returns: Nothing on success -# If @fdset-id or @fd is not found, FdNotFound +# Returns: - Nothing on success +# - If @fdset-id or @fd is not found, FdNotFound # # Since: 1.2.0 # diff --git a/qapi/tpm.json b/qapi/tpm.json index 63878aa0f47..dc1f0817399 100644 --- a/qapi/tpm.json +++ b/qapi/tpm.json @@ -96,8 +96,8 @@ # # A union referencing different TPM backend types' configuration options # -# @type: 'passthrough' The configuration options for the TPM passthrough t= ype -# 'emulator' The configuration options for TPM emulator backend type +# @type: - 'passthrough' The configuration options for the TPM passthrough= type +# - 'emulator' The configuration options for TPM emulator backend t= ype # # Since: 1.5 ## --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617605045748.3723768514533; Thu, 13 Feb 2020 10:13:25 -0800 (PST) Received: from localhost ([::1]:57462 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IzL-0006Kq-QD for importer@patchew.org; Thu, 13 Feb 2020 13:13:23 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34132) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijn-0000ev-ND for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:21 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Iji-0002sf-O0 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:19 -0500 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]:39696) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Iji-0002qj-Ge for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:14 -0500 Received: by mail-wm1-x333.google.com with SMTP id c84so7796254wme.4 for ; Thu, 13 Feb 2020 09:57:14 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:12 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=zJjv+z0Lmna1TM2chaAJ29LZREt9wVMVE2+U6A2tRX4=; b=mNgcXFBjVHrzN754CquH3cR1TQbRWe5YNnCJNEdnj5u5NVfGuqOrvJFsv/YY1gxKDt hPFThYyRSfDbhT0ZqOVyOyaillb5aL5EiY4qdCX+72PYDc/C6wHCY5L8mBdcOreANawL 3pz4CCXair7oRKsOHFGWBCVavwGv5jQRpS5vNKeFT2kUMaShUZQnfMKxgF1atP25ZhUE SKqRe4SiP6s0016M3/B4voNrfGhN9hRV41ZO2FaruAvIdcFfuzcZrKW4aQmzfYAumSxa amGsFAY03Q+yipNT4YOx1dbMUS6FEop50gnOyirkth4ECgtpftUreIotQBk9FTXVM9fo rgew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=zJjv+z0Lmna1TM2chaAJ29LZREt9wVMVE2+U6A2tRX4=; b=kxgQibbGHYNj0JPhZML94rZEdiUND8GO+K8injs2ZjLd1yGhegHG8d7DCVf1XUTRYq OEvOKjR/Hz6EbeBqlLQsiRXhdCSRjBHGspmp8MDItmbst3PO0WjCV69xem1zMyIrEvgh wIYp2MgQv9frTkQvvUjwok1HiWmYnHvvkTiUWGtpjjW/jk4sJ5yCmalkGEwGHOwe/Yfc eaL/xJhI4X0Ph/VGQlWGr8uun8v76zZzxPF8UKrCwQwQGTrEt0ylsezNbC+rjm5CkuPT sxY3whYSMJNa4WZaMvMxeiWZAlqv88i/GvdZ5FDYtaKRgKbq7eqh9Uz0i2wdc2z8pxSb Q5ug== X-Gm-Message-State: APjAAAWwDqEQiNBkLbzgizBYm2SFabG1dhJtBt2yAvF5cCk4WN9ZzpNJ 121pypOoysHAzq9vffvLGr2yJ16+2cU= X-Google-Smtp-Source: APXvYqzHScbfKs79eVEBPx3SZyyr4pP+V4lacOdWPIVGeBC5sish0ZG7L1O1uyVmnPE0Ek7doG2xDw== X-Received: by 2002:a7b:c8d7:: with SMTP id f23mr6818432wml.173.1581616633159; Thu, 13 Feb 2020 09:57:13 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 16/30] qapi: Add blank lines before bulleted lists Date: Thu, 13 Feb 2020 17:56:33 +0000 Message-Id: <20200213175647.17628-17-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::333 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) rST insists on a blank line before and after a bulleted list, but our texinfo doc generator did not. Add some extra blank lines in the doc comments so they're acceptable rST input. Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Markus Armbruster --- qapi/block-core.json | 1 + qapi/char.json | 2 ++ qapi/trace.json | 1 + qapi/ui.json | 1 + 4 files changed, 5 insertions(+) diff --git a/qapi/block-core.json b/qapi/block-core.json index 082aca3f699..13dad62f441 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -4757,6 +4757,7 @@ # # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cas= es in # which no such event will be generated, these include: +# # - if the guest has locked the tray, @force is false and the guest does n= ot # respond to the eject request # - if the BlockBackend denoted by @device does not have a guest device at= tached diff --git a/qapi/char.json b/qapi/char.json index 8a9f1e75097..6907b2bfdba 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -133,6 +133,7 @@ # @data: data to write # # @format: data encoding (default 'utf8'). +# # - base64: data must be base64 encoded text. Its binary # decoding gets written. # - utf8: data's UTF-8 encoding is written @@ -167,6 +168,7 @@ # @size: how many bytes to read at most # # @format: data encoding (default 'utf8'). +# # - base64: the data read is returned in base64 encoding. # - utf8: the data read is interpreted as UTF-8. # Bug: can screw up when the buffer contains invalid UTF-8 diff --git a/qapi/trace.json b/qapi/trace.json index 4955e5a7503..47c68f04da7 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -53,6 +53,7 @@ # Returns: a list of @TraceEventInfo for the matching events # # An event is returned if: +# # - its name matches the @name pattern, and # - if @vcpu is given, the event has the "vcpu" property. # diff --git a/qapi/ui.json b/qapi/ui.json index e4bd3d8ea76..89126da395b 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -934,6 +934,7 @@ # Input event union. # # @type: the input type, one of: +# # - 'key': Input event of Keyboard # - 'btn': Input event of pointer buttons # - 'rel': Input event of relative pointer motion --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617734553601.7699341615734; Thu, 13 Feb 2020 10:15:34 -0800 (PST) Received: from localhost ([::1]:57484 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2J1P-00006G-Os for importer@patchew.org; Thu, 13 Feb 2020 13:15:31 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34268) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijq-0000jk-Dq for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijn-00030G-Vs for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:22 -0500 Received: from mail-wm1-x330.google.com ([2a00:1450:4864:20::330]:38152) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijn-0002tL-Nt for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:19 -0500 Received: by mail-wm1-x330.google.com with SMTP id a9so7778035wmj.3 for ; Thu, 13 Feb 2020 09:57:15 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=2dmYuTKXtlDf7qo2rxYhEFkrRnpA4jjhd2faKlrwZ8Q=; b=M7cf3Tpv0TbiH4jAA+mpprfGsTBqeF2jucRhoLItmQLYJ1e3E1dPU88k7KejoRx/ra 1fJ6Civlw2zODEJi4/LuZVyZsDFgvKeCUqSyiPON+ENzA3oRLL7YPOI3ojAuzbb5S1Z7 yCKrShgHT9D1LCmN1K59r2vKKtinH26w4ZxOtErn+zggkkWLojvJLUrtzUpPN+Y8AsHj jbm+BOs9vE1i1YB2mAY1KemkNKKIe8tKfyucLTHWFIpjObBiGblN9bXDs8tYiKg18mZX Z10vVmnA/8rIRt8dGyjjSgVEtGB4O4S9sqazEm72TWGWQkrPAx3AGICOaA7dZYRetRkC 3dzQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=2dmYuTKXtlDf7qo2rxYhEFkrRnpA4jjhd2faKlrwZ8Q=; b=ODljdvD//Ral6ymXKQp+REeV78bKeSy6NiLl4Z6FCH2H2gEvAhceCN5CWDUV5p4uc3 wSQerG+ShPln++Ifg2jGma5VHXn8Yv2Dgb2Seop1X3DEmcVbFzyTJli1dujtn4gdmdpT vth2S7uRj966M8o6KKujt2MfO9vvWQJGM2Q6+8sETWVXHY4vzJsP41S4B21vggUj5Ws9 tIXMLKnqCVw5fK6+dqWQRJ0jVHyS5E+Xyp3zNdCjETVzk6NFiPLNmA0Q4Ote623aqVuy 9qIl+RZwZ+iBZDP3f3i104z00x7KJe7pfpjuLrvbxGph0rDmuCVrnDnN0KGJHujhhqI3 eabA== X-Gm-Message-State: APjAAAUeJ+XmtR5bYwkZaC4HonWSIXidjkP7x2G7BwAYo1VQE3BKHYfy YZa/gzfrvIRWep0YTkBGXvILXuy30/g= X-Google-Smtp-Source: APXvYqz0AHlryDTdfJc6gV0fixv8cb8f0deB/gXf6AdXh/o6vFiiNNOFJi4scSCnnAAr7mZJfEolDg== X-Received: by 2002:a1c:f008:: with SMTP id a8mr6835616wmb.81.1581616634400; Thu, 13 Feb 2020 09:57:14 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 17/30] qapi/migration.json: Replace _this_ with *this* Date: Thu, 13 Feb 2020 17:56:34 +0000 Message-Id: <20200213175647.17628-18-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::330 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" The MigrationInfo::setup-time documentation is the only place where we use _this_ inline markup for emphasis, commonly rendered in italics. rST doesn't recognize that markup and emits literal underscores. Switch to *this* instead. Changes markup to strong emphasis with Texinfo, commonly rendered as bold. With rST, it will go right back to emphasis / italics. rST also uses **this** for strong (commonly rendered bold) where Texinfo uses *this*. We have one place in the doc comments which uses strong/bold markup, in qapi/introspect.json: Note: the QAPI schema is also used to help define *internal* When we switch to rST that will be rendered as emphasis / italics. Markus (who wrote that) thinks that using emphasis / italics there is an improvement, so we leave that markup alone. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- v1->v2: updated commit message. Paras 1 and 2 are from Markus; paras 3 and 4 are new, and mention a non-change agreed in the thread off the cover letter of the v1 patch series. --- qapi/migration.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/qapi/migration.json b/qapi/migration.json index 11033b7a8e6..52f34299698 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -178,8 +178,8 @@ # expected downtime in milliseconds for the guest in l= ast walk # of the dirty bitmap. (since 1.3) # -# @setup-time: amount of setup time in milliseconds _before_ the -# iterations begin but _after_ the QMP command is issued. Thi= s is designed +# @setup-time: amount of setup time in milliseconds *before* the +# iterations begin but *after* the QMP command is issued. Thi= s is designed # to provide an accounting of any activities (such as RDMA pi= nning) which # may be expensive, but do not actually occur during the iter= ative # migration rounds themselves. (since 1.6) --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617209375251.19549762318934; Thu, 13 Feb 2020 10:06:49 -0800 (PST) Received: from localhost ([::1]:57312 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Isy-0005Xm-2d for importer@patchew.org; Thu, 13 Feb 2020 13:06:48 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34256) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijq-0000ix-5j for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijn-0002zk-SB for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:22 -0500 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:34410) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijn-0002vL-Ko for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:19 -0500 Received: by mail-wr1-x435.google.com with SMTP id n10so5872493wrm.1 for ; Thu, 13 Feb 2020 09:57:18 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:15 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=qPc42rOU+K2bcRl791RJcPWPfU6tbDmR/D/lgmu3rFs=; b=RHX3VCgOjhNyk18lXE7UVhLw16go464p5KsFIKlYMwjq1hdnSq+sZrfjB7qj1bBE1e vyeWsf2H0UpvFFUItljZt0eoxGLMqwiJ4YR6Lv00VTnwNa/l36j1+ReKwA7cNBP4qLXM 5EEiqCLWsk03i5qG0wjlOIuYde5GaBYD50CBtlskHGa89aR9wyIT+EKRBRvgN3MhS/yQ FgyZqC2qVWeryZ+laHJOsMy5znWBlGxO0+E4KWt6I6J8NK+N/OuIsFtwnAjqqe4OK7nz FouCCI0LlOAlVAi38BeOHyrpQHpvcKtK3EzCwaHSwT9qPiGPpin30WUh3/p0uDJVhz2h Lq2g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=qPc42rOU+K2bcRl791RJcPWPfU6tbDmR/D/lgmu3rFs=; b=SKb5DaHrQGMtG9OF3Kf5j5pr/iORdTLE8eQnOd4Rv2ypMecfE07wgit4DL9i33Q6aj BTgAssXJ/qXt1W6panRiena57JSOLsXOfMPrkCG/brpMPJTpjqgGX/AsmkalRKhGRplX cBPRTkFp2ToTO+PzteBSAus5DEDjRYUednqk3IfJUN9GCppJ+TUdbnfQnTSrrMNUJAID XhubEuG9t5C9thG3oV8jQN6COabLVzF8cyAzeGdmRXzDqlVcsWUegvIjp2VV9JP1KDQt X3MQGtHw1fdPMH76dQp5ZYO7Qc8RlOViRbEAAD9vKCl6IQWR2ScwPgwkTUW6itPYerx6 jJwA== X-Gm-Message-State: APjAAAWcY5h9efKiAcIO8aTZ8is21hr92moBzjHgHi8xB5ojLW6AC+hL 68+0iPA99T6m0JWJv+VPH+BXqd5OqOE= X-Google-Smtp-Source: APXvYqwyq9NgrpGNC++7t24JAWMRYjkA1ynXFz5Oac6Ffiyrza0tjiHmWv0FaV31q19YJlQddFykWw== X-Received: by 2002:adf:f606:: with SMTP id t6mr22828970wrp.304.1581616635653; Thu, 13 Feb 2020 09:57:15 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 18/30] qapi: Delete all the "foo: dropped in n.n" notes Date: Thu, 13 Feb 2020 17:56:35 +0000 Message-Id: <20200213175647.17628-19-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::435 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" A handful of QAPI doc comments include lines like "ppcemb: dropped in 3.1". The doc comment parser will just put these into whatever the preceding section was; sometimes that's "Notes", and sometimes it's some random other section, as with "NetClientDriver" where the "'dump': dropped in 2.12" line ends up in the "Since:" section. This tends to render wrongly, more so in the upcoming rST generator, but sometimes even in the texinfo, as in the case of QKeyCode: ac_bookmarks since 2.10 altgr, altgr_r: dropped in 2.10 We now have a better place to tell users about deprecated and deleted functionality -- qemu-deprecated.texi. So just remove all these "dropped in" remarks entirely. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster --- Perhaps qemu-deprecated.texi should be updated -- Markus said he'd look into that. So this patch is to some extent a placeholder to get these broken bits of doc comment out of the way. --- qapi/machine.json | 2 -- qapi/net.json | 4 ---- qapi/ui.json | 1 - 3 files changed, 7 deletions(-) diff --git a/qapi/machine.json b/qapi/machine.json index 704b2b0fe31..6c11e3cf3a4 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -20,8 +20,6 @@ # prefix to produce the corresponding QEMU executable name. This # is true even for "qemu-system-x86_64". # -# ppcemb: dropped in 3.1 -# # Since: 3.0 ## { 'enum' : 'SysEmuTarget', diff --git a/qapi/net.json b/qapi/net.json index 80dcf0df06e..1cb9a7d782b 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -446,8 +446,6 @@ # Available netdev drivers. # # Since: 2.7 -# -# 'dump': dropped in 2.12 ## { 'enum': 'NetClientDriver', 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', @@ -493,8 +491,6 @@ # @opts: device type specific properties (legacy) # # Since: 1.2 -# -# 'vlan': dropped in 3.0 ## { 'struct': 'NetLegacy', 'data': { diff --git a/qapi/ui.json b/qapi/ui.json index 89126da395b..e16e98a060d 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -779,7 +779,6 @@ # @ac_forward: since 2.10 # @ac_refresh: since 2.10 # @ac_bookmarks: since 2.10 -# altgr, altgr_r: dropped in 2.10 # # @muhenkan: since 2.12 # @katakanahiragana: since 2.12 --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617193441619.338233178724; Thu, 13 Feb 2020 10:06:33 -0800 (PST) Received: from localhost ([::1]:57308 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Isi-0005BV-5n for importer@patchew.org; Thu, 13 Feb 2020 13:06:32 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34264) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijq-0000jK-9b for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijo-00030L-0D for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:22 -0500 Received: from mail-wr1-x42c.google.com ([2a00:1450:4864:20::42c]:37908) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijn-0002wC-Ne for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:19 -0500 Received: by mail-wr1-x42c.google.com with SMTP id y17so7808681wrh.5 for ; Thu, 13 Feb 2020 09:57:18 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=GQ9AbUdIDLadhdpxHBQc+3BZwH1J8H9FJUw/8rdNkPs=; b=jNwgKhRqyCA3zE80oMKZTPOsJ37c/lWiGko1dSItkeShzU46B5ZDYvlKdKet0QZkXn YcwC8sKJvWWajE2aN6780XUrmVxcSwgEAGcAfGa6hW1R/G69hpVpA4AA9gYUM0lYEy+W qZMXzKxJgBEBFhm1PawPDaRv/RyxVffES+bf4qpwvC1Ieu8ik0PrY1GXf4sW3Oi4vRfs VG9q8uziKfS4VnlBIbrYt4jbhnHIfGwPSISt0uH9wTlgeQP70CmffknoRphKMfepqHbt uc9/4NtDCkpfxtsAwjSZfJZm1CSCxrW57EoTdsR2tvL5Vmee18kgzZNlVklPnM3xWr7A pxdQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=GQ9AbUdIDLadhdpxHBQc+3BZwH1J8H9FJUw/8rdNkPs=; b=qLIQ/Sv0ClRI12mHA/5a/TgiJ88G9CRxnimeSdfTRRQChMNHcpdp2gW6jkjF9ZHGyj 4UbQ4qs876I+r0GJfG39CWKjhzyxazdeiW+ekPLHJUwtNPqQPSd52Hbsojdoptb+s/Eo lE47wK8TEFR2+M9qCNW8v+Eis7wU46w3ur4hP0ve9ehLyhoDZ53XETdOplJzggROpWaX 41R6vsrmxm69GYsL3d8pbm/ALI5TT9dppQpiYJJetXwboX4XF+2bEEAbQ4zswDXll8MR HMjJD+PgzZ1C6AtF4H8avkTJ1k2OXzBzn6RJTz1bxyetyISKOjZZe1snynxE/hrttQlU 26VQ== X-Gm-Message-State: APjAAAUPRZqbrL9xsykhUsG4thQREbQFKGgiJ3N2C2d4vY4wVgl5ZSGj 5cpCH53nLGAU/Uug/l3mlW1YBPXHpbA= X-Google-Smtp-Source: APXvYqy5TOuk0xFAv2U8doIHdlfLceZJ6+rAT71ldzia1zDzHrhT96jydTH6js58pPujcTli0+il7g== X-Received: by 2002:a5d:448c:: with SMTP id j12mr22423373wrq.125.1581616637009; Thu, 13 Feb 2020 09:57:17 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 19/30] qapi/qapi-schema.json: Put headers in their own doc-comment blocks Date: Thu, 13 Feb 2020 17:56:36 +0000 Message-Id: <20200213175647.17628-20-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42c X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Our current QAPI doc-comment markup allows section headers (introduced with a leading '=3D' or '=3D=3D') anywhere in any documentation comment. This works for texinfo because the texi generator simply prints a texinfo heading directive at that point in the output stream. For rST generation, since we're assembling a tree of docutils nodes, this is awkward because a new section implies starting a new section node at the top level of the tree and generating text into there. New section headings in the middle of the documentation of a command or event would be pretty nonsensical, and in fact we only ever output new headings using 'freeform' doc comment blocks whose only content is the single line of the heading, with two exceptions, which are in the introductory freeform-doc-block at the top of qapi/qapi-schema.json. Split that doc-comment up so that the heading lines are in their own doc-comment. This will allow us to tighten the specification to insist that heading lines are always standalone, rather than requiring the rST document generator to look at every line in a doc comment block and handle headings in odd places. This change makes no difference to the generated texi. Signed-off-by: Peter Maydell --- qapi/qapi-schema.json | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json index 9751b11f8f1..f7ba60a5d0b 100644 --- a/qapi/qapi-schema.json +++ b/qapi/qapi-schema.json @@ -1,7 +1,9 @@ # -*- Mode: Python -*- ## # =3D Introduction -# +## + +## # This document describes all commands currently supported by QMP. # # Most of the time their usage is exactly the same as in the user Monitor,= this @@ -25,9 +27,13 @@ # # Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for # detailed information on the Server command and response formats. -# +## + +## # =3D Stability Considerations -# +## + +## # The current QMP command set (described in this file) may be useful for a # number of use cases, however it's limited and several commands have bad # defined semantics, specially with regard to command completion. --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581618031792542.8799330650004; Thu, 13 Feb 2020 10:20:31 -0800 (PST) Received: from localhost ([::1]:57610 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2J6E-0005tS-BV for importer@patchew.org; Thu, 13 Feb 2020 13:20:30 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34403) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijs-0000pn-OV for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:25 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijo-00032S-JO for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:24 -0500 Received: from mail-wm1-x343.google.com ([2a00:1450:4864:20::343]:53638) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijo-0002zH-CV for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:20 -0500 Received: by mail-wm1-x343.google.com with SMTP id s10so7257255wmh.3 for ; Thu, 13 Feb 2020 09:57:20 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=rbxvM6zBsEyzHKe8nAvY0XhamX4FQe6hP23LCjFR3Y0=; b=vNGDk17SjuBWe9uu3NUd9utN4HpXXar9PPjiZoQTTdtyIGizJYkpWvR+1fMOmayS6h hWzZJZtVpuCStgWfAPflwgS8jiAdmzfvSOPcSnCOZKk+y+zfOWjHV+P0CcO2xMFXrg+s KkFfkf0RowSJVhS/Ht2evj27LjOF0XVKscRf20GE6Qk2CzDIC4in84cDU/OTO23XzMWS eFwQYSUDTJpBlRV3pYpNSknLwFtLFQs6imiZR9e3lgjsCYizrzQRUX3brvHuU7U38fes ezqA2i9+SzcVkRGfQE0ui05xTDWj3tCFcxTIZ091dvRTt6RGFydrDZ5eVvYQNWNAZibi It7Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=rbxvM6zBsEyzHKe8nAvY0XhamX4FQe6hP23LCjFR3Y0=; b=O6mVNOtj6PF5z0Ef3Z6GHdKq/361yLCcoR3r9IP1oiQXxcUQ1EGgRdyrWM2yTlF04A fCEojW8QwSJKqhq8vWs8O/sunrBqKZmIMAgGHGnHNe3QPCWXunMecM2O9h6kQiGfp12i j3lxSHpVMRytxZpAX82R4G9u1qKjzFiV45KQRAHmAtQBZDVrdV0QNJ1JZO2vPCqF8k1o pzwPhPL2sd9Bk/Bvaer5Qnoy6xwnrKbzYvIPnMKn4rJleAqbhlxLCM2I2/JD1K4UGYrc +sn2ZB18h6jxp40ng9AvfZ/ejiQttTBoAfcHaBxCiUUvuNlu159dR28Z5PoVONUJt27y h8Pg== X-Gm-Message-State: APjAAAVmuBMmeiR1Gk0DeDUTwVZaDpHz5ibBsE7apu4QE2G9JTVEsKgU iCBB7fGGPk0rzSqGcFoIAQW4KbZT5r4= X-Google-Smtp-Source: APXvYqw/rfnkoIK66D8VNvDpCJ7Wow15y7UMFudd4TZM3C6277u7WF4B0VuZR7/R+oygGqClS2L+CQ== X-Received: by 2002:a1c:8086:: with SMTP id b128mr6586511wmd.80.1581616638179; Thu, 13 Feb 2020 09:57:18 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 20/30] qapi/machine.json: Escape a literal '*' in doc comment Date: Thu, 13 Feb 2020 17:56:37 +0000 Message-Id: <20200213175647.17628-21-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::343 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" For rST, '*' is a kind of inline markup (for emphasis), so "*-softmmu" is a syntax error because of the missing closing '*'. Escape the '*' with a '\'. The texinfo document generator will leave the '\' in the output, which is not ideal, but that generator is going to go away in a subsequent commit. Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qapi/machine.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/qapi/machine.json b/qapi/machine.json index 6c11e3cf3a4..58580602524 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -12,7 +12,7 @@ # # The comprehensive enumeration of QEMU system emulation ("softmmu") # targets. Run "./configure --help" in the project root directory, and -# look for the *-softmmu targets near the "--target-list" option. The +# look for the \*-softmmu targets near the "--target-list" option. The # individual target constants are not documented here, for the time # being. # --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617357055193.61628170690415; Thu, 13 Feb 2020 10:09:17 -0800 (PST) Received: from localhost ([::1]:57358 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IvL-0000Dj-IR for importer@patchew.org; Thu, 13 Feb 2020 13:09:15 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34321) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijr-0000lh-9E for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:24 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijp-00035U-QI for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:41524) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijp-00030B-J8 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:21 -0500 Received: by mail-wr1-x42b.google.com with SMTP id c9so7823149wrw.8 for ; Thu, 13 Feb 2020 09:57:20 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=nWSMAlzi0oMRfWAEf8TA2pk4lWoUJVNUT6Q1IhJAJTw=; b=YIRE4jcK+0fjtmEQLEKh2kjaNrFYZxoyMYdp0YERwobrCTt+GIEMZ/lvNAduuK+83e LxcTVAxN+wPUFxfYcM66Bsz360iKWx8IoTTHlPwHR0duhoiCqf7V25D4Aq9KEhJcO1bB kANvVgdKYSMxDv7G0CTD8C+EIbIAmcjlstf+yfCM4vXH9IewdXkI8cSOb18yCSX35Okk iNI04V/y5VhKLs1wj68gPOIyf/R28wZpFJkHIsXSq2diosuFLNQPHyOFphowKsdcTU1Q xPuEP5Z35qQDwE8906fh0WJYTY0yTaOroSckfg+iYaRIQH4plPr0CNUZRBKOyA5xHR/O dIaA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=nWSMAlzi0oMRfWAEf8TA2pk4lWoUJVNUT6Q1IhJAJTw=; b=DqkhTT2bcviYm0T8G0zsNHYlZJFZsUcGPrFvUe1Cjqky2kCug62DuuI5NsIKeM4XAS mCIxlJFWdMirnToidViMoL3KLYzDB9DTfve8UujySEPcXJCXpvHR1u5mkE2ugDgEOukI zS7HfwhYOXQWy7LBnREzs9Gz7vlohYG4Eyap4Pt4XuJQWrmX211VidBWOzRDsgU9+XKl t4RUrfp6cr3oQ4k8U8UAwbufDZrJ/ejQd8PmNEV2AgOgosr1t7gDZ67prxoD2DQlugmu i5ewdz6RagAJQTp4kY9E6FmeutLs6uKsio/Lxs8B+6nfEP0ATVXcw+O4TEkIwRNlsVQ5 EuBQ== X-Gm-Message-State: APjAAAUp3T9/lCmcy0VZfn94ebvDNp2wBCAutj0rjmE7VCT9rEQwa9Y2 dxSUCoKmqwFIjANZbn94jeOgSIpLTa0= X-Google-Smtp-Source: APXvYqy96OB83DLNVXKqm6ESXGIib2d6iQEIwmAr+OrkP87HW2kY5ROT5F7gOvE7QX589jiuc1dKhg== X-Received: by 2002:adf:b60f:: with SMTP id f15mr23945099wre.372.1581616639294; Thu, 13 Feb 2020 09:57:19 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 21/30] tests/qapi/doc-good.json: Clean up markup Date: Thu, 13 Feb 2020 17:56:38 +0000 Message-Id: <20200213175647.17628-22-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42b X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" doc-good.json tests some oddities of markup that we don't want to accept. Make them match the more restrictive rST syntax: * in a single list the bullet types must all match * lists must have leading and following blank lines * indentation is important * the '|' example syntax is going to go away entirely, so stop testing it This will avoid the tests spuriously breaking when we tighten up the parser code in the following commits. Signed-off-by: Peter Maydell --- New patch in v2 --- tests/qapi-schema/doc-good.json | 25 +++++++++++++------------ tests/qapi-schema/doc-good.out | 12 ++++++------ tests/qapi-schema/doc-good.texi | 12 +++--------- 3 files changed, 22 insertions(+), 27 deletions(-) diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.j= son index d992e713d97..a45dc22848c 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -10,25 +10,25 @@ # # *strong* _with emphasis_ # @var {in braces} +# # * List item one -# - Two, multiple +# * Two, multiple # lines # -# 3. Three -# Still in list +# * Three +# Still in list +# +# Not in list # -# Not in list # - Second list -# Note: still in list +# Note: still in list # # Note: not in list +# # 1. Third list # is numbered # -# - another item -# -# | example -# | multiple lines +# 2. another item # # Returns: the King # Since: the first age @@ -62,7 +62,7 @@ ## # @Base: # @base1: -# the first member +# the first member ## { 'struct': 'Base', 'data': { 'base1': 'Enum' } } =20 @@ -101,7 +101,7 @@ ## # @Alternate: # @i: an integer -# @b is undocumented +# @b is undocumented ## { 'alternate': 'Alternate', 'data': { 'i': 'int', 'b': 'bool' } } @@ -115,7 +115,7 @@ # @arg1: the first argument # # @arg2: the second -# argument +# argument # # Features: # @cmd-feat1: a feature @@ -124,6 +124,7 @@ # Returns: @Object # TODO: frobnicate # Notes: +# # - Lorem ipsum dolor sit amet # - Ut enim ad minim veniam # diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 4c9406a464d..9503a3a3178 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -68,25 +68,25 @@ doc freeform =20 *strong* _with emphasis_ @var {in braces} + * List item one -- Two, multiple +* Two, multiple lines =20 -3. Three +* Three Still in list =20 Not in list + - Second list Note: still in list =20 Note: not in list + 1. Third list is numbered =20 -- another item - -| example -| multiple lines +2. another item =20 Returns: the King Since: the first age diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.t= exi index d4b15dabf03..1e8063c8579 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -6,6 +6,7 @@ =20 @strong{strong} @emph{with emphasis} @code{var} @{in braces@} + @itemize @bullet @item List item one @@ -20,6 +21,7 @@ Still in list @end itemize =20 Not in list + @itemize @minus @item Second list @@ -28,6 +30,7 @@ Note: still in list @end itemize =20 Note: not in list + @enumerate @item Third list @@ -36,15 +39,6 @@ is numbered @item another item =20 -@example -example -@end example - -@example -multiple lines -@end example - - @end enumerate =20 Returns: the King --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 158161788057947.7337155822222; Thu, 13 Feb 2020 10:18:00 -0800 (PST) Received: from localhost ([::1]:57560 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2J3n-0002jV-8T for importer@patchew.org; Thu, 13 Feb 2020 13:17:59 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34338) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijr-0000mL-HN for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:24 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijp-00035l-T4 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: from mail-wr1-x42d.google.com ([2a00:1450:4864:20::42d]:33657) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijp-00033Q-Km for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:21 -0500 Received: by mail-wr1-x42d.google.com with SMTP id u6so7849583wrt.0 for ; Thu, 13 Feb 2020 09:57:21 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=wpXd5QxscHZ5Ze+pVlbaJlNdMe0Q3RlgSzZJLeNwcSk=; b=UirwSC0WPnPtZx8dyMewg+fuLEeN+VYHty+qCll09IjdIfyajD7PMeU1cJRH77Lu+h UchqNPNSDpKlaYqzlTt/gQwtrO11jv5SQW6/irbQpeaIhD3uEhXIMl4/Wp41zt8TiRt/ fhKcLPLu7unjaYUWm5g8/AByhV6CALsNBGzkhVc/SeIDYYc2UDUVRF4XMhMZV9NKMgrr HB1ocjka/MNnMy2eYI23wYgOqe7SDZydT1tu43J1mLEqYlR5fjGjDSEaRENeCafxYiF3 1whPVv/izr0zoTE7KsN2MCSJJ0Ma4CfjcU2dhJxINJfjgAC0iOSxZ6s7EZlJ2oH4cpmV An5w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=wpXd5QxscHZ5Ze+pVlbaJlNdMe0Q3RlgSzZJLeNwcSk=; b=ACe/qlWSFAbWxzlDYlDw107rnVHl5ADLxJxclXVeaj5V9ete89A1K+brj1VC+qSDqF tVIzgFdvp7pq4/vSBMypHsj8PiO3nXV+JbvUbGPRkVCRwaEh/w2f1RrZKQ0HM/D6/nGn O7Ep+MBvOgVGXx5Re6GW7Vl9KswjwFNgorv4k+cSiMAOrBd8uyGOXGoC9wpsvZhF7VkH 63lGDvgVmB3qq5cB9wVZb5LLcfHuVHB1lh44LrVdRWU/Ip1bdNVbZW9tiFRn7UjJSMIp eBeirOPuGhbH/4QhhjXW+mAo9fwzpvWoGveP7TGec9V7BXB8v/phmdZN3Lg+NgsHWeJe fzhg== X-Gm-Message-State: APjAAAUfdaGCjAa2+PCKEFmHCjXtN6LuKcWbvbXpe9tGxgAxCzAd2BCE DolXdXvtdZus/+YcfbOuFVR1QNuHCu4= X-Google-Smtp-Source: APXvYqw0JLqOxAetbv1MciWoFRa+PvDZjQkct/q4n3ImEAQpbOreWsBOz88X+WgD6L6euW/zLWvlsQ== X-Received: by 2002:adf:ffc5:: with SMTP id x5mr23553063wrs.92.1581616640457; Thu, 13 Feb 2020 09:57:20 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 22/30] scripts/qapi: Move doc-comment whitespace stripping to doc.py Date: Thu, 13 Feb 2020 17:56:39 +0000 Message-Id: <20200213175647.17628-23-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42d X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" As we accumulate lines from doc comments when parsing the JSON, the QAPIDoc class generally strips leading and trailing whitespace using line.strip() when it calls _append_freeform(). This is fine for texinfo, but for rST leading whitespace is significant. We'd like to move to having the text in doc comments be rST format rather than a custom syntax, so move the removal of leading whitespace from the QAPIDoc class to the texinfo-specific processing code in texi_format() in qapi/doc.py. (Trailing whitespace will always be stripped by the rstrip() in Section::append regardless.) In a followup commit we will make the whitespace in the lines of doc comment sections more consistently follow the input source. There is no change to the generated .texi files before and after this commit. Because the qapi-schema test checks the exact values of the documentation comments against a reference, we need to update that reference to match the new whitespace. In the first four places this is now correctly checking that we did put in the amount of whitespace to pass a rST-formatted list to the backend; in the last two places the extra whitespace is 'wrong' and will go away again in the following commit. Signed-off-by: Peter Maydell --- New in v2: update doc-good.out as noted in final para of commit msg --- scripts/qapi/doc.py | 1 + scripts/qapi/parser.py | 12 ++++-------- tests/qapi-schema/doc-good.out | 12 ++++++------ 3 files changed, 11 insertions(+), 14 deletions(-) diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py index 1787a53d91a..26cd1a1751e 100644 --- a/scripts/qapi/doc.py +++ b/scripts/qapi/doc.py @@ -79,6 +79,7 @@ def texi_format(doc): inlist =3D '' lastempty =3D False for line in doc.split('\n'): + line =3D line.strip() empty =3D line =3D=3D '' =20 # FIXME: Doing this in a single if / elif chain is diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 342792e4103..2196ec5de1e 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -422,10 +422,10 @@ class QAPIDoc(object): self._append_line =3D self._append_various_line self._append_various_line(line) else: - self._append_freeform(line.strip()) + self._append_freeform(line) else: # This is a free-form documentation block - self._append_freeform(line.strip()) + self._append_freeform(line) =20 def _append_args_line(self, line): """ @@ -458,7 +458,7 @@ class QAPIDoc(object): self._append_various_line(line) return =20 - self._append_freeform(line.strip()) + self._append_freeform(line) =20 def _append_features_line(self, line): name =3D line.split(' ', 1)[0] @@ -477,7 +477,7 @@ class QAPIDoc(object): self._append_various_line(line) return =20 - self._append_freeform(line.strip()) + self._append_freeform(line) =20 def _append_various_line(self, line): """ @@ -500,10 +500,6 @@ class QAPIDoc(object): line =3D line[len(name)+1:] self._start_section(name[:-1]) =20 - if (not self._section.name or - not self._section.name.startswith('Example')): - line =3D line.strip() - self._append_freeform(line) =20 def _start_symbol_section(self, symbols_dict, name): diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 9503a3a3178..a65bce639ff 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -71,20 +71,20 @@ doc freeform =20 * List item one * Two, multiple -lines + lines =20 * Three -Still in list + Still in list =20 Not in list =20 - Second list -Note: still in list + Note: still in list =20 Note: not in list =20 1. Third list -is numbered + is numbered =20 2. another item =20 @@ -144,7 +144,7 @@ doc symbol=3DAlternate =20 arg=3Di an integer -@b is undocumented + @b is undocumented arg=3Db =20 doc freeform @@ -157,7 +157,7 @@ doc symbol=3Dcmd the first argument arg=3Darg2 the second -argument + argument arg=3Darg3 =20 feature=3Dcmd-feat1 --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617512683552.1481812638037; Thu, 13 Feb 2020 10:11:52 -0800 (PST) Received: from localhost ([::1]:57422 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ixr-00047r-AC for importer@patchew.org; Thu, 13 Feb 2020 13:11:51 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34574) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijx-0000wT-8J for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijr-0003Bu-L4 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:27 -0500 Received: from mail-wm1-x32b.google.com ([2a00:1450:4864:20::32b]:37500) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijr-00039L-Cw for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:23 -0500 Received: by mail-wm1-x32b.google.com with SMTP id a6so7802107wme.2 for ; Thu, 13 Feb 2020 09:57:23 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=yx82A80BgFchuY4arBJB9y5p01nca9y/eUUsgMiGXgw=; b=AGXIeWWwOSyBDQEJVbx1ioDFD2c2SCfA5DIqRnh9pAt60DvOalv0BT/R2sOcc0hjJc BJwB/8nSYIqM4sn8wkj7g/IEZjZ60QuMMNUjF7QatyDegfKPGPWxMpeq5410aMal7AFq oMUpO4lC1wZR/CwgQNI3GsTEgZ7CgaOX5ArdRykHItCemPJrqj4I1S8hajXOrRPbm5Il s3gFsvtFky4yiU7na+LQtYl8zRz+lBNP7slkU9D1YYqK9Zy+acPd1XsJJLI3+3qgZAEc tYB4RqxaAaIu+EljWyxOS+PqU2IDVMzN9urBA4YuRTz/zeVLquZ/2K4FUnZk2nWiY1yC lhIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=yx82A80BgFchuY4arBJB9y5p01nca9y/eUUsgMiGXgw=; b=nYqL2fqzYrbJxOfLBm9mtZhAPleJOxKZIfgcU9GCa8TFMfDipZO5LKwC1knOUZ8vQD HIhuxzZJy8FQO0A7q2bIAo1ClCPwPvSj52iIIKFSed29BACCI2yzBSQdIcDpIPec2Aey tCO0JhYjpHR/ucZKY7XUWi7VGNGcJB6GhBUIi06oZVcm84MTMPgUIxmPloiruoqirX0K 58ZiiplC+ErC6j7ekwFnS5I9o6EM5BcYhPcRMVxd3pR895vRP6MMzY9REVmm7vH+nwf7 TFt2l/hhdAseQv4BFzSD3vM30dT+J9EVulqPVT3aEqtl4/kninB5bTOa2gKYKIvmUXb6 h70w== X-Gm-Message-State: APjAAAUewIFP+MlRb+pyq2DjcJYdlobasgt6oIJPsvfqdoSeyYoUuA55 JHPs/MiH/mk4ly3pnjDauGgfRPJIAV4= X-Google-Smtp-Source: APXvYqzF+MrCwUbTjQA8GEfPXADSGZWVDB/5FVZx1t9CLvKLYIghdClHUWlpOyRE2quNQOtUSDgFhA== X-Received: by 2002:a7b:c8d7:: with SMTP id f23mr6818891wml.173.1581616641818; Thu, 13 Feb 2020 09:57:21 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 23/30] scripts/qapi/parser.py: improve doc comment indent handling Date: Thu, 13 Feb 2020 17:56:40 +0000 Message-Id: <20200213175647.17628-24-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32b X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Make the handling of indentation in doc comments more sophisticated, so that when we see a section like: Notes: some text some more text indented line 3 we save it for the doc-comment processing code as: some text some more text indented line 3 and when we see a section with the heading on its own line: Notes: some text some more text indented text we also accept that and save it in the same form. The exception is that we always retain indentation as-is for Examples sections, because these are literal text. If we detect that the comment document text is not indented as much as we expect it to be, we throw a parse error. (We don't complain about over-indented sections, because for rST this can be legitimate markup.) The golden reference for the doc comment text is updated to remove the two 'wrong' indents; these now form a test case that we correctly stripped leading whitespace from an indented multi-line argument definition. Signed-off-by: Peter Maydell --- v1->v2: Update doc-good.out as per final para. --- scripts/qapi/parser.py | 82 +++++++++++++++++++++++++++------- tests/qapi-schema/doc-good.out | 4 +- 2 files changed, 67 insertions(+), 19 deletions(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 2196ec5de1e..66f802641c9 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -313,18 +313,32 @@ class QAPIDoc(object): """ =20 class Section(object): - def __init__(self, name=3DNone): + def __init__(self, parser, name=3DNone, indent=3D0): + # parser, for error messages about indentation + self._parser =3D parser # optional section name (argument/member or section name) self.name =3D name # the list of lines for this section self.text =3D '' + # the expected indent level of the text of this section + self._indent =3D indent =20 def append(self, line): + # Strip leading spaces corresponding to the expected indent le= vel + # Blank lines are always OK. + if line: + spacecount =3D len(line) - len(line.lstrip(" ")) + if spacecount > self._indent: + spacecount =3D self._indent + if spacecount < self._indent: + raise QAPIParseError(self._parser, "unexpected de-inde= nt") + line =3D line[spacecount:] + self.text +=3D line.rstrip() + '\n' =20 class ArgSection(Section): - def __init__(self, name): - QAPIDoc.Section.__init__(self, name) + def __init__(self, parser, name, indent=3D0): + QAPIDoc.Section.__init__(self, parser, name, indent) self.member =3D None =20 def connect(self, member): @@ -338,7 +352,7 @@ class QAPIDoc(object): self._parser =3D parser self.info =3D info self.symbol =3D None - self.body =3D QAPIDoc.Section() + self.body =3D QAPIDoc.Section(parser) # dict mapping parameter name to ArgSection self.args =3D OrderedDict() self.features =3D OrderedDict() @@ -443,7 +457,18 @@ class QAPIDoc(object): =20 if name.startswith('@') and name.endswith(':'): line =3D line[len(name)+1:] - self._start_args_section(name[1:-1]) + if not line or line.isspace(): + # Line was just the "@arg:" header; following lines + # are not indented + indent =3D 0 + line =3D '' + else: + # Line is "@arg: first line of description"; following + # lines should be indented by len(name) + 1, and we + # pad out this first line so it is handled the same way + indent =3D len(name) + 1 + line =3D ' ' * indent + line + self._start_args_section(name[1:-1], indent) elif self._is_section_tag(name): self._append_line =3D self._append_various_line self._append_various_line(line) @@ -465,7 +490,17 @@ class QAPIDoc(object): =20 if name.startswith('@') and name.endswith(':'): line =3D line[len(name)+1:] - self._start_features_section(name[1:-1]) + if not line or line.isspace(): + # Line is just the "@name:" header, no ident for following= lines + indent =3D 0 + line =3D '' + else: + # Line is "@arg: first line of description"; following + # lines should be indented by len(name) + 3, and we + # pad out this first line so it is handled the same way + indent =3D len(name) + 1 + line =3D ' ' * indent + line + self._start_features_section(name[1:-1], indent) elif self._is_section_tag(name): self._append_line =3D self._append_various_line self._append_various_line(line) @@ -498,11 +533,23 @@ class QAPIDoc(object): % (name, self.sections[0].name)) elif self._is_section_tag(name): line =3D line[len(name)+1:] - self._start_section(name[:-1]) + if not line or line.isspace(): + # Line is just "SectionName:", no indent for following lin= es + indent =3D 0 + line =3D '' + elif name.startswith("Example"): + # The "Examples" section is literal-text, so preserve + # all the indentation as-is + indent =3D 0 + else: + # Line is "SectionName: some text", indent required + indent =3D len(name) + 1 + line =3D ' ' * indent + line + self._start_section(name[:-1], indent) =20 self._append_freeform(line) =20 - def _start_symbol_section(self, symbols_dict, name): + def _start_symbol_section(self, symbols_dict, name, indent): # FIXME invalid names other than the empty string aren't flagged if not name: raise QAPIParseError(self._parser, "invalid parameter name") @@ -511,21 +558,21 @@ class QAPIDoc(object): "'%s' parameter name duplicated" % name) assert not self.sections self._end_section() - self._section =3D QAPIDoc.ArgSection(name) + self._section =3D QAPIDoc.ArgSection(self._parser, name, indent) symbols_dict[name] =3D self._section =20 - def _start_args_section(self, name): - self._start_symbol_section(self.args, name) + def _start_args_section(self, name, indent): + self._start_symbol_section(self.args, name, indent) =20 - def _start_features_section(self, name): - self._start_symbol_section(self.features, name) + def _start_features_section(self, name, indent): + self._start_symbol_section(self.features, name, indent) =20 - def _start_section(self, name=3DNone): + def _start_section(self, name=3DNone, indent=3D0): if name in ('Returns', 'Since') and self.has_section(name): raise QAPIParseError(self._parser, "duplicated '%s' section" % name) self._end_section() - self._section =3D QAPIDoc.Section(name) + self._section =3D QAPIDoc.Section(self._parser, name, indent) self.sections.append(self._section) =20 def _end_section(self): @@ -548,7 +595,7 @@ class QAPIDoc(object): def connect_member(self, member): if member.name not in self.args: # Undocumented TODO outlaw - self.args[member.name] =3D QAPIDoc.ArgSection(member.name) + self.args[member.name] =3D QAPIDoc.ArgSection(self._parser, me= mber.name) self.args[member.name].connect(member) =20 def connect_feature(self, feature): @@ -556,7 +603,8 @@ class QAPIDoc(object): raise QAPISemError(feature.info, "feature '%s' lacks documentation" % feature.name) - self.features[feature.name] =3D QAPIDoc.ArgSection(feature.nam= e) + self.features[feature.name] =3D QAPIDoc.ArgSection(self._parse= r, + feature.name) self.features[feature.name].connect(feature) =20 def check_expr(self, expr): diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index a65bce639ff..0302ce0bde1 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -144,7 +144,7 @@ doc symbol=3DAlternate =20 arg=3Di an integer - @b is undocumented +@b is undocumented arg=3Db =20 doc freeform @@ -157,7 +157,7 @@ doc symbol=3Dcmd the first argument arg=3Darg2 the second - argument +argument arg=3Darg3 =20 feature=3Dcmd-feat1 --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617673294472.2149147846819; Thu, 13 Feb 2020 10:14:33 -0800 (PST) Received: from localhost ([::1]:57474 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2J0R-0007dQ-B7 for importer@patchew.org; Thu, 13 Feb 2020 13:14:31 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34612) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijx-0000yC-Uh for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:33 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijt-0003Hi-OM for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:29 -0500 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:39694) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijt-0003EP-Dt for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:25 -0500 Received: by mail-wm1-x32f.google.com with SMTP id c84so7796942wme.4 for ; Thu, 13 Feb 2020 09:57:25 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:22 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=eU1u+jVauKyEOYxU8eBl/UNwvFAd782OfHX3aXSqRHM=; b=b5HyZ++uU77W9h+sxUhL9z+nJ9Cr62tP1muyRADwxWugBL22fy4xU86axZrPY6kj6/ LKbT2dHSodm1Js0eHoAYeSwZcE7IvThEkNnijkplm5w/FXdmTf4VnJHzK1+5jHQuePpk DFtekYXYzVQJHoBGTkyIHBdPU5H6RMUYMwNqfpwtlGDeiJ5Ff1f6tpSKnKteDKUXYSpp 1mejyq2+0XzLinZZAPz7P1RcGKKNrQ6WUnlL2BfGpRzw6ZXWqgYdohxyVP6QN/6ceZj2 A0sbh8gu8CNj/QYg7P8ZPHyOCnYPCVjWw86n3zX4RgWi5nQorFRPC3XpmPKgHUJKGcTt noPQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=eU1u+jVauKyEOYxU8eBl/UNwvFAd782OfHX3aXSqRHM=; b=fh4g/KGQjebWZquFh2EhLRuMbtzXsanu+zUlntzUhN8WB6XpeDqj8rypQSTh3Fw12f leR8kPtVxsLNyfWEKIoFaJwgQOKUabfSz0K5AGrAeEDTlVpAzyd1LhiaZRk6RLYDQ5em 36J42S+wXjVOsfwI2FyIPoGo4n7KnCyx9GOa5V0fBEQV3W+YvhZ7FopRR899uB/puATz XnoNg/5RahMaLuGs+FUSTqnQTNCWv7HacPS6j8azUusx+Kv0r3Szvqhf231kY4DILf9K WO8d0G17hW0uHtBY+2u9AG9GZJ6FrUNhVCxcw9I0iW0PEQlJEg4Mi67eNQvx91Ml+lWV 73Ug== X-Gm-Message-State: APjAAAUs4pCdNy2oZu7OHBVDQzyxENTf85g8wG5V5tr23fAmU2g428w8 WWtSEroBT7P0IX3C2UviLXzKLr029T4= X-Google-Smtp-Source: APXvYqxAqf8pGLimR6ixT517GaMZNtqDxbXP0zM80YUpY24FTRgKaNN/wU+FjuLsgY1iv0NUEDKqpg== X-Received: by 2002:a05:600c:2c01:: with SMTP id q1mr6847681wmg.179.1581616643222; Thu, 13 Feb 2020 09:57:23 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 24/30] docs/sphinx: Add new qapi-doc Sphinx extension Date: Thu, 13 Feb 2020 17:56:41 +0000 Message-Id: <20200213175647.17628-25-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32f X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Some of our documentation is auto-generated from documentation comments in the JSON schema. For Sphinx, rather than creating a file to include, the most natural way to handle this is to have a small custom Sphinx extension which processes the JSON file and inserts documentation into the rST file being processed. This is the same approach that kerneldoc and hxtool use. Signed-off-by: Peter Maydell --- MAINTAINERS | 1 + docs/conf.py | 6 +- docs/sphinx/qapidoc.py | 504 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 510 insertions(+), 1 deletion(-) create mode 100644 docs/sphinx/qapidoc.py diff --git a/MAINTAINERS b/MAINTAINERS index c7717df720a..3783ab8e8fd 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2788,3 +2788,4 @@ M: Peter Maydell S: Maintained F: docs/conf.py F: docs/*/conf.py +F: docs/sphinx/ diff --git a/docs/conf.py b/docs/conf.py index 7588bf192ee..1ada0b8f427 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,10 @@ except NameError: # add these directories to sys.path here. If the directory is relative to = the # documentation root, use an absolute path starting from qemu_docdir. # +# Our extensions are in docs/sphinx; the qapidoc extension requires +# the QAPI modules from scripts/. sys.path.insert(0, os.path.join(qemu_docdir, "sphinx")) +sys.path.insert(0, os.path.join(qemu_docdir, "../scripts")) =20 =20 # -- General configuration ------------------------------------------------ @@ -64,7 +67,7 @@ needs_sphinx =3D '1.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions =3D ['kerneldoc', 'qmp_lexer', 'hxtool'] +extensions =3D ['kerneldoc', 'qmp_lexer', 'hxtool', 'qapidoc'] =20 # Add any paths that contain templates here, relative to this directory. templates_path =3D ['_templates'] @@ -232,3 +235,4 @@ texinfo_documents =3D [ kerneldoc_bin =3D os.path.join(qemu_docdir, '../scripts/kernel-doc') kerneldoc_srctree =3D os.path.join(qemu_docdir, '..') hxtool_srctree =3D os.path.join(qemu_docdir, '..') +qapidoc_srctree =3D os.path.join(qemu_docdir, '..') diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py new file mode 100644 index 00000000000..d0dd6e93d4c --- /dev/null +++ b/docs/sphinx/qapidoc.py @@ -0,0 +1,504 @@ +# coding=3Dutf-8 +# +# QEMU qapidoc QAPI file parsing extension +# +# Copyright (c) 2020 Linaro +# +# This work is licensed under the terms of the GNU GPLv2 or later. +# See the COPYING file in the top-level directory. +"""qapidoc is a Sphinx extension that implements the qapi-doc directive""" + +# The purpose of this extension is to read the documentation comments +# in QAPI JSON schema files, and insert them all into the current document. +# The conf.py file must set the qapidoc_srctree config value to +# the root of the QEMU source tree. +# Each qapi-doc:: directive takes one argument which is the +# path of the .json file to process, relative to the source tree. + +import os +import re + +from docutils import nodes +from docutils.statemachine import ViewList +from docutils.parsers.rst import directives, Directive +from sphinx.errors import ExtensionError +from sphinx.util.nodes import nested_parse_with_titles +import sphinx +from qapi.gen import QAPISchemaVisitor +from qapi.schema import QAPIError, QAPISchema + +# Sphinx up to 1.6 uses AutodocReporter; 1.7 and later +# use switch_source_input. Check borrowed from kerneldoc.py. +Use_SSI =3D sphinx.__version__[:3] >=3D '1.7' +if Use_SSI: + from sphinx.util.docutils import switch_source_input +else: + from sphinx.ext.autodoc import AutodocReporter + + +__version__ =3D '1.0' + +# Function borrowed from pydash, which is under the MIT license +def intersperse(iterable, separator): + """Like join, but for arbitrary iterables, notably arrays""" + iterable =3D iter(iterable) + yield next(iterable) + for item in iterable: + yield separator + yield item + +class QAPISchemaGenRSTVisitor(QAPISchemaVisitor): + """A QAPI schema visitor which generates docutils/Sphinx nodes + + This class builds up a tree of docutils/Sphinx nodes corresponding + to documentation for the various QAPI objects. To use it, first create + a QAPISchemaGenRSTVisitor object, and call its visit_begin() method. + Then you can call one of the two methods 'freeform' (to add documentat= ion + for a freeform documentation chunk) or 'symbol' (to add documentation + for a QAPI symbol). These will cause the visitor to build up the + tree of document nodes. Once you've added all the documentation + via 'freeform' and 'symbol' method calls, you can call 'get_document_n= odes' + to get the final list of document nodes (in a form suitable for return= ing + from a Sphinx directive's 'run' method). + """ + def __init__(self, sphinx_directive): + self._cur_doc =3D None + self._sphinx_directive =3D sphinx_directive + self._top_node =3D nodes.section() + self._active_headings =3D [self._top_node] + + def _serror(self, msg): + """Raise an exception giving a user-friendly syntax error message"= "" + file =3D self._cur_doc.info.fname + line =3D self._cur_doc.info.line + raise ExtensionError('%s line %d: syntax error: %s' % (file, line,= msg)) + + def _make_dlitem(self, term, defn): + """Return a dlitem node with the specified term and definition. + + term should be a list of Text and literal nodes. + defn should be one of: + - a string, which will be handed to _parse_text_into_node + - a list of Text and literal nodes, which will be put into + a paragraph node + """ + dlitem =3D nodes.definition_list_item() + dlterm =3D nodes.term('', '', *term) + dlitem +=3D dlterm + if defn: + dldef =3D nodes.definition() + if isinstance(defn, list): + dldef +=3D nodes.paragraph('', '', *defn) + else: + self._parse_text_into_node(defn, dldef) + dlitem +=3D dldef + return dlitem + + def _make_section(self, title): + """Return a section node with optional title""" + section =3D nodes.section(ids=3D[self._sphinx_directive.new_serial= no()]) + if title: + section +=3D nodes.title(title, title) + return section + + def _nodes_for_ifcond(self, ifcond, with_if=3DTrue): + """Return list of Text, literal nodes for the ifcond + + Return a list which gives text like ' (If: cond1, cond2, cond3)', = where + the conditions are in literal-text and the commas are not. + If with_if is False, we don't return the "(If: " and ")". + """ + condlist =3D intersperse([nodes.literal('', c) for c in ifcond], + nodes.Text(', ')) + if not with_if: + return condlist + + nodelist =3D [nodes.Text(' ('), nodes.strong('', 'If: ')] + nodelist.extend(condlist) + nodelist.append(nodes.Text(')')) + return nodelist + + def _nodes_for_one_member(self, member): + """Return list of Text, literal nodes for this member + + Return a list of doctree nodes which give text like + 'name: type (optional) (If: ...)' suitable for use as the + 'term' part of a definition list item. + """ + term =3D [nodes.literal('', member.name)] + if member.type.doc_type(): + term.append(nodes.Text(': ')) + term.append(nodes.literal('', member.type.doc_type())) + if member.optional: + term.append(nodes.Text(' (optional)')) + if member.ifcond: + term.extend(self._nodes_for_ifcond(member.ifcond)) + return term + + def _nodes_for_variant_when(self, variants, variant): + """Return list of Text, literal nodes for variant 'when' clause + + Return a list of doctree nodes which give text like + 'when tagname is variant (If: ...)' suitable for use in + the 'variants' part of a definition list. + """ + term =3D [nodes.Text(' when '), + nodes.literal('', variants.tag_member.name), + nodes.Text(' is '), + nodes.literal('', '"%s"' % variant.name)] + if variant.ifcond: + term.extend(self._nodes_for_ifcond(variant.ifcond)) + return term + + def _nodes_for_members(self, doc, what, base=3DNone, variants=3DNone): + """Return doctree nodes for the table of members""" + dlnode =3D nodes.definition_list() + for section in doc.args.values(): + term =3D self._nodes_for_one_member(section.member) + # TODO drop fallbacks when undocumented members are outlawed + if section.text: + defn =3D section.text + elif (variants and variants.tag_member =3D=3D section.member + and not section.member.type.doc_type()): + values =3D section.member.type.member_names() + defn =3D [nodes.Text('One of ')] + defn.extend(intersperse([nodes.literal('', v) for v in val= ues], + nodes.Text(', '))) + else: + defn =3D [nodes.Text('Not documented')] + + dlnode +=3D self._make_dlitem(term, defn) + + if base: + dlnode +=3D self._make_dlitem([nodes.Text('The members of '), + nodes.literal('', base.doc_type()= )], + None) + + if variants: + for v in variants.variants: + if v.type.is_implicit(): + assert not v.type.base and not v.type.variants + for m in v.type.local_members: + term =3D self._nodes_for_one_member(m) + term.extend(self._nodes_for_variant_when(variants,= v)) + dlnode +=3D self._make_dlitem(term, None) + else: + term =3D [nodes.Text('The members of '), + nodes.literal('', v.type.doc_type())] + term.extend(self._nodes_for_variant_when(variants, v)) + dlnode +=3D self._make_dlitem(term, None) + + if not dlnode.children: + return None + + section =3D self._make_section(what) + section +=3D dlnode + return section + + def _nodes_for_enum_values(self, doc, what): + """Return doctree nodes for the table of enum values""" + seen_item =3D False + dlnode =3D nodes.definition_list() + for section in doc.args.values(): + termtext =3D [nodes.literal('', section.member.name)] + if section.member.ifcond: + termtext.extend(self._nodes_for_ifcond(section.member.ifco= nd)) + # TODO drop fallbacks when undocumented members are outlawed + if section.text: + defn =3D section.text + else: + defn =3D [nodes.Text('Not documented')] + + dlnode +=3D self._make_dlitem(termtext, defn) + seen_item =3D True + + if not seen_item: + return None + + section =3D self._make_section(what) + section +=3D dlnode + return section + + def _nodes_for_arguments(self, doc, boxed_arg_type): + """Return doctree nodes for the arguments section""" + if boxed_arg_type: + assert not doc.args + section =3D self._make_section('Arguments') + dlnode =3D nodes.definition_list() + dlnode +=3D self._make_dlitem( + [nodes.Text('The members of '), + nodes.literal('', boxed_arg_type.name)], + None) + section +=3D dlnode + return section + + return self._nodes_for_members(doc, 'Arguments') + + def _nodes_for_features(self, doc): + """Return doctree nodes for the table of features""" + seen_item =3D False + dlnode =3D nodes.definition_list() + for section in doc.features.values(): + dlnode +=3D self._make_dlitem([nodes.literal('', section.name)= ], + section.text) + seen_item =3D True + + if not seen_item: + return None + + section =3D self._make_section('Features') + section +=3D dlnode + return section + + def _nodes_for_example(self, exampletext): + """Return doctree nodes for a code example snippet""" + return nodes.literal_block(exampletext, exampletext) + + def _nodes_for_sections(self, doc, ifcond): + """Return doctree nodes for additional sections following argument= s""" + nodelist =3D [] + for section in doc.sections: + snode =3D self._make_section(section.name) + if section.name and section.name.startswith('Example'): + snode +=3D self._nodes_for_example(section.text) + else: + self._parse_text_into_node(section.text, snode) + nodelist.append(snode) + if ifcond: + snode =3D self._make_section('If') + snode +=3D self._nodes_for_ifcond(ifcond, with_if=3DFalse) + nodelist.append(snode) + if not nodelist: + return None + return nodelist + + def _add_doc(self, typ, sections): + """Add documentation for a command/object/enum... + + We assume we're documenting the thing defined in self._cur_doc. + typ is the type of thing being added ("Command", "Object", etc) + + sections is a list of nodes for sections to add to the definition. + """ + + doc =3D self._cur_doc + snode =3D nodes.section(ids=3D[self._sphinx_directive.new_serialno= ()]) + snode +=3D nodes.title('', '', *[nodes.literal(doc.symbol, doc.sym= bol), + nodes.Text(' (' + typ + ')')]) + self._parse_text_into_node(doc.body.text, snode) + for s in sections: + if s is not None: + snode +=3D s + self._add_node_to_current_heading(snode) + + def visit_enum_type(self, name, info, ifcond, members, prefix): + doc =3D self._cur_doc + self._add_doc('Enum', + [self._nodes_for_enum_values(doc, 'Values'), + self._nodes_for_features(doc), + self._nodes_for_sections(doc, ifcond)]) + + def visit_object_type(self, name, info, ifcond, base, members, variant= s, + features): + doc =3D self._cur_doc + if base and base.is_implicit(): + base =3D None + self._add_doc('Object', + [self._nodes_for_members(doc, 'Members', base, varia= nts), + self._nodes_for_features(doc), + self._nodes_for_sections(doc, ifcond)]) + + def visit_alternate_type(self, name, info, ifcond, variants): + doc =3D self._cur_doc + self._add_doc('Alternate', + [self._nodes_for_members(doc, 'Members'), + self._nodes_for_features(doc), + self._nodes_for_sections(doc, ifcond)]) + + def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, + success_response, boxed, allow_oob, allow_preconfig, + features): + doc =3D self._cur_doc + self._add_doc('Command', + [self._nodes_for_arguments(doc, + arg_type if boxed else No= ne), + self._nodes_for_features(doc), + self._nodes_for_sections(doc, ifcond)]) + + def visit_event(self, name, info, ifcond, arg_type, boxed): + doc =3D self._cur_doc + self._add_doc('Event', + [self._nodes_for_arguments(doc, + arg_type if boxed else No= ne), + self._nodes_for_features(doc), + self._nodes_for_sections(doc, ifcond)]) + + def symbol(self, doc, entity): + """Add documentation for one symbol to the document tree + + This is the main entry point which causes us to add documentation + nodes for a symbol (which could be a 'command', 'object', 'event', + etc). We do this by calling 'visit' on the schema entity, which + will then call back into one of our visit_* methods, depending + on what kind of thing this symbol is. + """ + self._cur_doc =3D doc + entity.visit(self) + self._cur_doc =3D None + + def _start_new_heading(self, heading, level): + """Start a new heading at the specified heading level + + Create a new section whose title is 'heading' and which is placed + in the docutils node tree as a child of the most recent level-1 + heading. Subsequent document sections (commands, freeform doc chun= ks, + etc) will be placed as children of this new heading section. + """ + if len(self._active_headings) < level: + self._serror('Level %d subheading found outside a level %d hea= ding' + % (level, level - 1)) + snode =3D self._make_section(heading) + self._active_headings[level - 1] +=3D snode + self._active_headings =3D self._active_headings[:level] + self._active_headings.append(snode) + + def _add_node_to_current_heading(self, node): + """Add the node to whatever the current active heading is""" + self._active_headings[-1] +=3D node + + def freeform(self, doc): + """Add a piece of 'freeform' documentation to the document tree + + A 'freeform' document chunk doesn't relate to any particular + symbol (for instance, it could be an introduction). + + As a special case, if the freeform document is a single line + of the form '=3D Heading text' it is treated as a section or subse= ction + heading, with the heading level indicated by the number of '=3D' s= igns. + """ + + # QAPIDoc documentation says free-form documentation blocks + # must have only a body section, nothing else. + assert not doc.sections + assert not doc.args + assert not doc.features + self._cur_doc =3D doc + + if re.match(r'=3D+ ', doc.body.text): + # Section or subsection heading: must be the only thing in the= block + (heading, _, rest) =3D doc.body.text.partition('\n') + if rest !=3D '': + raise ExtensionError('%s line %s: section or subsection he= ading' + ' must be in its own doc comment bloc= k' + % (doc.info.fname, doc.info.line)) + (leader, _, heading) =3D heading.partition(' ') + self._start_new_heading(heading, len(leader)) + return + + node =3D self._make_section(None) + self._parse_text_into_node(doc.body.text, node) + self._add_node_to_current_heading(node) + self._cur_doc =3D None + + def _parse_text_into_node(self, doctext, node): + """Parse a chunk of QAPI-doc-format text into the node + + The doc comment can contain most inline rST markup, including + bulleted and enumerated lists. + As an extra permitted piece of markup, @var will be turned + into ``var``. + """ + + # Handle the "@var means ``var`` case + doctext =3D re.sub(r'@([\w-]+)', r'``\1``', doctext) + + rstlist =3D ViewList() + for line in doctext.splitlines(): + # The reported line number will always be that of the start li= ne + # of the doc comment, rather than the actual location of the e= rror. + # Being more precise would require overhaul of the QAPIDoc cla= ss + # to track lines more exactly within all the sub-parts of the = doc + # comment, as well as counting lines here. + rstlist.append(line, self._cur_doc.info.fname, + self._cur_doc.info.line) + self._sphinx_directive.do_parse(rstlist, node) + + def get_document_nodes(self): + """Return the list of docutils nodes which make up the document""" + return self._top_node.children + +class QAPIDocDirective(Directive): + """Extract documentation from the specified QAPI .json file""" + required_argument =3D 1 + optional_arguments =3D 1 + option_spec =3D { + 'qapifile': directives.unchanged_required + } + has_content =3D False + + def new_serialno(self): + """Return a unique new ID string suitable for use as a node's ID""" + env =3D self.state.document.settings.env + return 'qapidoc-%d' % env.new_serialno('qapidoc') + + def run(self): + env =3D self.state.document.settings.env + qapifile =3D env.config.qapidoc_srctree + '/' + self.arguments[0] + + # Tell sphinx of the dependency + env.note_dependency(os.path.abspath(qapifile)) + + try: + schema =3D QAPISchema(qapifile) + except QAPIError as err: + # Launder QAPI parse errors into Sphinx extension errors + # so they are displayed nicely to the user + raise ExtensionError(str(err)) + + vis =3D QAPISchemaGenRSTVisitor(self) + vis.visit_begin(schema) + for doc in schema.docs: + if doc.symbol: + vis.symbol(doc, schema.lookup_entity(doc.symbol)) + else: + vis.freeform(doc) + + return vis.get_document_nodes() + + def do_parse(self, rstlist, node): + """Parse rST source lines and add them to the specified node + + Take the list of rST source lines rstlist, parse them as + rST, and add the resulting docutils nodes as children of node. + The nodes are parsed in a way that allows them to include + subheadings (titles) without confusing the rendering of + anything else. + """ + # This is from kerneldoc.py -- it works around an API change in + # Sphinx between 1.6 and 1.7. Unlike kerneldoc.py, we use + # sphinx.util.nodes.nested_parse_with_titles() rather than the + # plain self.state.nested_parse(), and so we can drop the saving + # of title_styles and section_level that kerneldoc.py does, + # because nested_parse_with_titles() does that for us. + if Use_SSI: + with switch_source_input(self.state, rstlist): + nested_parse_with_titles(self.state, rstlist, node) + else: + save =3D self.state.memo.reporter + self.state.memo.reporter =3D AutodocReporter(rstlist, + self.state.memo.rep= orter) + try: + nested_parse_with_titles(self.state, rstlist, node) + finally: + self.state.memo.reporter =3D save + +def setup(app): + """ Register qapi-doc directive with Sphinx""" + app.add_config_value('qapidoc_srctree', None, 'env') + app.add_directive('qapi-doc', QAPIDocDirective) + + return dict( + version=3D__version__, + parallel_read_safe=3DTrue, + parallel_write_safe=3DTrue + ) --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617177303952.984881323024; Thu, 13 Feb 2020 10:06:17 -0800 (PST) Received: from localhost ([::1]:57304 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IsR-0004tZ-IX for importer@patchew.org; Thu, 13 Feb 2020 13:06:15 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34610) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijx-0000y7-U6 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Iju-0003KF-HP for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:29 -0500 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]:55365) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Iju-0003HX-8J for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:26 -0500 Received: by mail-wm1-x332.google.com with SMTP id q9so7249351wmj.5 for ; Thu, 13 Feb 2020 09:57:26 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=gQEddq4xa3Ljy8Q3X1Us0Z9sj7tustoyY0agJlhcsXA=; b=bcmSs5siz17wQgHKGsHUOQZjxDwvBGCIosLKKI0NKrLFWZH4SVNGp+QUjfxCz5dhZ4 mwTEaaEW/JPhmud+69tUiR+SoiLCpjGo2+TAMMFBHBUaNyNyRWqSQaswWPhtb9bMM4CR nZncRlyjp0aiF9sVuYOM2PqlqbPcC28sviLAuI0PbXKCNWNtUCb+gbS3qbjX8Q6cL66Z Ii8DN/bQ/FhKypLyVtzV+RduXPUfgoNcSJYBXJFzIPk8kYZtcymtIEGkU6is5Mm8O3pP 92bGZVdFC7xX7IZiMG7lk2rLLNltSg8GNmn51wmbJMppUNqtbhrdkmrbv1cELtlFTILh SCWg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=gQEddq4xa3Ljy8Q3X1Us0Z9sj7tustoyY0agJlhcsXA=; b=laFKxMlAQWMTA/9oETpYYrWRmCU+QBYaXNbi3O0tec6rJNXuSUyTivUgCGqWQlDB35 rX205jFxVhWpgzzvVhLzwXJisAqNE61oXwksEDe6VQIBZl8tH4UeeUA08trkG+Mte4W9 K6aMUkz9uMBvIbM9Q1VGg2AxLTaVsJUT7ZeJNTa2nJBq4GHQQqdEZnsB+zN20VagM6bN sWzO6csb0zdddC22y2UGT2MqlLbUN4VdoYsLFCEFTdMX+Rcu9hKF0C4GVLaBw8Jtpd7T mndexXPbLVdGYl9dG0V5zDJVmim/Yz6P4iYL6QItMbnCJYXdbQ9DYcdsF+Y56/gAhzk9 BajQ== X-Gm-Message-State: APjAAAUPjlXiKC3TATyk/s8dxeL2NM0vGfKvXDl2PMdeW+z1j5XM8cu5 fB1+EuEqZx1WKJfsRM+3ID93cGtm1G0= X-Google-Smtp-Source: APXvYqwsC15M7s6fqAHdSTOoopvnx5yvbpea/i+/DWRfF7i5Etb+EJqExI0zGKw/wwlrTtH7ZXMdcQ== X-Received: by 2002:a05:600c:1007:: with SMTP id c7mr6903131wmc.158.1581616644635; Thu, 13 Feb 2020 09:57:24 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 25/30] docs/interop: Convert qemu-ga-ref to rST Date: Thu, 13 Feb 2020 17:56:42 +0000 Message-Id: <20200213175647.17628-26-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::332 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Convert qemu-ga-ref to rST format. This includes dropping the plain-text, pdf and info format outputs for this document; as with all our other Sphinx-based documentation, we provide HTML and manpage only. The qemu-ga-ref.rst is somewhat more stripped down than the .texi was, because we do not (currently) attempt to generate indexes for the commands, events and data types being documented. As the GA ref is now part of the Sphinx 'interop' manual, we can delete the direct link from index.html.in. Signed-off-by: Peter Maydell --- Makefile | 42 ++++++++---------- MAINTAINERS | 2 +- docs/index.html.in | 1 - docs/interop/conf.py | 2 + docs/interop/index.rst | 1 + docs/interop/qemu-ga-ref.rst | 4 ++ docs/interop/qemu-ga-ref.texi | 80 ----------------------------------- 7 files changed, 25 insertions(+), 107 deletions(-) create mode 100644 docs/interop/qemu-ga-ref.rst delete mode 100644 docs/interop/qemu-ga-ref.texi diff --git a/Makefile b/Makefile index b5a7377cb18..b250c630338 100644 --- a/Makefile +++ b/Makefile @@ -353,7 +353,7 @@ DOCS+=3D$(MANUAL_BUILDDIR)/interop/virtiofsd.1 endif DOCS+=3D$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 DOCS+=3Ddocs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/= interop/qemu-qmp-ref.7 -DOCS+=3Ddocs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/in= terop/qemu-ga-ref.7 +DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7 DOCS+=3Ddocs/qemu-cpu-models.7 DOCS+=3D$(MANUAL_BUILDDIR)/index.html ifdef CONFIG_VIRTFS @@ -762,11 +762,11 @@ distclean: clean rm -f config.log rm -f linux-headers/asm rm -f docs/version.texi - rm -f docs/interop/qemu-ga-qapi.texi docs/interop/qemu-qmp-qapi.texi - rm -f docs/interop/qemu-qmp-ref.7 docs/interop/qemu-ga-ref.7 - rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt - rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf - rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html + rm -f docs/interop/qemu-qmp-qapi.texi + rm -f docs/interop/qemu-qmp-ref.7 + rm -f docs/interop/qemu-qmp-ref.txt + rm -f docs/interop/qemu-qmp-ref.pdf + rm -f docs/interop/qemu-qmp-ref.html rm -f docs/qemu-cpu-models.7 rm -rf .doctrees $(call clean-manual,devel) @@ -820,7 +820,7 @@ endif # and also any sphinx-built manpages. define install-manual =3D for d in $$(cd $(MANUAL_BUILDDIR) && find $1 -type d); do $(INSTALL_DIR) "= $(DESTDIR)$(qemu_docdir)/$$d"; done -for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[= 0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-*-ref.*' ')' ); do $(INSTALL_= DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done +for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[= 0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-qmp-ref.*' ')' ); do $(INSTAL= L_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done endef =20 # Note that we deliberately do not install the "devel" manual: it is @@ -855,9 +855,7 @@ ifdef CONFIG_TRACE_SYSTEMTAP endif ifneq (,$(findstring qemu-ga,$(TOOLS))) $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)= /man8" - $(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7 "$(DESTDIR)$(man= dir)/man7" endif endif ifdef CONFIG_VIRTFS @@ -1047,7 +1045,7 @@ endef $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel) $(call build-manual,devel,html) =20 -$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx +$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json $(qapi-py) $(call build-manual,interop,html) =20 $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) @@ -1057,9 +1055,11 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-= deps,system) $(call build-manual,system,html) =20 $(call define-manpage-rule,interop,\ - qemu-ga.8 qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ + qemu-ga.8 qemu-ga-ref.7 \ + qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ virtiofsd.1 virtfs-proxy-helper.1,\ - $(SRC_PATH)/qemu-img-cmds.hx) + $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json \ + $(qapi-py)) =20 $(call define-manpage-rule,system,qemu-block-drivers.7) =20 @@ -1080,17 +1080,14 @@ qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-in= fo.hx $(SRC_PATH)/scripts/hxt docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi @cp -p $< $@ =20 -docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qga-qapi-doc.texi - @cp -p $< $@ - qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-inf= o.texi qemu.1: qemu-option-trace.texi docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi =20 -html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-re= f.html sphinxdocs -info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-re= f.info -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.p= df -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.t= xt +html: qemu-doc.html docs/interop/qemu-qmp-ref.html sphinxdocs +info: qemu-doc.info docs/interop/qemu-qmp-ref.info +pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf +txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt =20 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-options.texi \ @@ -1099,11 +1096,6 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.tx= t: \ qemu-monitor-info.texi \ docs/qemu-cpu-models.texi docs/security.texi =20 -docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \ - docs/interop/qemu-ga-ref.info docs/interop/qemu-ga-ref.pdf \ - docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7: \ - docs/interop/qemu-ga-ref.texi docs/interop/qemu-ga-qapi.texi - docs/interop/qemu-qmp-ref.dvi docs/interop/qemu-qmp-ref.html \ docs/interop/qemu-qmp-ref.info docs/interop/qemu-qmp-ref.pdf \ docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \ diff --git a/MAINTAINERS b/MAINTAINERS index 3783ab8e8fd..100cf1475b5 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2128,9 +2128,9 @@ M: Michael Roth S: Maintained F: qga/ F: docs/interop/qemu-ga.rst +F: docs/interop/qemu-ga-ref.rst F: scripts/qemu-guest-agent/ F: tests/test-qga.c -F: docs/interop/qemu-ga-ref.texi T: git https://github.com/mdroth/qemu.git qga =20 QOM diff --git a/docs/index.html.in b/docs/index.html.in index 8512933d145..92a057101e6 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -9,7 +9,6 @@
  • User Documentation
  • QMP Reference Manual
    • -
  • Guest Agent Protocol Referenc= e
  • System Emulation Management= and Interoperability Guide
  • System Emulation Guest Hardwa= re Specifications
  • System Emulation User's Guid= e
    • diff --git a/docs/interop/conf.py b/docs/interop/conf.py index b3cda17042c..8c8fce6a4f0 100644 --- a/docs/interop/conf.py +++ b/docs/interop/conf.py @@ -19,6 +19,8 @@ html_theme_options['description'] =3D u'System Emulation = Management and Interopera man_pages =3D [ ('qemu-ga', 'qemu-ga', u'QEMU Guest Agent', ['Michael Roth '], 8), + ('qemu-ga-ref', 'qemu-ga-ref', u'QEMU Guest Agent Protocol Reference', + [], 7), ('qemu-img', 'qemu-img', u'QEMU disk image utility', ['Fabrice Bellard'], 1), ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', diff --git a/docs/interop/index.rst b/docs/interop/index.rst index e8455b4270c..0f33e7d1f76 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -18,6 +18,7 @@ Contents: live-block-operations pr-helper qemu-ga + qemu-ga-ref qemu-img qemu-nbd qemu-trace-stap diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst new file mode 100644 index 00000000000..013eac0bb53 --- /dev/null +++ b/docs/interop/qemu-ga-ref.rst @@ -0,0 +1,4 @@ +QEMU Guest Agent Protocol Reference +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. qapi-doc:: qga/qapi-schema.json diff --git a/docs/interop/qemu-ga-ref.texi b/docs/interop/qemu-ga-ref.texi deleted file mode 100644 index ddb76ce1c2a..00000000000 --- a/docs/interop/qemu-ga-ref.texi +++ /dev/null @@ -1,80 +0,0 @@ -\input texinfo -@setfilename qemu-ga-ref.info - -@include version.texi - -@exampleindent 0 -@paragraphindent 0 - -@settitle QEMU Guest Agent Protocol Reference - -@iftex -@center @image{docs/qemu_logo} -@end iftex - -@copying -This is the QEMU Guest Agent Protocol reference manual. - -Copyright @copyright{} 2016 The QEMU Project developers - -@quotation -This manual is free documentation: you can redistribute it and/or -modify it under the terms of the GNU General Public License as -published by the Free Software Foundation, either version 2 of the -License, or (at your option) any later version. - -This manual is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this manual. If not, see http://www.gnu.org/licenses/. -@end quotation -@end copying - -@dircategory QEMU -@direntry -* QEMU-GA-Ref: (qemu-ga-ref). QEMU Guest Agent Protocol Reference -@end direntry - -@titlepage -@title Guest Agent Protocol Reference Manual -@subtitle QEMU version @value{VERSION} -@page -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@contents - -@ifnottex -@node Top -@top QEMU Guest Agent protocol reference -@end ifnottex - -@menu -* API Reference:: -* Commands and Events Index:: -* Data Types Index:: -@end menu - -@node API Reference -@chapter API Reference - -@c for texi2pod: -@c man begin DESCRIPTION - -@include qemu-ga-qapi.texi - -@c man end - -@node Commands and Events Index -@unnumbered Commands and Events Index -@printindex fn - -@node Data Types Index -@unnumbered Data Types Index -@printindex tp - -@bye --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617825793284.81870124618945; Thu, 13 Feb 2020 10:17:05 -0800 (PST) Received: from localhost ([::1]:57528 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2J2u-000192-9D for importer@patchew.org; Thu, 13 Feb 2020 13:17:04 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34684) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijz-00010h-Jq for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:33 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijw-0003O4-VW for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:31 -0500 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:46096) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijw-0003LJ-O6 for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:28 -0500 Received: by mail-wr1-x432.google.com with SMTP id z7so7790338wrl.13 for ; Thu, 13 Feb 2020 09:57:28 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=jY95SHE3AsQHWHx0vvwY4a42XKSNZL2pykwZHwEi0F0=; b=SmE/1MK/yDLE4cbx66uz6eFstwruZUV6fZQnuszPhzrkq/XmRf/H1wrIbFRb2ErIVX N2I0356FsX10bIjln2dQN5EU8/pPCjmwh4W2IRDcWjBWbYvrXGjv79qXMtNjqZds0nv1 nhaV9H7FXkZAxnseebPS4WS6wgamf/IZEmU7FZOccTWWLTwWVe54XbW5t5GGEzuCa7Wc hxS4ImYbEq5zOryKineSVxGRvOqHX79P51wkwG63zCG54XcerDvU/Mc5w5rVWSqdbFpq 0eH0XfgLF6OiOl96KJPJwIsk1kBBCk+Y+x7NUzFlPsa4xt02j75ECE1irJBxlRNvpYqd uTIA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=jY95SHE3AsQHWHx0vvwY4a42XKSNZL2pykwZHwEi0F0=; b=j/QwSR54th020/W6hflnX0xAvsUT1cymP5TbptecIOtu4PWGMDpvWO0FkYZbCr0rtS VTcKs3i7WW6iQJYFy5KXZX+Kh6goimy71LNQpw+4JxSAKvW0a/kT/5JtiMh9I36JvLcv mRc5i/AE1UE3yYIu611Pans1sX33178GOvJxrkUCrwbfpxdNEfW1YZ0bXh2P2fsOEbwa d6S74S+e8MlfIWFxKE/tjYyf9JgtBBc97H8zotLKgi+3pa+vgTLenbwQ+4t4PngY+5XI 71ntGA+6Cn79wPd3+4RSfCpPUeyWPmbeJ8GkPsdcAX4otr/JZGy1RalbFbcGv58nCccm TfRA== X-Gm-Message-State: APjAAAWW2Bstj5r//nHPZ3YNx5esRlvDcpFQPi3Oqw4SyRtrdZsMfmXc qpFgvFSyceL1DeY696h+WIfMH7uT4ak= X-Google-Smtp-Source: APXvYqzRN45V2XHILl6KCUsz1aB14lQPOmrxWy5eqbet7BWdSdbEO036QdcrlZeNu0It8VZ3/OnCPQ== X-Received: by 2002:adf:a746:: with SMTP id e6mr22784816wrd.329.1581616646065; Thu, 13 Feb 2020 09:57:26 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 26/30] docs/interop: Convert qemu-qmp-ref to rST Date: Thu, 13 Feb 2020 17:56:43 +0000 Message-Id: <20200213175647.17628-27-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::432 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Convert qemu-qmp-ref to rST format. This includes dropping the plain-text, pdf and info format outputs for this document; as with all our other Sphinx-based documentation, we provide HTML and manpage only. The qemu-qmp-ref.rst is somewhat more stripped down than the .texi was, because we do not (currently) attempt to generate indexes for the commands, events and data types being documented. Again, we drop the direct link from index.html.in now that the QMP ref is part of the interop manual. Signed-off-by: Peter Maydell --- Makefile | 37 +++++----------- docs/index.html.in | 1 - docs/interop/conf.py | 2 + docs/interop/index.rst | 1 + docs/interop/qemu-qmp-ref.rst | 4 ++ docs/interop/qemu-qmp-ref.texi | 80 ---------------------------------- 6 files changed, 17 insertions(+), 108 deletions(-) create mode 100644 docs/interop/qemu-qmp-ref.rst delete mode 100644 docs/interop/qemu-qmp-ref.texi diff --git a/Makefile b/Makefile index b250c630338..f708eb8dc44 100644 --- a/Makefile +++ b/Makefile @@ -126,7 +126,6 @@ GENERATED_QAPI_FILES +=3D qapi/qapi-events.h qapi/qapi-= events.c GENERATED_QAPI_FILES +=3D $(QAPI_MODULES:%=3Dqapi/qapi-events-%.h) GENERATED_QAPI_FILES +=3D $(QAPI_MODULES:%=3Dqapi/qapi-events-%.c) GENERATED_QAPI_FILES +=3D qapi/qapi-introspect.c qapi/qapi-introspect.h -GENERATED_QAPI_FILES +=3D qapi/qapi-doc.texi =20 generated-files-y +=3D $(GENERATED_QAPI_FILES) =20 @@ -352,8 +351,8 @@ ifeq ($(CONFIG_LINUX)$(CONFIG_SECCOMP)$(CONFIG_LIBCAP_N= G),yyy) DOCS+=3D$(MANUAL_BUILDDIR)/interop/virtiofsd.1 endif DOCS+=3D$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 -DOCS+=3Ddocs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/= interop/qemu-qmp-ref.7 DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-ga-ref.7 +DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-qmp-ref.7 DOCS+=3Ddocs/qemu-cpu-models.7 DOCS+=3D$(MANUAL_BUILDDIR)/index.html ifdef CONFIG_VIRTFS @@ -615,8 +614,7 @@ $(SRC_PATH)/scripts/qapi-gen.py qga/qapi-generated/qga-qapi-types.c qga/qapi-generated/qga-qapi-types.h \ qga/qapi-generated/qga-qapi-visit.c qga/qapi-generated/qga-qapi-visit.h \ qga/qapi-generated/qga-qapi-commands.h qga/qapi-generated/qga-qapi-command= s.c \ -qga/qapi-generated/qga-qapi-init-commands.h qga/qapi-generated/qga-qapi-in= it-commands.c \ -qga/qapi-generated/qga-qapi-doc.texi: \ +qga/qapi-generated/qga-qapi-init-commands.h qga/qapi-generated/qga-qapi-in= it-commands.c: \ qga/qapi-generated/qapi-gen-timestamp ; qga/qapi-generated/qapi-gen-timestamp: $(SRC_PATH)/qga/qapi-schema.json $(= qapi-py) $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \ @@ -762,11 +760,6 @@ distclean: clean rm -f config.log rm -f linux-headers/asm rm -f docs/version.texi - rm -f docs/interop/qemu-qmp-qapi.texi - rm -f docs/interop/qemu-qmp-ref.7 - rm -f docs/interop/qemu-qmp-ref.txt - rm -f docs/interop/qemu-qmp-ref.pdf - rm -f docs/interop/qemu-qmp-ref.html rm -f docs/qemu-cpu-models.7 rm -rf .doctrees $(call clean-manual,devel) @@ -820,7 +813,7 @@ endif # and also any sphinx-built manpages. define install-manual =3D for d in $$(cd $(MANUAL_BUILDDIR) && find $1 -type d); do $(INSTALL_DIR) "= $(DESTDIR)$(qemu_docdir)/$$d"; done -for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' '(' -name '*.[= 0-9]' -o -name 'qemu-*-qapi.*' -o -name 'qemu-qmp-ref.*' ')' ); do $(INSTAL= L_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$$f"; done +for f in $$(cd $(MANUAL_BUILDDIR) && find $1 -type f -a '!' -name '*.[0-9]= '); do $(INSTALL_DATA) "$(MANUAL_BUILDDIR)/$$f" "$(DESTDIR)$(qemu_docdir)/$= $f"; done endef =20 # Note that we deliberately do not install the "devel" manual: it is @@ -836,13 +829,11 @@ install-doc: $(DOCS) install-sphinxdocs $(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.html "$(DESTDIR)$(qemu_docdir)" $(INSTALL_DATA) qemu-doc.txt "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)" - $(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)" ifdef CONFIG_POSIX $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1" $(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7" - $(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-qmp-ref.7 "$(DESTDIR)$(ma= ndir)/man7" $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR= )$(mandir)/man7" $(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7" ifeq ($(CONFIG_TOOLS),y) @@ -1045,7 +1036,7 @@ endef $(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel) $(call build-manual,devel,html) =20 -$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json $(qapi-py) +$(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop) $(SRC_P= ATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json $(qapi-modules) $(qa= pi-py) $(call build-manual,interop,html) =20 $(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs) @@ -1059,7 +1050,7 @@ $(call define-manpage-rule,interop,\ qemu-img.1 qemu-nbd.8 qemu-trace-stap.1\ virtiofsd.1 virtfs-proxy-helper.1,\ $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/qga/qapi-schema.json \ - $(qapi-py)) + $(qapi-modules) $(qapi-py)) =20 $(call define-manpage-rule,system,qemu-block-drivers.7) =20 @@ -1077,17 +1068,14 @@ qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx $(SR= C_PATH)/scripts/hxtool qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/scrip= ts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") =20 -docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi - @cp -p $< $@ - qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-inf= o.texi qemu.1: qemu-option-trace.texi docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi =20 -html: qemu-doc.html docs/interop/qemu-qmp-ref.html sphinxdocs -info: qemu-doc.info docs/interop/qemu-qmp-ref.info -pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf -txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt +html: qemu-doc.html sphinxdocs +info: qemu-doc.info +pdf: qemu-doc.pdf +txt: qemu-doc.txt =20 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ qemu-options.texi \ @@ -1096,11 +1084,6 @@ qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.tx= t: \ qemu-monitor-info.texi \ docs/qemu-cpu-models.texi docs/security.texi =20 -docs/interop/qemu-qmp-ref.dvi docs/interop/qemu-qmp-ref.html \ - docs/interop/qemu-qmp-ref.info docs/interop/qemu-qmp-ref.pdf \ - docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7: \ - docs/interop/qemu-qmp-ref.texi docs/interop/qemu-qmp-qapi.texi - $(filter %.1 %.7 %.8,$(DOCS)): scripts/texi2pod.pl =20 # Reports/Analysis diff --git a/docs/index.html.in b/docs/index.html.in index 92a057101e6..ba7cd611d26 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -8,7 +8,6 @@

    QEMU @@VERSION@@ Documentation

    • User Documentation
      • -
    • QMP Reference Manual
    • System Emulation Management= and Interoperability Guide
    • System Emulation Guest Hardwa= re Specifications
    • System Emulation User's Guid= e
      • diff --git a/docs/interop/conf.py b/docs/interop/conf.py index 8c8fce6a4f0..d208a8d2862 100644 --- a/docs/interop/conf.py +++ b/docs/interop/conf.py @@ -25,6 +25,8 @@ man_pages =3D [ ['Fabrice Bellard'], 1), ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', ['Anthony Liguori '], 8), + ('qemu-qmp-ref', 'qemu-qmp-ref', u'QEMU QMP Reference Manual', + [], 7), ('qemu-trace-stap', 'qemu-trace-stap', u'QEMU SystemTap trace tool', [], 1), ('virtfs-proxy-helper', 'virtfs-proxy-helper', diff --git a/docs/interop/index.rst b/docs/interop/index.rst index 0f33e7d1f76..cac8988865c 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -21,6 +21,7 @@ Contents: qemu-ga-ref qemu-img qemu-nbd + qemu-qmp-ref qemu-trace-stap vhost-user vhost-user-gpu diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst new file mode 100644 index 00000000000..e640903abaf --- /dev/null +++ b/docs/interop/qemu-qmp-ref.rst @@ -0,0 +1,4 @@ +QEMU QMP Reference Manual +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D + +.. qapi-doc:: qapi/qapi-schema.json diff --git a/docs/interop/qemu-qmp-ref.texi b/docs/interop/qemu-qmp-ref.texi deleted file mode 100644 index bb25758bd02..00000000000 --- a/docs/interop/qemu-qmp-ref.texi +++ /dev/null @@ -1,80 +0,0 @@ -\input texinfo -@setfilename qemu-qmp-ref.info - -@include version.texi - -@exampleindent 0 -@paragraphindent 0 - -@settitle QEMU QMP Reference Manual - -@iftex -@center @image{docs/qemu_logo} -@end iftex - -@copying -This is the QEMU QMP reference manual. - -Copyright @copyright{} 2016 The QEMU Project developers - -@quotation -This manual is free documentation: you can redistribute it and/or -modify it under the terms of the GNU General Public License as -published by the Free Software Foundation, either version 2 of the -License, or (at your option) any later version. - -This manual is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this manual. If not, see http://www.gnu.org/licenses/. -@end quotation -@end copying - -@dircategory QEMU -@direntry -* QEMU-QMP-Ref: (qemu-qmp-ref). QEMU QMP Reference Manual -@end direntry - -@titlepage -@title QMP Reference Manual -@subtitle QEMU version @value{VERSION} -@page -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@contents - -@ifnottex -@node Top -@top QEMU QMP reference -@end ifnottex - -@menu -* API Reference:: -* Commands and Events Index:: -* Data Types Index:: -@end menu - -@node API Reference -@chapter API Reference - -@c for texi2pod: -@c man begin DESCRIPTION - -@include qemu-qmp-qapi.texi - -@c man end - -@node Commands and Events Index -@unnumbered Commands and Events Index -@printindex fn - -@node Data Types Index -@unnumbered Data Types Index -@printindex tp - -@bye --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617347738961.9406227607566; Thu, 13 Feb 2020 10:09:07 -0800 (PST) Received: from localhost ([::1]:57354 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Iv9-0008KU-H8 for importer@patchew.org; Thu, 13 Feb 2020 13:09:04 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34662) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijz-00010Y-0B for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:33 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijx-0003QE-Oa for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:30 -0500 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:37695) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijx-0003Mb-Eb for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:29 -0500 Received: by mail-wr1-x434.google.com with SMTP id w15so7813900wru.4 for ; Thu, 13 Feb 2020 09:57:29 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=0wlRVtRJhL4sdvkTCyYM1sERkCXT4sx5Lv57A2FYC0k=; b=s0z6DGXxQ+Q0n7fR9h+n2+o3MJX9auAuuc8UaKzrcJfGa7cJ9tdZ2aqNju8Zfft1LP N4LkE9m9xM6aUUVAKFpiN+CnKEhPW6wvo2D6e1RtZFrUv0AcTHejNG4M0c9GJmCJKqEJ Mex+NXoY+nWEkRtI0JLzEkk4T53PGaOAIq60FWevFKPrgpkIXNl1VDye1GaAyOeXJxgA zyeXYLz+ZW8liLfckXp5+STqRwr1zaN/bRAes4X+ivYR45GPtFP9JqAvirE/j7+9HlDV c4i8twuf9H2gK8l9w8TA6871cZnq6TUB0eURjyonurk+CT5lBaTbxk4k94Sd0D+FNCHt Rglw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=0wlRVtRJhL4sdvkTCyYM1sERkCXT4sx5Lv57A2FYC0k=; b=sQQtfdsCPEaG6cEk25JjFy763hHwlECJ8tHqnzHjdJHNfOMzfMWsphfCSBVE5AktHv FtWLK0IeDOJ3CfRvurLiqXnFzkqKZZLUHXn4CZTGS9cFs2DgUjaVmGgWJ+z8tzWksGqN aTlMSSLM7nhxcOmLODZhAvJgcfqw8nXKy2Z13jqflV7v+8iJqvIzIzhH7ZPCQeDFact6 r18ZHSsYQqFOB10hSI5BxrfFqrGFUokCVEUcPe2mYGhFkXHw6rEhZbql89vzBGZnq+PR kL1/2b2RiCCgoUdFU22YCuIirtko1/EdxI2uM1dx7d0LP3WLKer8dcOvmYRDCay85C+G Xc1Q== X-Gm-Message-State: APjAAAVqSDtm0lU2SPXxuF1jT/Qmv5vOisEQHEQBFZlXtTjC/VqIGajg vxKkLOSKZCv+N17ImGQfiDJRPRAGdzQ= X-Google-Smtp-Source: APXvYqzMifq59Um0DkSaoqG4zbYSfzFJv0ayj7C3P1R+P9J9cAuKe6+AzZAv/XXawoCVhkEzP2rtkA== X-Received: by 2002:adf:f1cb:: with SMTP id z11mr22059428wro.375.1581616647263; Thu, 13 Feb 2020 09:57:27 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 27/30] qapi: Use rST markup for literal blocks Date: Thu, 13 Feb 2020 17:56:44 +0000 Message-Id: <20200213175647.17628-28-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::434 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" There are exactly two places in our json doc comments where we use the markup accepted by the texi doc generator where a '|' in the first line of a doc comment means the line should be emitted as a literal block (fixed-width font, whitespace preserved). Since we use this syntax so rarely, instead of making the rST generator support it, instead just convert the two uses to rST-format literal blocks, which are indented and introduced with '::'. (The rST generator doesn't complain about the old style syntax, it just emits it with the '|' and with the whitespace not preserved, which looks odd, but means we can safely leave this change until after we've stopped generating texinfo.) Signed-off-by: Peter Maydell --- qapi/block-core.json | 16 +++++++++------- qapi/qapi-schema.json | 6 ++++-- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index 13dad62f441..ea0371c33fb 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -550,13 +550,15 @@ # For the example above, @bins may be something like [3, 1, 5, 2], # and corresponding histogram looks like: # -# | 5| * -# | 4| * -# | 3| * * -# | 2| * * * -# | 1| * * * * -# | +------------------ -# | 10 50 100 +# :: +# +# 5| * +# 4| * +# 3| * * +# 2| * * * +# 1| * * * * +# +------------------ +# 10 50 100 # # Since: 4.0 ## diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json index f7ba60a5d0b..1d3fb573846 100644 --- a/qapi/qapi-schema.json +++ b/qapi/qapi-schema.json @@ -22,8 +22,10 @@ # # Example: # -# | -> data issued by the Client -# | <- Server data response +# :: +# +# -> data issued by the Client +# <- Server data response # # Please, refer to the QMP specification (docs/interop/qmp-spec.txt) for # detailed information on the Server command and response formats. --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617367197195.0123242048312; Thu, 13 Feb 2020 10:09:27 -0800 (PST) Received: from localhost ([::1]:57362 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2IvV-0000Vc-ML for importer@patchew.org; Thu, 13 Feb 2020 13:09:26 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34668) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ijz-00010f-7R for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ijy-0003Qf-8E for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:31 -0500 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]:52258) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijx-0003OE-MC for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:29 -0500 Received: by mail-wm1-x344.google.com with SMTP id p9so7260530wmc.2 for ; Thu, 13 Feb 2020 09:57:29 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ct264XXsXB4Yfv0geBlQAhYKTLlUfdyjxR0wyex+U9E=; b=vy69K30E8Tpow7RS6CiPJZqBqe3hGrvGx7JEt2rZiJfq/XEKyKSoqJgM7cqQNWy0om R8K2ScwnoNun3EBxvPvmqW7dvHS7mih3M5T9uQOyuxxObnvdWTUQv9fIULodbx54Dr38 A8qYoI3czQtXZPGK5pvLqJprf3r7Z3KEaDoZt9XZ3rsvmIlUVhRN3Adq7735fQKJmEP5 cN+y+CK6d7sPv8LviGHGRQdB/BBQ96d7n/YUt70ASj9dEzPDXARADZMOpBBBdM3bOmIk WWZNhgIWKPqwbVLZLdJ4dscdfG0MpO0vmjpjmX6kaEAj4sNSUM7z0+lLnkL2DMFhtBR4 1j1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ct264XXsXB4Yfv0geBlQAhYKTLlUfdyjxR0wyex+U9E=; b=PVHYjbT7gcpBoA80MLMl1+OrU/jrfsjt6MJLUwtqY1SQL6cQOWaP9zUOz2sZgbcPTL oX2eWmUUM4w4s3ey4oQeooTsnKyfwT9OnQZpzyoYtuFcXSg2BZWqMOo1AE/ocTo24FaF /aAbEt070XAUUWZKoQ8YEfiWjLXIy2C5ewZ/WqBvbFKf1exlEcX22vlrpkDulGBGTypu 1csONl1FrYfGVzxYhIsvwET7b1lRlAo/PdWKLliOj8PTHYY21HMIjZl4DCHRzRvBlFFo f7BM1WB14QrZpy8Hje2lLD+5KitTPchdHQNxcai1yhyVL93123hGpZihDFR38H+Xtr+K JIGQ== X-Gm-Message-State: APjAAAXtjJEhP2pLEfkgTlZJgvP2jGV8uDFZXpk6eM3fbabvbP1ZXF6C Z1vZArjktW9XT2MrKZ/DVJnYFio6Rag= X-Google-Smtp-Source: APXvYqzWMKxWaYMNG0D1Yi5KNLoRFDPgWALnrabznY45XJjxyvlu0s55ePaCXVt8nFcUlRyOsfvZ8Q== X-Received: by 2002:a05:600c:2301:: with SMTP id 1mr7090137wmo.147.1581616648392; Thu, 13 Feb 2020 09:57:28 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 28/30] qga/qapi-schema.json: Add some headings Date: Thu, 13 Feb 2020 17:56:45 +0000 Message-Id: <20200213175647.17628-29-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::344 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Add some section headings to the QGA json; this is purely so that we have some H1 headings, as otherwise each command ends up being visible in the interop/ manual's table of contents. In an ideal world there might be a proper 'Introduction' section the way there is in qapi/qapi-schema.json. Signed-off-by: Peter Maydell --- qga/qapi-schema.json | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index f6fcb59f34b..d026f9478cf 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -1,14 +1,18 @@ # *-*- Mode: Python -*-* =20 ## -# -# General note concerning the use of guest agent interfaces: -# +# =3D General note concerning the use of guest agent interfaces +## + +## # "unsupported" is a higher-level error than the errors that individual # commands might document. The caller should always be prepared to receive # QERR_UNSUPPORTED, even if the given command doesn't specify it, or doesn= 't # document any failure mode at all. -# +## + +## +# =3D QEMU guest agent protocol commands and structs ## =20 { 'pragma': { 'doc-required': true } } --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617500741553.7243872002459; Thu, 13 Feb 2020 10:11:40 -0800 (PST) Received: from localhost ([::1]:57418 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ixf-0003kj-BW for importer@patchew.org; Thu, 13 Feb 2020 13:11:39 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34851) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ik3-00015L-3t for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:37 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ik0-0003V7-4Z for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:35 -0500 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]:51700) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ijz-0003Sw-OD for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:32 -0500 Received: by mail-wm1-x344.google.com with SMTP id t23so7261584wmi.1 for ; Thu, 13 Feb 2020 09:57:31 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=JrrTtIs4qMcc2oqixEEJxg51omh1H7hc+6Gul7Fkbac=; b=ii2QTKbaTvykl9LQovxsz47jBR0+/bgpHwWhajTwwebJcyc0oc7MBDJKockcbhSOvn SzY93YqNLvCkxV5iYoZiAhOvQRlu04U8oDKfwFhaPWWqtLGe8KUMzEfg9Aw+D5/wVm1o Meixyao+vZPYLUB4wluecf3RfZoVxGBZz0kVqfaJ8tX2g37S6wawOJ8pAOhws4evr/8j gOU6ZJ+pQU7NtNkz93rEf8YaFI5lOM8p74Xh9yN/ki1rV7YeF6+B5LwpQF+NPy5N6bps mx2ZozRIvhusYTKVw+TeQPz/aW5DEB5af2Z+0MbDPSrOCmlIAd9/cuj0nqv8YpWC8try wE0Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=JrrTtIs4qMcc2oqixEEJxg51omh1H7hc+6Gul7Fkbac=; b=Wj6JRtIBIN50LTGpI9Ds2fdqT8M7bM3G+tlQ4Y0uJn/Q1DA9SjOhZjEo1bwKTDXbmF CAdNg6YUocoPpk4HorovugRbRlE/jQUnfLheaJqOxKzURjKPx4DKqxEpnWSUHXSHR/Rm 8+eowKF4QHHg4DEC6dIh4Jdyo1r87j22DrV8C+gvDb5M3U2qsrftIb+fAzAD+01wY1XM nvJlH/uKqjSizcVbdghoxt82RShreN2njq6KBxcGOLlkI0sPthFAVO8DDG8tGrWFb3rJ G33MAYr8Pa/KaCG4H88J1t0t3pxgBr8kq8CMM3NASYDG2Roif0qg738So4N9lcn+/GgM ImkQ== X-Gm-Message-State: APjAAAXRthOcvxQ9+9EWEIWXqLs1HMlWQ8lFrjofagmTX+NSTUCGLcvR O+hbQHBJkI6nkPxUJ1gX+YkuextqQDk= X-Google-Smtp-Source: APXvYqySzdAMSzeAn3MmL+CFBZ75qNqoBS7WcCDNrNnRdlb62p6EvksGj1NpBV0Fj1SgbELdH7t4Yw== X-Received: by 2002:a7b:cbcf:: with SMTP id n15mr6931613wmi.21.1581616649804; Thu, 13 Feb 2020 09:57:29 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 29/30] scripts/qapi: Remove texinfo generation support Date: Thu, 13 Feb 2020 17:56:46 +0000 Message-Id: <20200213175647.17628-30-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::344 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" We no longer use the generated texinfo format documentation, so delete the code that generates it, and the test case for the generation. Signed-off-by: Peter Maydell --- Makefile | 1 - tests/Makefile.include | 15 +- scripts/qapi-gen.py | 2 - scripts/qapi/doc.py | 302 -------------------------------- scripts/qapi/gen.py | 7 - tests/qapi-schema/doc-good.texi | 281 ----------------------------- 6 files changed, 1 insertion(+), 607 deletions(-) delete mode 100644 scripts/qapi/doc.py delete mode 100644 tests/qapi-schema/doc-good.texi diff --git a/Makefile b/Makefile index f708eb8dc44..687a17dc0cb 100644 --- a/Makefile +++ b/Makefile @@ -598,7 +598,6 @@ qemu-keymap$(EXESUF): QEMU_CFLAGS +=3D $(XKBCOMMON_CFLA= GS) qapi-py =3D $(SRC_PATH)/scripts/qapi/__init__.py \ $(SRC_PATH)/scripts/qapi/commands.py \ $(SRC_PATH)/scripts/qapi/common.py \ -$(SRC_PATH)/scripts/qapi/doc.py \ $(SRC_PATH)/scripts/qapi/error.py \ $(SRC_PATH)/scripts/qapi/events.py \ $(SRC_PATH)/scripts/qapi/expr.py \ diff --git a/tests/Makefile.include b/tests/Makefile.include index 2f1cafed720..ee766a77091 100644 --- a/tests/Makefile.include +++ b/tests/Makefile.include @@ -32,7 +32,6 @@ export SRC_PATH qapi-py =3D $(SRC_PATH)/scripts/qapi/__init__.py \ $(SRC_PATH)/scripts/qapi/commands.py \ $(SRC_PATH)/scripts/qapi/common.py \ -$(SRC_PATH)/scripts/qapi/doc.py \ $(SRC_PATH)/scripts/qapi/error.py \ $(SRC_PATH)/scripts/qapi/events.py \ $(SRC_PATH)/scripts/qapi/expr.py \ @@ -486,16 +485,8 @@ tests/test-qapi-gen-timestamp: \ $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \ -o tests -p "test-" $<, \ "GEN","$(@:%-timestamp=3D%)") - @rm -f tests/test-qapi-doc.texi @>$@ =20 -tests/qapi-schema/doc-good.test.texi: $(SRC_PATH)/tests/qapi-schema/doc-go= od.json $(qapi-py) - $(call quiet-command,$(PYTHON) $(SRC_PATH)/scripts/qapi-gen.py \ - -o tests/qapi-schema -p "doc-good-" $<, \ - "GEN","$@") - @mv tests/qapi-schema/doc-good-qapi-doc.texi $@ - @rm -f tests/qapi-schema/doc-good-qapi-*.[ch] tests/qapi-schema/doc-good-= qmp-*.[ch] - tests/qtest/dbus-vmstate1.h tests/qtest/dbus-vmstate1.c: tests/qtest/dbus-= vmstate1-gen-timestamp ; tests/qtest/dbus-vmstate1-gen-timestamp: $(SRC_PATH)/tests/qtest/dbus-vmst= ate1.xml $(call quiet-command,$(GDBUS_CODEGEN) $< \ @@ -847,10 +838,6 @@ check-tests/qapi-schema/frontend: $(addprefix $(SRC_PA= TH)/, $(check-qapi-schema- PYTHONIOENCODING=3Dutf-8 $(PYTHON) $(SRC_PATH)/tests/qapi-schema/test-q= api.py $^, \ TEST, check-qapi-schema) =20 -.PHONY: check-tests/qapi-schema/doc-good.texi -check-tests/qapi-schema/doc-good.texi: tests/qapi-schema/doc-good.test.texi - @diff -u $(SRC_PATH)/tests/qapi-schema/doc-good.texi $< - .PHONY: check-decodetree check-decodetree: $(call quiet-command, \ @@ -898,7 +885,7 @@ check-acceptance: check-venv $(TESTS_RESULTS_DIR) # Consolidated targets =20 .PHONY: check-block check-qapi-schema check-qtest check-unit check check-c= lean -check-qapi-schema: check-tests/qapi-schema/frontend check-tests/qapi-schem= a/doc-good.texi +check-qapi-schema: check-tests/qapi-schema/frontend check-qtest: $(patsubst %,check-qtest-%, $(QTEST_TARGETS)) ifeq ($(CONFIG_TOOLS),y) check-block: $(patsubst %,check-%, $(check-block-y)) diff --git a/scripts/qapi-gen.py b/scripts/qapi-gen.py index 4b03f7d53be..541e8c1f55d 100755 --- a/scripts/qapi-gen.py +++ b/scripts/qapi-gen.py @@ -10,7 +10,6 @@ import re import sys =20 from qapi.commands import gen_commands -from qapi.doc import gen_doc from qapi.events import gen_events from qapi.introspect import gen_introspect from qapi.schema import QAPIError, QAPISchema @@ -51,7 +50,6 @@ def main(argv): gen_commands(schema, args.output_dir, args.prefix) gen_events(schema, args.output_dir, args.prefix) gen_introspect(schema, args.output_dir, args.prefix, args.unmask) - gen_doc(schema, args.output_dir, args.prefix) =20 =20 if __name__ =3D=3D '__main__': diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py deleted file mode 100644 index 26cd1a1751e..00000000000 --- a/scripts/qapi/doc.py +++ /dev/null @@ -1,302 +0,0 @@ -# QAPI texi generator -# -# This work is licensed under the terms of the GNU LGPL, version 2+. -# See the COPYING file in the top-level directory. -"""This script produces the documentation of a qapi schema in texinfo form= at""" - -import re -from qapi.gen import QAPIGenDoc, QAPISchemaVisitor - - -MSG_FMT =3D """ -@deftypefn {type} {{}} {name} - -{body}{members}{features}{sections} -@end deftypefn - -""".format - -TYPE_FMT =3D """ -@deftp {{{type}}} {name} - -{body}{members}{features}{sections} -@end deftp - -""".format - -EXAMPLE_FMT =3D """@example -{code} -@end example -""".format - - -def subst_strong(doc): - """Replaces *foo* by @strong{foo}""" - return re.sub(r'\*([^*\n]+)\*', r'@strong{\1}', doc) - - -def subst_emph(doc): - """Replaces _foo_ by @emph{foo}""" - return re.sub(r'\b_([^_\n]+)_\b', r'@emph{\1}', doc) - - -def subst_vars(doc): - """Replaces @var by @code{var}""" - return re.sub(r'@([\w-]+)', r'@code{\1}', doc) - - -def subst_braces(doc): - """Replaces {} with @{ @}""" - return doc.replace('{', '@{').replace('}', '@}') - - -def texi_example(doc): - """Format @example""" - # TODO: Neglects to escape @ characters. - # We should probably escape them in subst_braces(), and rename the - # function to subst_special() or subs_texi_special(). If we do that, = we - # need to delay it until after subst_vars() in texi_format(). - doc =3D subst_braces(doc).strip('\n') - return EXAMPLE_FMT(code=3Ddoc) - - -def texi_format(doc): - """ - Format documentation - - Lines starting with: - - |: generates an @example - - =3D: generates @section - - =3D=3D: generates @subsection - - 1. or 1): generates an @enumerate @item - - */-: generates an @itemize list - """ - ret =3D '' - doc =3D subst_braces(doc) - doc =3D subst_vars(doc) - doc =3D subst_emph(doc) - doc =3D subst_strong(doc) - inlist =3D '' - lastempty =3D False - for line in doc.split('\n'): - line =3D line.strip() - empty =3D line =3D=3D '' - - # FIXME: Doing this in a single if / elif chain is - # problematic. For instance, a line without markup terminates - # a list if it follows a blank line (reaches the final elif), - # but a line with some *other* markup, such as a =3D title - # doesn't. - # - # Make sure to update section "Documentation markup" in - # docs/devel/qapi-code-gen.txt when fixing this. - if line.startswith('| '): - line =3D EXAMPLE_FMT(code=3Dline[2:]) - elif line.startswith('=3D '): - line =3D '@section ' + line[2:] - elif line.startswith('=3D=3D '): - line =3D '@subsection ' + line[3:] - elif re.match(r'^([0-9]*\.) ', line): - if not inlist: - ret +=3D '@enumerate\n' - inlist =3D 'enumerate' - ret +=3D '@item\n' - line =3D line[line.find(' ')+1:] - elif re.match(r'^[*-] ', line): - if not inlist: - ret +=3D '@itemize %s\n' % {'*': '@bullet', - '-': '@minus'}[line[0]] - inlist =3D 'itemize' - ret +=3D '@item\n' - line =3D line[2:] - elif lastempty and inlist: - ret +=3D '@end %s\n\n' % inlist - inlist =3D '' - - lastempty =3D empty - ret +=3D line + '\n' - - if inlist: - ret +=3D '@end %s\n\n' % inlist - return ret - - -def texi_body(doc): - """Format the main documentation body""" - return texi_format(doc.body.text) - - -def texi_if(ifcond, prefix=3D'\n', suffix=3D'\n'): - """Format the #if condition""" - if not ifcond: - return '' - return '%s@b{If:} @code{%s}%s' % (prefix, ', '.join(ifcond), suffix) - - -def texi_enum_value(value, desc, suffix): - """Format a table of members item for an enumeration value""" - return '@item @code{%s}\n%s%s' % ( - value.name, desc, texi_if(value.ifcond, prefix=3D'@*')) - - -def texi_member(member, desc, suffix): - """Format a table of members item for an object type member""" - typ =3D member.type.doc_type() - membertype =3D ': ' + typ if typ else '' - return '@item @code{%s%s}%s%s\n%s%s' % ( - member.name, membertype, - ' (optional)' if member.optional else '', - suffix, desc, texi_if(member.ifcond, prefix=3D'@*')) - - -def texi_members(doc, what, base=3DNone, variants=3DNone, - member_func=3Dtexi_member): - """Format the table of members""" - items =3D '' - for section in doc.args.values(): - # TODO Drop fallbacks when undocumented members are outlawed - if section.text: - desc =3D texi_format(section.text) - elif (variants and variants.tag_member =3D=3D section.member - and not section.member.type.doc_type()): - values =3D section.member.type.member_names() - members_text =3D ', '.join(['@t{"%s"}' % v for v in values]) - desc =3D 'One of ' + members_text + '\n' - else: - desc =3D 'Not documented\n' - items +=3D member_func(section.member, desc, suffix=3D'') - if base: - items +=3D '@item The members of @code{%s}\n' % base.doc_type() - if variants: - for v in variants.variants: - when =3D ' when @code{%s} is @t{"%s"}%s' % ( - variants.tag_member.name, v.name, texi_if(v.ifcond, " (", = ")")) - if v.type.is_implicit(): - assert not v.type.base and not v.type.variants - for m in v.type.local_members: - items +=3D member_func(m, desc=3D'', suffix=3Dwhen) - else: - items +=3D '@item The members of @code{%s}%s\n' % ( - v.type.doc_type(), when) - if not items: - return '' - return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items) - - -def texi_arguments(doc, boxed_arg_type): - if boxed_arg_type: - assert not doc.args - return ('\n@b{Arguments:} the members of @code{%s}\n' - % boxed_arg_type.name) - return texi_members(doc, 'Arguments') - - -def texi_features(doc): - """Format the table of features""" - items =3D '' - for section in doc.features.values(): - desc =3D texi_format(section.text) - items +=3D '@item @code{%s}\n%s' % (section.name, desc) - if not items: - return '' - return '\n@b{Features:}\n@table @asis\n%s@end table\n' % (items) - - -def texi_sections(doc, ifcond): - """Format additional sections following arguments""" - body =3D '' - for section in doc.sections: - if section.name: - # prefer @b over @strong, so txt doesn't translate it to *Foo:* - body +=3D '\n@b{%s:}\n' % section.name - if section.name and section.name.startswith('Example'): - body +=3D texi_example(section.text) - else: - body +=3D texi_format(section.text) - body +=3D texi_if(ifcond, suffix=3D'') - return body - - -def texi_type(typ, doc, ifcond, members): - return TYPE_FMT(type=3Dtyp, - name=3Ddoc.symbol, - body=3Dtexi_body(doc), - members=3Dmembers, - features=3Dtexi_features(doc), - sections=3Dtexi_sections(doc, ifcond)) - - -def texi_msg(typ, doc, ifcond, members): - return MSG_FMT(type=3Dtyp, - name=3Ddoc.symbol, - body=3Dtexi_body(doc), - members=3Dmembers, - features=3Dtexi_features(doc), - sections=3Dtexi_sections(doc, ifcond)) - - -class QAPISchemaGenDocVisitor(QAPISchemaVisitor): - def __init__(self, prefix): - self._prefix =3D prefix - self._gen =3D QAPIGenDoc(self._prefix + 'qapi-doc.texi') - self.cur_doc =3D None - - def write(self, output_dir): - self._gen.write(output_dir) - - def visit_enum_type(self, name, info, ifcond, members, prefix): - doc =3D self.cur_doc - self._gen.add(texi_type('Enum', doc, ifcond, - texi_members(doc, 'Values', - member_func=3Dtexi_enum_value= ))) - - def visit_object_type(self, name, info, ifcond, base, members, variant= s, - features): - doc =3D self.cur_doc - if base and base.is_implicit(): - base =3D None - self._gen.add(texi_type('Object', doc, ifcond, - texi_members(doc, 'Members', base, variant= s))) - - def visit_alternate_type(self, name, info, ifcond, variants): - doc =3D self.cur_doc - self._gen.add(texi_type('Alternate', doc, ifcond, - texi_members(doc, 'Members'))) - - def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, - success_response, boxed, allow_oob, allow_preconfig, - features): - doc =3D self.cur_doc - self._gen.add(texi_msg('Command', doc, ifcond, - texi_arguments(doc, - arg_type if boxed else None)= )) - - def visit_event(self, name, info, ifcond, arg_type, boxed): - doc =3D self.cur_doc - self._gen.add(texi_msg('Event', doc, ifcond, - texi_arguments(doc, - arg_type if boxed else None)= )) - - def symbol(self, doc, entity): - if self._gen._body: - self._gen.add('\n') - self.cur_doc =3D doc - entity.visit(self) - self.cur_doc =3D None - - def freeform(self, doc): - assert not doc.args - if self._gen._body: - self._gen.add('\n') - self._gen.add(texi_body(doc) + texi_sections(doc, None)) - - -def gen_doc(schema, output_dir, prefix): - vis =3D QAPISchemaGenDocVisitor(prefix) - vis.visit_begin(schema) - for doc in schema.docs: - if doc.symbol: - vis.symbol(doc, schema.lookup_entity(doc.symbol)) - else: - vis.freeform(doc) - vis.write(output_dir) diff --git a/scripts/qapi/gen.py b/scripts/qapi/gen.py index 95afae0615a..7712d2d49f7 100644 --- a/scripts/qapi/gen.py +++ b/scripts/qapi/gen.py @@ -177,13 +177,6 @@ def ifcontext(ifcond, *args): arg.end_if() =20 =20 -class QAPIGenDoc(QAPIGen): - - def _top(self): - return (QAPIGen._top(self) - + '@c AUTOMATICALLY GENERATED, DO NOT MODIFY\n\n') - - class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor): =20 def __init__(self, prefix, what, blurb, pydoc): diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.t= exi deleted file mode 100644 index 1e8063c8579..00000000000 --- a/tests/qapi-schema/doc-good.texi +++ /dev/null @@ -1,281 +0,0 @@ -@c AUTOMATICALLY GENERATED, DO NOT MODIFY - -@section Section - -@subsection Subsection - -@strong{strong} @emph{with emphasis} -@code{var} @{in braces@} - -@itemize @bullet -@item -List item one -@item -Two, multiple -lines - -@item -Three -Still in list - -@end itemize - -Not in list - -@itemize @minus -@item -Second list -Note: still in list - -@end itemize - -Note: not in list - -@enumerate -@item -Third list -is numbered - -@item -another item - -@end enumerate - -Returns: the King -Since: the first age -Notes: - -@enumerate -@item -Lorem ipsum dolor sit amet - -@item -Ut enim ad minim veniam - -@end enumerate - -Duis aute irure dolor - -Example: - --> in -<- out -Examples: -@itemize @minus -@item -@strong{verbatim} -@item -@{braces@} -@end itemize - - - -@deftp {Enum} Enum - - - -@b{Values:} -@table @asis -@item @code{one} -The @emph{one} @{and only@} -@*@b{If:} @code{defined(IFONE)} -@item @code{two} -Not documented -@end table -@code{two} is undocumented - -@b{If:} @code{defined(IFCOND)} -@end deftp - - - -@deftp {Object} Base - - - -@b{Members:} -@table @asis -@item @code{base1: Enum} -the first member -@end table - -@end deftp - - - -@deftp {Object} Variant1 - -A paragraph - -Another paragraph (but no @code{var}: line) - -@b{Members:} -@table @asis -@item @code{var1: string} -Not documented -@*@b{If:} @code{defined(IFSTR)} -@end table - -@b{Features:} -@table @asis -@item @code{variant1-feat} -a feature -@end table - -@end deftp - - - -@deftp {Object} Variant2 - - - -@end deftp - - - -@deftp {Object} Object - - - -@b{Members:} -@table @asis -@item The members of @code{Base} -@item The members of @code{Variant1} when @code{base1} is @t{"one"} -@item The members of @code{Variant2} when @code{base1} is @t{"two"} (@b{If= :} @code{IFTWO}) -@end table - -@end deftp - - - -@deftp {Object} SugaredUnion - - - -@b{Members:} -@table @asis -@item @code{type} -One of @t{"one"}, @t{"two"} -@item @code{data: Variant1} when @code{type} is @t{"one"} -@item @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:} @code{I= FTWO}) -@end table - -@end deftp - - - -@deftp {Alternate} Alternate - - - -@b{Members:} -@table @asis -@item @code{i: int} -an integer -@code{b} is undocumented -@item @code{b: boolean} -Not documented -@end table - -@end deftp - - -@subsection Another subsection - - -@deftypefn Command {} cmd - - - -@b{Arguments:} -@table @asis -@item @code{arg1: int} -the first argument -@item @code{arg2: string} (optional) -the second -argument -@item @code{arg3: boolean} -Not documented -@end table - -@b{Features:} -@table @asis -@item @code{cmd-feat1} -a feature -@item @code{cmd-feat2} -another feature -@end table - -@b{Note:} -@code{arg3} is undocumented - -@b{Returns:} -@code{Object} - -@b{TODO:} -frobnicate - -@b{Notes:} -@itemize @minus -@item -Lorem ipsum dolor sit amet -@item -Ut enim ad minim veniam - -@end itemize - -Duis aute irure dolor - -@b{Example:} -@example --> in -<- out -@end example - -@b{Examples:} -@example -- *verbatim* -- @{braces@} -@end example - -@b{Since:} -2.10 - -@end deftypefn - - - -@deftypefn Command {} cmd-boxed - -If you're bored enough to read this, go see a video of boxed cats - -@b{Arguments:} the members of @code{Object} - -@b{Features:} -@table @asis -@item @code{cmd-feat1} -a feature -@item @code{cmd-feat2} -another feature -@end table - -@b{Example:} -@example --> in - -<- out -@end example - -@end deftypefn - - - -@deftypefn Event {} EVT-BOXED - - - -@b{Arguments:} the members of @code{Object} - -@end deftypefn - --=20 2.20.1 From nobody Fri Apr 26 00:25:55 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1581617973962621.9963422453301; Thu, 13 Feb 2020 10:19:33 -0800 (PST) Received: from localhost ([::1]:57596 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2J5I-0004dF-6c for importer@patchew.org; Thu, 13 Feb 2020 13:19:32 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34866) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j2Ik3-00015h-9T for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:36 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j2Ik0-0003WG-Kp for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:35 -0500 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:34729) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j2Ik0-0003UU-DB for qemu-devel@nongnu.org; Thu, 13 Feb 2020 12:57:32 -0500 Received: by mail-wr1-x443.google.com with SMTP id n10so5873416wrm.1 for ; Thu, 13 Feb 2020 09:57:32 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id p26sm3692913wmc.24.2020.02.13.09.57.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Feb 2020 09:57:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=AtxEKrKRqNjfOrT9JbNHlMjgTudjr9VoMdnqfaiOYHo=; b=I4+X7x9nkXMTo3cW1cxmLx38gFKcu8rtt/clXujOGlYgO52GPOYXm9m7aa5BaF+cuh FZgA8Zzf1dVhOJ2m+hGauORRaOpBG5SGgaZ8KBKbcbpHb/sFFUHJDug5MD9HgXR7ejjM CVVofs86mfTAkNntXKmQFKnIJ5+8VBQxrJ900CkNK0U/TDs0YLoXSkOzTSgU18jPyety tAGFB8yaVkHM10Zj+igXo4yiYuvuA77bwkgRFBSWo5N1nJIEv1zM1BiWggJUJbaR2gUr pwelvJH+WDrHyC5GnexthFbD6bSDPyLw0B+ncOK0hZjHo/X0maAFtcWVPU4C+VToDiLX /auA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=AtxEKrKRqNjfOrT9JbNHlMjgTudjr9VoMdnqfaiOYHo=; b=a4CXxcyaFD89ucaavogANBMz1BK/9WSVO2KQsrz9b+2xXeuKFhsIvEi/YTKqrrj2PA e+Q+lw9KGZ5uFfOBSWrImkfZPKKw+iAdTbtgCdp0CScr/oRNsvFb3SuNtUjJIYx/7WVz d6BILHrRb5+U1KIqE57nbnrCEgkEIO1jbObVLyqHVEEK+yck8iKzPao8qQp3eBt2kr9C z04yc8SC7m4B0BPjPmTVwQDB1EL46R6iIYYaNzg09NR/syuuwlI8weI4ddbbjkrNlPYh LJD6bKURlJ5uyH6kAraJk5fLergE3eF96cP/xoHzatMGZfJZHRnxNh07YuDcBiNFYrr/ +qdw== X-Gm-Message-State: APjAAAWkIU9IiyPCbBj13t6mUB9GUD5W7FYajWU0x6A6m+YT8AEb3MaX SUIol1zeXPupEY1Uulv91mcV0diXFis= X-Google-Smtp-Source: APXvYqwOWyzmktsHVOUDehBMzDvEIIkgU8lsnBIJM6aitMr1yPcrFkAv94uS8gdIOLe1Rs0WCJq7YQ== X-Received: by 2002:a5d:65c5:: with SMTP id e5mr22464807wrw.311.1581616651041; Thu, 13 Feb 2020 09:57:31 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 30/30] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions Date: Thu, 13 Feb 2020 17:56:47 +0000 Message-Id: <20200213175647.17628-31-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200213175647.17628-1-peter.maydell@linaro.org> References: <20200213175647.17628-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::443 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , Michael Roth , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Update the documentation of QAPI document comment syntax to match the new rST backend requirements. The principal changes are: * whitespace is now significant, and multiline definitions must have their second and subsequent lines indented to match the first line * general rST format markup is permitted, not just the small set of markup the old texinfo generator handled. For most things (notably bulleted and itemized lists) the old format is the same as rST was. * Specific things that might trip people up: - instead of *bold* and _italic_ rST has **bold** and *italic* - lists need a preceding and following blank line - a lone literal '*' will need to be backslash-escaped to avoid a rST syntax error * the old leading '|' for example (literal text) blocks is replaced by the standard rST '::' literal block. * headings and subheadings must now be in a freeform documentation comment of their own * we support arbitrary levels of sub- and sub-sub-heading, not just a main and sub-heading like the old texinfo generator Signed-off-by: Peter Maydell --- docs/devel/qapi-code-gen.txt | 90 ++++++++++++++++++++++++------------ 1 file changed, 61 insertions(+), 29 deletions(-) diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt index 59d6973e1ec..688eb2a0237 100644 --- a/docs/devel/qapi-code-gen.txt +++ b/docs/devel/qapi-code-gen.txt @@ -795,21 +795,39 @@ See below for more on definition documentation. Free-form documentation may be used to provide additional text and structuring content. =20 +=3D=3D=3D=3D Headings and subheadings =3D=3D=3D=3D + +A free-form documentation comment containing a single line +which starts with some '=3D' symbols and then a space defines +a section heading: + + ## + # =3D This is a top level heading + ## + + ## + # This is a free-form comment which will go under the + # top level heading. + ## + + ## + # =3D=3D This is a second level heading + ## + +Section headings must always be correctly nested, so you can only +define a third-level heading inside a second-level heading, and so +on. The documentation generator will catch nesting mistakes and report +a syntax error. =20 =3D=3D=3D=3D Documentation markup =3D=3D=3D=3D =20 -Comment text starting with '=3D' is a section title: +Documentation comments can use most rST markup. In particular, +a '::' literal block can be used for examples: =20 - # =3D Section title - -Double the '=3D' for a subsection title: - - # =3D=3D Subsection title - -'|' denotes examples: - - # | Text of the example, may span - # | multiple lines + # :: + # + # Text of the example, may span + # multiple lines =20 '*' starts an itemized list: =20 @@ -825,37 +843,35 @@ A decimal number followed by '.' starts a numbered li= st: # multiple lines # 2. Second item =20 -The actual number doesn't matter. You could even use '*' instead of -'2.' for the second item. +The actual number doesn't matter. =20 -Lists can't be nested. Blank lines are currently not supported within -lists. +Lists of either kind must be preceded and followed by a blank line. +If a list item's text spans multiple lines, then the second and +subsequent lines must be correctly indented to line up with the +first character of the first line. =20 -Additional whitespace between the initial '#' and the comment text is -permitted. - -*foo* and _foo_ are for strong and emphasis styles respectively (they -do not work over multiple lines). @foo is used to reference a name in -the schema. +The usual '**strong**', '*emphasised*' and '``literal``' markup should +be used. If you need a single literal '*' you will need to backslash-escap= e it. +As an extension beyond the usual rST syntax, you can also +use '@foo' to reference a name in the schema; this is rendered +the same way as '``foo``'. =20 Example: =20 ## -# =3D Section -# =3D=3D Subsection -# -# Some text foo with *strong* and _emphasis_ +# Some text foo with **bol** and *emphasis* # 1. with a list # 2. like that # # And some code: -# | $ echo foo -# | -> do this -# | <- get that # +# :: +# +# $ echo foo +# -> do this +# <- get that ## =20 - =3D=3D=3D=3D Definition documentation =3D=3D=3D=3D =20 Definition documentation, if present, must immediately precede the @@ -870,6 +886,12 @@ commands and events), member (for structs and unions),= branch (for alternates), or value (for enums), and finally optional tagged sections. =20 +Descriptions of arguments can span multiple lines; if they +do then the second and subsequent lines must be indented +to line up with the first character of the first line of the +description. The parser will report a syntax error if there +is insufficient indentation. + FIXME: the parser accepts these things in almost any order. FIXME: union branches should be described, too. =20 @@ -883,6 +905,16 @@ The section ends with the start of a new section. A 'Since: x.y.z' tagged section lists the release that introduced the definition. =20 +The text of a section can start on a new line, in +which case it must not be indented at all. It can also start +on the same line as the 'Note:', 'Returns:', etc tag. In this +case if it spans multiple lines then second and subsequent +lines must be indented to match the first. + +An 'Example' or 'Examples' section is automatically rendered +entirely as literal fixed-width text. In other sections, +the text is formatted, and rST markup can be used. + For example: =20 ## --=20 2.20.1