From nobody Fri May 17 09:38:15 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 1632421468230530.1095153250515; Thu, 23 Sep 2021 11:24:28 -0700 (PDT) Received: from localhost ([::1]:35612 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mTTOU-00060u-Pz for importer@patchew.org; Thu, 23 Sep 2021 14:24:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59112) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTTMj-0004Bi-77 for qemu-devel@nongnu.org; Thu, 23 Sep 2021 14:22:37 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:57459) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTTMh-00083o-4b for qemu-devel@nongnu.org; Thu, 23 Sep 2021 14:22:37 -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-554-tJU7OM4jMZesb0Hz4oSYkg-1; Thu, 23 Sep 2021 14:22:27 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 0AFA4835DE4; Thu, 23 Sep 2021 18:22:26 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.9.55]) by smtp.corp.redhat.com (Postfix) with ESMTP id 4D4795BAE0; Thu, 23 Sep 2021 18:22:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1632421353; 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=HR/0PPSOygBDYN7QG917SIuf1K14Es2UdFNgBh7xurs=; b=H71VQ4P8qK4L2ow//76Rmd3fVLFl6W6TMWpRes3h6+/KiFpa2GbuH6NMCKooF2jPuo26GB T9hqcacT2OZEz9FY5zvGWcjP7pirDBU8Tna5/ssmV7lkQEvw9lPpvy4iWhH3NCVLUxm+VD M7P5qGu21FZE2W28IMV7Pl55b8mYVn8= X-MC-Unique: tJU7OM4jMZesb0Hz4oSYkg-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v2 1/2] docs: remove non-reference uses of single backticks Date: Thu, 23 Sep 2021 14:22:03 -0400 Message-Id: <20210923182204.4187601-2-jsnow@redhat.com> In-Reply-To: <20210923182204.4187601-1-jsnow@redhat.com> References: <20210923182204.4187601-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 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 , Darren Kenny , Juan Quintela , =?UTF-8?q?Alex=20Benn=C3=A9e?= , "Dr. David Alan Gilbert" , Qiuhao Li , John Snow , Alexander Bulekov , Bandan Das , Stefan Hajnoczi , Paolo Bonzini , Alexandre Iooss , Mahmoud Mandour , Eric Blake , Markus Armbruster 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: 1632421470334100001 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: Eduardo Habkost # if unrelated line wra= pping changes are dropped --- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/migration.rst | 10 +++++----- 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 ++-- 8 files changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst index 2749bb9bed3..d5fe9314c65 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`` +__(https://github.com/google/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/migration.rst b/docs/devel/migration.rst index 24012534827..6b1230f2d7f 100644 --- a/docs/devel/migration.rst +++ b/docs/devel/migration.rst @@ -403,8 +403,8 @@ version_id. And the function ``load_state_old()`` (if = present) is able to load state from minimum_version_id_old to minimum_version_id. This function is deprecated and will be removed when no more users are left. =20 -There are *_V* forms of many ``VMSTATE_`` macros to load fields for versio= n dependent fields, -e.g. +There are *_V* forms of many ``VMSTATE_`` macros to load fields for +version dependent fields, e.g. =20 .. code:: c =20 @@ -819,9 +819,9 @@ Postcopy now works with hugetlbfs backed memory: Postcopy with shared memory --------------------------- =20 -Postcopy migration with shared memory needs explicit support from the other -processes that share memory and from QEMU. There are restrictions on the t= ype of -memory that userfault can support shared. +Postcopy migration with shared memory needs explicit support from the +other processes that share memory and from QEMU. There are restrictions +on the type of memory that userfault can support shared. =20 The Linux kernel userfault support works on ``/dev/shm`` memory and on ``h= ugetlbfs`` (although the kernel doesn't provide an equivalent to ``madvise(MADV_DONTN= EED)`` 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 09:38:15 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 1632421490354707.3324535303013; Thu, 23 Sep 2021 11:24:50 -0700 (PDT) Received: from localhost ([::1]:36528 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mTTOr-0006dW-7B for importer@patchew.org; Thu, 23 Sep 2021 14:24:49 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:59188) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTTMu-0004WQ-3s for qemu-devel@nongnu.org; Thu, 23 Sep 2021 14:22:48 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:59596) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mTTMs-0008H5-Iv for qemu-devel@nongnu.org; Thu, 23 Sep 2021 14:22:47 -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-43-H5yODgc0OBGYAYs1IuDPZA-1; Thu, 23 Sep 2021 14:22:44 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 0318F1842154; Thu, 23 Sep 2021 18:22:43 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.9.55]) by smtp.corp.redhat.com (Postfix) with ESMTP id 7368C5BAE0; Thu, 23 Sep 2021 18:22:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1632421365; 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=ZDiGZedKiJ5VdIb31+MFoYg7v3QqxdQmRJJcZiAgwVMdxNSrqQLewqFwxtPjMmeb2mHcIJ pvpX1amxYtHn9VmTQmWL1/jIof7ssTSMigCzxMcrf5VLlvr41CyMDlhyJK3puIzwIZ8IaD vNMQwG4lNBBwHrJ70yg1+rl2VZFyD2g= X-MC-Unique: H5yODgc0OBGYAYs1IuDPZA-1 From: John Snow To: qemu-devel@nongnu.org Subject: [PATCH v2 2/2] docs/sphinx: change default role to "any" Date: Thu, 23 Sep 2021 14:22:04 -0400 Message-Id: <20210923182204.4187601-3-jsnow@redhat.com> In-Reply-To: <20210923182204.4187601-1-jsnow@redhat.com> References: <20210923182204.4187601-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 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.129.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, 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 , Darren Kenny , Juan Quintela , =?UTF-8?q?Alex=20Benn=C3=A9e?= , "Dr. David Alan Gilbert" , Qiuhao Li , John Snow , Alexander Bulekov , Bandan Das , Stefan Hajnoczi , Paolo Bonzini , Alexandre Iooss , Mahmoud Mandour , Eric Blake , Markus Armbruster 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: 1632421492522100001 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 --- 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