From nobody Fri May 17 08:39:12 2024 Delivered-To: importer@patchew.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=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1632424664147288.47203412268107; Thu, 23 Sep 2021 12:17:44 -0700 (PDT) Received: from localhost ([::1]:52450 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mTUE3-000586-4i for importer@patchew.org; Thu, 23 Sep 2021 15:17:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:40446) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTUB5-0001Ts-3i for qemu-devel@nongnu.org; Thu, 23 Sep 2021 15:14:39 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:22848) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTUB2-0001y7-SX for qemu-devel@nongnu.org; Thu, 23 Sep 2021 15:14:38 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-282-8WY96w8HPS2xyRqgTUYV0w-1; Thu, 23 Sep 2021 15:14:34 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C965DDF8A6; Thu, 23 Sep 2021 19:14:32 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.9.55]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4F7DE60BF1; Thu, 23 Sep 2021 19:14:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1632424476; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Anwk/b01RqPUSI3Og8kpo54UgeyrL5k7jkzjrk/7MfY=; b=NGNjIRIqsVrweb3rm6TaIBtk6kYkhKj2Ly2NPjK4dx8r/a4vbhqrAecPawOoX6Z/SSYB9T 0049QpuooBbe4hOOTKPK+tveSM8TveU6HgzP6y3bsPlVwVlO41xLMKKyA50U2m/WuDiLSY 8GKe1e6S9vfw+QqkwVz6MhbDL5A8QCI= X-MC-Unique: 8WY96w8HPS2xyRqgTUYV0w-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 1/2] docs: remove non-reference uses of single backticks Date: Thu, 23 Sep 2021 15:13:22 -0400 Message-Id: <20210923191323.59726-2-jsnow@redhat.com> In-Reply-To: <20210923191323.59726-1-jsnow@redhat.com> References: <20210923191323.59726-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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; Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.473, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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: Peter Maydell , Thomas Huth , Eduardo Habkost , Alexander Bulekov , Eric Blake , Qiuhao Li , Markus Armbruster , John Snow , Darren Kenny , Bandan Das , Stefan Hajnoczi , Paolo Bonzini , Alexandre Iooss , Mahmoud Mandour , =?UTF-8?q?Alex=20Benn=C3=A9e?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1632424664865100001 Content-Type: text/plain; charset="utf-8" The single backtick markup in ReST is the "default role". Currently, Sphinx's default role is called "content". Sphinx suggests you can use the "Any" role instead to turn any single-backtick enclosed item into a cross-reference. This is useful for things like autodoc for Python docstrings, where it's often nicer to reference other types with `foo` instead of the more laborious :py:meth:`foo`. It's also useful in multi-domain cases to easily reference definitions from other Sphinx domains, such as referencing C code definitions from outside of kerneldoc comments. Before we do that, though, we'll need to turn all existing usages of the "content" role to inline verbatim markup wherever it does not correctly resolve into a cross-refernece by using double backticks instead. Signed-off-by: John Snow Reviewed-by: Alexander Bulekov Reviewed-by: Eduardo Habkost --- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/tcg-plugins.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/guest-loader.rst | 2 +- qapi/block-core.json | 4 ++-- include/qemu/module.h | 6 +++--- qemu-options.hx | 4 ++-- 7 files changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst index 2749bb9bed3..784ecb99e66 100644 --- a/docs/devel/fuzzing.rst +++ b/docs/devel/fuzzing.rst @@ -182,10 +182,11 @@ The output should contain a complete list of matched = MemoryRegions. =20 OSS-Fuzz -------- -QEMU is continuously fuzzed on `OSS-Fuzz` __(https://github.com/google/oss= -fuzz). -By default, the OSS-Fuzz build will try to fuzz every fuzz-target. Since t= he -generic-fuzz target requires additional information provided in environment -variables, we pre-define some generic-fuzz configs in +QEMU is continuously fuzzed on `OSS-Fuzz +`_. By default, the OSS-Fuzz build +will try to fuzz every fuzz-target. Since the generic-fuzz target +requires additional information provided in environment variables, we +pre-define some generic-fuzz configs in ``tests/qtest/fuzz/generic_fuzz_configs.h``. Each config must specify: =20 - ``.name``: To identify the fuzzer config diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index dac5101a3c9..8bffff187f8 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -212,7 +212,7 @@ The hotpages plugin can be configured using the followi= ng arguments: =20 This is an instruction classifier so can be used to count different types of instructions. It has a number of options to refine which get -counted. You can give a value to the `count` argument for a class of +counted. You can give a value to the ``count`` argument for a class of instructions to break it down fully, so for example to see all the system registers accesses:: =20 diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-blo= ck-operations.rst index 9e3635b2338..814c29bbe1d 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -640,7 +640,7 @@ at this point: (QEMU) block-job-complete device=3Djob0 =20 In either of the above cases, if you once again run the -`query-block-jobs` command, there should not be any active block +``query-block-jobs`` command, there should not be any active block operation. =20 Comparing 'commit' and 'mirror': In both then cases, the overlay images diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 4320d1183f7..9ef9776bf07 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -51,4 +51,4 @@ The full syntax of the guest-loader is:: =20 ``bootargs=3D`` This is an optional field for kernel blobs which will pass command - like via the `/chosen/module@/bootargs` node. + like via the ``/chosen/module@/bootargs`` node. diff --git a/qapi/block-core.json b/qapi/block-core.json index c8ce1d9d5d8..0c64470edb2 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -446,11 +446,11 @@ # @granularity: granularity of the dirty bitmap in bytes (since 1.4) # # @recording: true if the bitmap is recording new writes from the guest. -# Replaces `active` and `disabled` statuses. (since 4.0) +# Replaces ``active`` and ``disabled`` statuses. (since 4.0) # # @busy: true if the bitmap is in-use by some operation (NBD or jobs) # and cannot be modified via QMP or used by another operation. -# Replaces `locked` and `frozen` statuses. (since 4.0) +# Replaces ``locked`` and ``frozen`` statuses. (since 4.0) # # @persistent: true if the bitmap was stored on disk, is scheduled to be s= tored # on disk, or both. (since 4.0) diff --git a/include/qemu/module.h b/include/qemu/module.h index 3deac0078b9..5fcc323b2a7 100644 --- a/include/qemu/module.h +++ b/include/qemu/module.h @@ -77,14 +77,14 @@ void module_allow_arch(const char *arch); /** * DOC: module info annotation macros * - * `scripts/modinfo-collect.py` will collect module info, + * ``scripts/modinfo-collect.py`` will collect module info, * using the preprocessor and -DQEMU_MODINFO. * - * `scripts/modinfo-generate.py` will create a module meta-data database + * ``scripts/modinfo-generate.py`` will create a module meta-data database * from the collected information so qemu knows about module * dependencies and QOM objects implemented by modules. * - * See `*.modinfo` and `modinfo.c` in the build directory to check the + * See ``*.modinfo`` and ``modinfo.c`` in the build directory to check the * script results. */ #ifdef QEMU_MODINFO diff --git a/qemu-options.hx b/qemu-options.hx index 8f603cc7e65..757ac6f2037 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1881,8 +1881,8 @@ SRST Valid parameters are: =20 ``grab-mod=3D`` : Used to select the modifier keys for toggl= ing - the mouse grabbing in conjunction with the "g" key. `` can be - either `lshift-lctrl-lalt` or `rctrl`. + the mouse grabbing in conjunction with the "g" key. ```` can= be + either ``lshift-lctrl-lalt`` or ``rctrl``. =20 ``alt_grab=3Don|off`` : Use Control+Alt+Shift-g to toggle mouse gr= abbing. This parameter is deprecated - use ``grab-mod`` instead. --=20 2.31.1 From nobody Fri May 17 08:39:12 2024 Delivered-To: importer@patchew.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=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1632424605681898.8250292474285; Thu, 23 Sep 2021 12:16:45 -0700 (PDT) Received: from localhost ([::1]:49564 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mTUD5-0002yR-Nv for importer@patchew.org; Thu, 23 Sep 2021 15:16:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:40474) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTUB9-0001Z7-V1 for qemu-devel@nongnu.org; Thu, 23 Sep 2021 15:14:43 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:47200) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTUB7-00022S-BG for qemu-devel@nongnu.org; Thu, 23 Sep 2021 15:14:43 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-519-81Ds32KyPFqM1OcoO5X7hQ-1; Thu, 23 Sep 2021 15:14:39 -0400 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 244B3DF8A4; Thu, 23 Sep 2021 19:14:38 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.9.55]) by smtp.corp.redhat.com (Postfix) with ESMTP id 045ED60BE5; Thu, 23 Sep 2021 19:14:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1632424480; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=lJrlyCQXbfxzRA7UvRnyOqNkXc54xFR30J98bJ/t9R8=; b=Ed3ZiY7DKK4McQ03zGw6FINnMJababv4xS6wto0QvT/MuEO7MFwPOgFic5vlSEz5hqMDj5 /Ql3RWH/qTa/2uDIDte9E1CdYufgP7Ypa7sqzYUKjyOcLbmdJqImnLKGHoQGODqJXE2OEA zoqVz4VvR41PK5eCYZa5OR9d/xCgXNE= X-MC-Unique: 81Ds32KyPFqM1OcoO5X7hQ-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v3 2/2] docs/sphinx: change default role to "any" Date: Thu, 23 Sep 2021 15:13:23 -0400 Message-Id: <20210923191323.59726-3-jsnow@redhat.com> In-Reply-To: <20210923191323.59726-1-jsnow@redhat.com> References: <20210923191323.59726-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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; Received-SPF: pass client-ip=216.205.24.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.473, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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: Peter Maydell , Thomas Huth , Eduardo Habkost , Alexander Bulekov , Eric Blake , Qiuhao Li , Markus Armbruster , John Snow , Darren Kenny , Bandan Das , Stefan Hajnoczi , Paolo Bonzini , Alexandre Iooss , Mahmoud Mandour , =?UTF-8?q?Alex=20Benn=C3=A9e?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1632424607847100001 Content-Type: text/plain; charset="utf-8" This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols. From here on out, new uses of `backticks` will cause a build failure if the target cannot be referenced. Signed-off-by: John Snow Reviewed-by: Eduardo Habkost Reviewed-by: Peter Maydell --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index ff6e92c6e2e..4d9f56601fc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,11 @@ # The master toctree document. master_doc =3D 'index' =20 +# Interpret `single-backticks` to be a cross-reference to any kind of +# referenceable object. Unresolvable or ambiguous references will emit a +# warning at build time. +default_role =3D 'any' + # General information about the project. project =3D u'QEMU' copyright =3D u'2021, The QEMU Project Developers' --=20 2.31.1