From patchwork Tue Nov 2 18:43:57 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 12599547 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CC938C433EF for ; Tue, 2 Nov 2021 18:44:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B4D4160720 for ; Tue, 2 Nov 2021 18:44:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235292AbhKBSrN (ORCPT ); Tue, 2 Nov 2021 14:47:13 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:59595 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231164AbhKBSrJ (ORCPT ); Tue, 2 Nov 2021 14:47:09 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1635878674; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=xL0K16NyNcO526OYJPWoNTHW7+oRufouiGvKyHeGXZg=; b=IM1ZWSIoPdQ5DJAuVp2CC4SxRzbCEEUflv57xY1ZgR9+VIKBpEWjWB7gVEg1MEL2ga1dof yUltDxygsyZq5nvaNSaeRlvHiNzxoWyOmlvqPOEswow1uhrtGXKdxpid0uVB2tkUuS+trh YRcvQ4cHqT8IBx7jf+nGaddNjT9lB20= 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-259-RUXnAjtBO-mleuNHsLWBog-1; Tue, 02 Nov 2021 14:44:29 -0400 X-MC-Unique: RUXnAjtBO-mleuNHsLWBog-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 8A6D050763; Tue, 2 Nov 2021 18:44:27 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.11.175]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0C01619C79; Tue, 2 Nov 2021 18:44:09 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Peter Maydell , Stefan Hajnoczi , =?utf-8?q?Alex_Benn=C3=A9e?= , Darren Kenny , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Marcelo Tosatti , Eduardo Habkost , Qiuhao Li , Paolo Bonzini , Eric Blake , Alexandre Iooss , Mahmoud Mandour , Alexander Bulekov , Markus Armbruster , kvm@vger.kernel.org, Thomas Huth , Bandan Das , John Snow Subject: [PATCH v5 1/4] docs: remove non-reference uses of single backticks Date: Tue, 2 Nov 2021 14:43:57 -0400 Message-Id: <20211102184400.1168508-2-jsnow@redhat.com> In-Reply-To: <20211102184400.1168508-1-jsnow@redhat.com> References: <20211102184400.1168508-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org 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 Reviewed-by: Alexander Bulekov --- 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 2749bb9bed..784ecb99e6 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. 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 the -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: - ``.name``: To identify the fuzzer config diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 842ae01a4c..72a1cd932c 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -211,7 +211,7 @@ The hotpages plugin can be configured using the following arguments: 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:: diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-block-operations.rst index 9e3635b233..814c29bbe1 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=job0 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. 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 4320d1183f..9ef9776bf0 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:: ``bootargs=`` 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 ce2c1352cb..96f4156890 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -491,11 +491,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 stored # on disk, or both. (since 4.0) diff --git a/include/qemu/module.h b/include/qemu/module.h index 3deac0078b..5fcc323b2a 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 f051536b63..7749f59300 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1895,8 +1895,8 @@ SRST Valid parameters are: ``grab-mod=`` : Used to select the modifier keys for toggling - 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``. ``alt_grab=on|off`` : Use Control+Alt+Shift-g to toggle mouse grabbing. This parameter is deprecated - use ``grab-mod`` instead. From patchwork Tue Nov 2 18:43:58 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 12599549 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2E377C433EF for ; Tue, 2 Nov 2021 18:47:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0E0F96103C for ; Tue, 2 Nov 2021 18:47:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235293AbhKBStf (ORCPT ); Tue, 2 Nov 2021 14:49:35 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:45865 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235663AbhKBSsW (ORCPT ); Tue, 2 Nov 2021 14:48:22 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1635878746; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=6odGhqXiSlknlWtZ0hGsFRZjP/jxWLoQjf/KmrWUdtw=; b=dXTJPeB4y57uYr9qyG/uHnACOaxvegUcPrZtrJ52Fgv7DKeNn7Kr4xZdHi39Hacqd/fSgD tjFjce8vWTG10wTLG3kxGBQQa19CcnZyEimhAO9gzIS/FZNaUi+QE8AUbMtPxLQ9dxRvkC c8Jzg72EOfdXnlCBY3jA75n9EOQIpx8= 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-179-8in5EMOrMIOQRThsqt66GA-1; Tue, 02 Nov 2021 14:45:43 -0400 X-MC-Unique: 8in5EMOrMIOQRThsqt66GA-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 3349A100C609; Tue, 2 Nov 2021 18:45:42 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.11.175]) by smtp.corp.redhat.com (Postfix) with ESMTP id E008C19D9F; Tue, 2 Nov 2021 18:44:28 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Peter Maydell , Stefan Hajnoczi , =?utf-8?q?Alex_Benn=C3=A9e?= , Darren Kenny , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Marcelo Tosatti , Eduardo Habkost , Qiuhao Li , Paolo Bonzini , Eric Blake , Alexandre Iooss , Mahmoud Mandour , Alexander Bulekov , Markus Armbruster , kvm@vger.kernel.org, Thomas Huth , Bandan Das , John Snow Subject: [PATCH v5 2/4] docs: (further) remove non-reference uses of single backticks Date: Tue, 2 Nov 2021 14:43:58 -0400 Message-Id: <20211102184400.1168508-3-jsnow@redhat.com> In-Reply-To: <20211102184400.1168508-1-jsnow@redhat.com> References: <20211102184400.1168508-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org The series rotted already. Here's the new changes. Signed-off-by: John Snow Reviewed-by: Thomas Huth --- docs/system/i386/sgx.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/system/i386/sgx.rst b/docs/system/i386/sgx.rst index f103ae2a2f..9aa161af1a 100644 --- a/docs/system/i386/sgx.rst +++ b/docs/system/i386/sgx.rst @@ -77,9 +77,9 @@ CPUID Due to its myriad dependencies, SGX is currently not listed as supported in any of Qemu's built-in CPU configuration. To expose SGX (and SGX Launch -Control) to a guest, you must either use `-cpu host` to pass-through the +Control) to a guest, you must either use ``-cpu host`` to pass-through the host CPU model, or explicitly enable SGX when using a built-in CPU model, -e.g. via `-cpu ,+sgx` or `-cpu ,+sgx,+sgxlc`. +e.g. via ``-cpu ,+sgx`` or ``-cpu ,+sgx,+sgxlc``. All SGX sub-features enumerated through CPUID, e.g. SGX2, MISCSELECT, ATTRIBUTES, etc... can be restricted via CPUID flags. Be aware that enforcing @@ -126,7 +126,7 @@ creating VM with SGX. Feature Control ~~~~~~~~~~~~~~~ -Qemu SGX updates the `etc/msr_feature_control` fw_cfg entry to set the SGX +Qemu SGX updates the ``etc/msr_feature_control`` fw_cfg entry to set the SGX (bit 18) and SGX LC (bit 17) flags based on their respective CPUID support, i.e. existing guest firmware will automatically set SGX and SGX LC accordingly, assuming said firmware supports fw_cfg.msr_feature_control. From patchwork Tue Nov 2 18:43:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 12599551 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 16495C433F5 for ; Tue, 2 Nov 2021 18:47:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id EB6F561050 for ; Tue, 2 Nov 2021 18:47:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235525AbhKBStf (ORCPT ); Tue, 2 Nov 2021 14:49:35 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:52946 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235820AbhKBSsr (ORCPT ); Tue, 2 Nov 2021 14:48:47 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1635878771; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=i2KW2wCuNVxgmC1cz78ZXb1YV27huKZjMrxsF06sZME=; b=KQ5YbZte31JuzCXWLVQM7vMcsoBWJREoF3iW+8e650+meCBlhkp2+OaS2Ty2wcBXjQABbr raPGawXoFdT9KzmcOh8T+KFur8r8Ubwb++pQ6wtdQJYNaj41RBDAE0Ifzk8Ym+oERW1K1/ waWZRpb3DPSZUAnPemoEvOxO47ncD4k= 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-502-LlDw0qBWPHmxS8pi1BI-Hw-1; Tue, 02 Nov 2021 14:46:08 -0400 X-MC-Unique: LlDw0qBWPHmxS8pi1BI-Hw-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 24D5D872FF7; Tue, 2 Nov 2021 18:46:07 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.11.175]) by smtp.corp.redhat.com (Postfix) with ESMTP id 76A1F19C79; Tue, 2 Nov 2021 18:45:42 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Peter Maydell , Stefan Hajnoczi , =?utf-8?q?Alex_Benn=C3=A9e?= , Darren Kenny , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Marcelo Tosatti , Eduardo Habkost , Qiuhao Li , Paolo Bonzini , Eric Blake , Alexandre Iooss , Mahmoud Mandour , Alexander Bulekov , Markus Armbruster , kvm@vger.kernel.org, Thomas Huth , Bandan Das , John Snow Subject: [PATCH v5 3/4] docs: (further further) remove non-reference uses of single backticks Date: Tue, 2 Nov 2021 14:43:59 -0400 Message-Id: <20211102184400.1168508-4-jsnow@redhat.com> In-Reply-To: <20211102184400.1168508-1-jsnow@redhat.com> References: <20211102184400.1168508-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org Signed-off-by: John Snow Reviewed-by: Thomas Huth --- docs/devel/build-system.rst | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index 7f106d2f1c..48e56d7ea9 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -47,16 +47,17 @@ command line options for which a same-named Meson option exists; dashes in the command line are replaced with underscores. Many checks on the compilation environment are still found in configure -rather than `meson.build`, but new checks should be added directly to -`meson.build`. +rather than ``meson.build``, but new checks should be added directly to +``meson.build``. Patches are also welcome to move existing checks from the configure -phase to `meson.build`. When doing so, ensure that `meson.build` does -not use anymore the keys that you have removed from `config-host.mak`. -Typically these will be replaced in `meson.build` by boolean variables, -``get_option('optname')`` invocations, or `dep.found()` expressions. -In general, the remaining checks have little or no interdependencies, -so they can be moved one by one. +phase to ``meson.build``. When doing so, ensure that ``meson.build`` +does not use anymore the keys that you have removed from +``config-host.mak``. Typically these will be replaced in +``meson.build`` by boolean variables, ``get_option('optname')`` +invocations, or ``dep.found()`` expressions. In general, the remaining +checks have little or no interdependencies, so they can be moved one by +one. Helper functions ---------------- @@ -298,7 +299,7 @@ comprises the following tasks: - Add code to perform the actual feature check. - - Add code to include the feature status in `config-host.h` + - Add code to include the feature status in ``config-host.h`` - Add code to print out the feature status in the configure summary upon completion. @@ -334,7 +335,7 @@ The other supporting code is generally simple:: For the configure script to parse the new option, the ``scripts/meson-buildoptions.sh`` file must be up-to-date; ``make -update-buildoptions`` (or just `make`) will take care of updating it. +update-buildoptions`` (or just ``make``) will take care of updating it. Support scripts From patchwork Tue Nov 2 18:44:00 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Snow X-Patchwork-Id: 12599553 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 872EFC433F5 for ; Tue, 2 Nov 2021 18:47:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 72A2F603E8 for ; Tue, 2 Nov 2021 18:47:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235542AbhKBSth (ORCPT ); Tue, 2 Nov 2021 14:49:37 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:59484 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235918AbhKBStM (ORCPT ); Tue, 2 Nov 2021 14:49:12 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1635878797; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Sb+JrgSSp9WAPQnhdMXztmNWnmaSMiyfNN+rpG9Ac2w=; b=P6IZ4jfm2sX26cpTGEsvbMz0iFkCecHqFNfyIMOcjV0krx7PMsM5238P4J5HzPTkIuQEui ZFx5Mzn8FAEiI12ajZeDI3waOGUyGrsXb239fzM5/qX/aPrprPBqyGlJeHdQDa6NFjWh4A slufl7/pRayRn9IRQSfysB4nq07zvnY= 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-125-IO3zarywPr6HtKTOBFc7oA-1; Tue, 02 Nov 2021 14:46:34 -0400 X-MC-Unique: IO3zarywPr6HtKTOBFc7oA-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7E79F8799E0; Tue, 2 Nov 2021 18:46:32 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.11.175]) by smtp.corp.redhat.com (Postfix) with ESMTP id AA28C19C79; Tue, 2 Nov 2021 18:46:07 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Peter Maydell , Stefan Hajnoczi , =?utf-8?q?Alex_Benn=C3=A9e?= , Darren Kenny , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Marcelo Tosatti , Eduardo Habkost , Qiuhao Li , Paolo Bonzini , Eric Blake , Alexandre Iooss , Mahmoud Mandour , Alexander Bulekov , Markus Armbruster , kvm@vger.kernel.org, Thomas Huth , Bandan Das , John Snow Subject: [PATCH v5 4/4] docs/sphinx: change default role to "any" Date: Tue, 2 Nov 2021 14:44:00 -0400 Message-Id: <20211102184400.1168508-5-jsnow@redhat.com> In-Reply-To: <20211102184400.1168508-1-jsnow@redhat.com> References: <20211102184400.1168508-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org 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 ff6e92c6e2..4d9f56601f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,11 @@ # The master toctree document. master_doc = 'index' +# 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 = 'any' + # General information about the project. project = u'QEMU' copyright = u'2021, The QEMU Project Developers'