From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309532262603.155897322236; Mon, 26 Jul 2021 07:25:32 -0700 (PDT) Received: from localhost ([::1]:49446 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81Xv-0008K9-3N for importer@patchew.org; Mon, 26 Jul 2021 10:25:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42342) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WE-0005Qx-Qp for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:46 -0400 Received: from mail-wm1-x32d.google.com ([2a00:1450:4864:20::32d]:43863) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WB-0008OW-A3 for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:46 -0400 Received: by mail-wm1-x32d.google.com with SMTP id m20-20020a05600c4f54b029024e75a15716so106571wmq.2 for ; Mon, 26 Jul 2021 07:23:42 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:41 -0700 (PDT) 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=BclT581nL+X48QrymfdimieJ72usL8dxLS92vg+pwCY=; b=k4IPyJqcAi2Cg6BN8QCVThjNPusUjdv1pt+elv+XtVflrhMXV5spPLGpvcdqqBrtNW xAAQsEa/2skYMmDgKl7keguOO0h2NbLCoRAHEoS+QVZkTgJZkmG/dZ5oWwkfoqePPqDY roFlAZZaG3RRrGlMO9rSFfMf2Ocw9fv95/bPxckjs6TsNZEqpENXa4b0m85qw2BnSGsq xWLCDN1VqSpzYuX7V3ZFdABv9teY/xUG/X4D2PxvvhjPzsWRyWv8QmgQNqR5dEr773hL ZBJcwiEFoObrzCwApkKF6ZzesziCbqH/zS5+A64G+tjVYYMgQKvKmM/eb6KwbnofTpy8 S3xw== 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=BclT581nL+X48QrymfdimieJ72usL8dxLS92vg+pwCY=; b=orUsWMWuV8nGh0brKqUcbm1isb5U1iNwYMDZGe2dp82HfgYR9S3b0QJ8CeF8kWn38D rPYgWW5ej7jg5BCmUQAWlsWL/pKDEF+iSO0InsPYzX9ZyVvinfkAH76L2l1407wbgWTj yrLE2TeX8NcyDaTFuZPolYnXbXiU+pjdJOsBHWngFZeNA6Bc3Q7xIb74f4jFS9stCpvt w401xHX5hwGhkijPhiF/ubrHEW2nl6giYWkwFX/8Oo70HxkwdnoqKOXiXODo2jk/PB8q L26A8VPT9gfSxZsZHWt09sEkxi8u9eJH68BuELM63aE3xBZUKDqN6dcF0YnlHZxf0IIw Frqg== X-Gm-Message-State: AOAM5331BySyPWfE16+1spC8vJZFnGsWc3giHy9m7Am80kyRCq6LsRRW jeD++5pqNzp/hCx2B9pYCPMbhNlNyUAbSA== X-Google-Smtp-Source: ABdhPJwXC43fuxAW2UnUsDMmsHvdU7hM2Rea/3EzaCzX24wI+UddR1JbWcEXrRuUvNpiaQpksN8Vig== X-Received: by 2002:a05:600c:354a:: with SMTP id i10mr10500941wmq.171.1627309421470; Mon, 26 Jul 2021 07:23:41 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly Date: Mon, 26 Jul 2021 15:23:29 +0100 Message-Id: <20210726142338.31872-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::32d; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32d.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309534086100001 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). build-system.rst seems to have been written under the mistaken assumption that single-backticks mark up literal text (function names, etc) which should be rendered in a fixed-width font. The rST markup for this is ``double backticks``. Update all the markup. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- docs/devel/build-system.rst | 156 ++++++++++++++++++------------------ 1 file changed, 78 insertions(+), 78 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index fd1650442ec..ee660a998d0 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -53,14 +53,14 @@ following tasks: - Add a Meson build option to meson_options.txt. =20 - Add support to the command line arg parser to handle any new - `--enable-XXX`/`--disable-XXX` flags required by the feature. + ``--enable-XXX``/``--disable-XXX`` flags required by the feature. =20 - Add information to the help output message to report on the new feature flag. =20 - Add code to perform the actual feature check. =20 - - Add code to include the feature status in `config-host.h` + - Add code to include the feature status in ``config-host.h`` =20 - Add code to print out the feature status in the configure summary upon completion. @@ -116,51 +116,51 @@ Helper functions The configure script provides a variety of helper functions to assist developers in checking for system features: =20 -`do_cc $ARGS...` +``do_cc $ARGS...`` Attempt to run the system C compiler passing it $ARGS... =20 -`do_cxx $ARGS...` +``do_cxx $ARGS...`` Attempt to run the system C++ compiler passing it $ARGS... =20 -`compile_object $CFLAGS` +``compile_object $CFLAGS`` Attempt to compile a test program with the system C compiler using $CFLAGS. The test program must have been previously written to a file - called $TMPC. The replacement in Meson is the compiler object `cc`, - which has methods such as `cc.compiles()`, - `cc.check_header()`, `cc.has_function()`. + called $TMPC. The replacement in Meson is the compiler object ``cc``, + which has methods such as ``cc.compiles()``, + ``cc.check_header()``, ``cc.has_function()``. =20 -`compile_prog $CFLAGS $LDFLAGS` +``compile_prog $CFLAGS $LDFLAGS`` Attempt to compile a test program with the system C compiler using $CFLAGS and link it with the system linker using $LDFLAGS. The test program must have been previously written to a file called $TMPC. - The replacement in Meson is `cc.find_library()` and `cc.links()`. + The replacement in Meson is ``cc.find_library()`` and ``cc.links()``. =20 -`has $COMMAND` +``has $COMMAND`` Determine if $COMMAND exists in the current environment, either as a shell builtin, or executable binary, returning 0 on success. The - replacement in Meson is `find_program()`. + replacement in Meson is ``find_program()``. =20 -`check_define $NAME` +``check_define $NAME`` Determine if the macro $NAME is defined by the system C compiler =20 -`check_include $NAME` +``check_include $NAME`` Determine if the include $NAME file is available to the system C - compiler. The replacement in Meson is `cc.has_header()`. + compiler. The replacement in Meson is ``cc.has_header()``. =20 -`write_c_skeleton` +``write_c_skeleton`` Write a minimal C program main() function to the temporary file indicated by $TMPC =20 -`feature_not_found $NAME $REMEDY` +``feature_not_found $NAME $REMEDY`` Print a message to stderr that the feature $NAME was not available on the system, suggesting the user try $REMEDY to address the problem. =20 -`error_exit $MESSAGE $MORE...` +``error_exit $MESSAGE $MORE...`` Print $MESSAGE to stderr, followed by $MORE... and then exit from the configure script with non-zero status =20 -`query_pkg_config $ARGS...` +``query_pkg_config $ARGS...`` Run pkg-config passing it $ARGS. If QEMU is doing a static build, then --static will be automatically added to $ARGS =20 @@ -187,7 +187,7 @@ process for: =20 4) other data files, such as icons or desktop files =20 -All executables are built by default, except for some `contrib/` +All executables are built by default, except for some ``contrib/`` binaries that are known to fail to build on some platforms (for example 32-bit or big-endian platforms). Tests are also built by default, though that might change in the future. @@ -195,14 +195,14 @@ though that might change in the future. The source code is highly modularized, split across many files to facilitate building of all of these components with as little duplicated compilation as possible. Using the Meson "sourceset" functionality, -`meson.build` files group the source files in rules that are +``meson.build`` files group the source files in rules that are enabled according to the available system libraries and to various configuration symbols. Sourcesets belong to one of four groups: =20 Subsystem sourcesets: Various subsystems that are common to both tools and emulators have - their own sourceset, for example `block_ss` for the block device subsyst= em, - `chardev_ss` for the character device subsystem, etc. These sourcesets + their own sourceset, for example ``block_ss`` for the block device subsy= stem, + ``chardev_ss`` for the character device subsystem, etc. These sourcesets are then turned into static libraries as follows:: =20 libchardev =3D static_library('chardev', chardev_ss.sources(), @@ -211,8 +211,8 @@ Subsystem sourcesets: =20 chardev =3D declare_dependency(link_whole: libchardev) =20 - As of Meson 0.55.1, the special `.fa` suffix should be used for everythi= ng - that is used with `link_whole`, to ensure that the link flags are placed + As of Meson 0.55.1, the special ``.fa`` suffix should be used for everyt= hing + that is used with ``link_whole``, to ensure that the link flags are plac= ed correctly in the command line. =20 Target-independent emulator sourcesets: @@ -221,16 +221,16 @@ Target-independent emulator sourcesets: This includes error handling infrastructure, standard data structures, platform portability wrapper functions, etc. =20 - Target-independent code lives in the `common_ss`, `softmmu_ss` and - `user_ss` sourcesets. `common_ss` is linked into all emulators, - `softmmu_ss` only in system emulators, `user_ss` only in user-mode + Target-independent code lives in the ``common_ss``, ``softmmu_ss`` and + ``user_ss`` sourcesets. ``common_ss`` is linked into all emulators, + ``softmmu_ss`` only in system emulators, ``user_ss`` only in user-mode emulators. =20 Target-independent sourcesets must exercise particular care when using - `if_false` rules. The `if_false` rule will be used correctly when linki= ng + ``if_false`` rules. The ``if_false`` rule will be used correctly when l= inking emulator binaries; however, when *compiling* target-independent files - into .o files, Meson may need to pick *both* the `if_true` and - `if_false` sides to cater for targets that want either side. To + into .o files, Meson may need to pick *both* the ``if_true`` and + ``if_false`` sides to cater for targets that want either side. To achieve that, you can add a special rule using the ``CONFIG_ALL`` symbol:: =20 @@ -245,14 +245,14 @@ Target-dependent emulator sourcesets: In the target-dependent set lives CPU emulation, some device emulation a= nd much glue code. This sometimes also has to be compiled multiple times, once for each target being built. Target-dependent files are included - in the `specific_ss` sourceset. + in the ``specific_ss`` sourceset. =20 - Each emulator also includes sources for files in the `hw/` and `target/` + Each emulator also includes sources for files in the ``hw/`` and ``targe= t/`` subdirectories. The subdirectory used for each emulator comes from the target's definition of ``TARGET_BASE_ARCH`` or (if missing) - ``TARGET_ARCH``, as found in `default-configs/targets/*.mak`. + ``TARGET_ARCH``, as found in ``default-configs/targets/*.mak``. =20 - Each subdirectory in `hw/` adds one sourceset to the `hw_arch` dictionar= y, + Each subdirectory in ``hw/`` adds one sourceset to the ``hw_arch`` dicti= onary, for example:: =20 arm_ss =3D ss.source_set() @@ -262,8 +262,8 @@ Target-dependent emulator sourcesets: =20 The sourceset is only used for system emulators. =20 - Each subdirectory in `target/` instead should add one sourceset to each - of the `target_arch` and `target_softmmu_arch`, which are used respectiv= ely + Each subdirectory in ``target/`` instead should add one sourceset to each + of the ``target_arch`` and ``target_softmmu_arch``, which are used respe= ctively for all emulators and for system emulators only. For example:: =20 arm_ss =3D ss.source_set() @@ -273,11 +273,11 @@ Target-dependent emulator sourcesets: target_softmmu_arch +=3D {'arm': arm_softmmu_ss} =20 Module sourcesets: - There are two dictionaries for modules: `modules` is used for - target-independent modules and `target_modules` is used for - target-dependent modules. When modules are disabled the `module` - source sets are added to `softmmu_ss` and the `target_modules` - source sets are added to `specific_ss`. + There are two dictionaries for modules: ``modules`` is used for + target-independent modules and ``target_modules`` is used for + target-dependent modules. When modules are disabled the ``module`` + source sets are added to ``softmmu_ss`` and the ``target_modules`` + source sets are added to ``specific_ss``. =20 Both dictionaries are nested. One dictionary is created per subdirectory, and these per-subdirectory dictionaries are added to @@ -290,15 +290,15 @@ Module sourcesets: modules +=3D { 'hw-display': hw_display_modules } =20 Utility sourcesets: - All binaries link with a static library `libqemuutil.a`. This library + All binaries link with a static library ``libqemuutil.a``. This library is built from several sourcesets; most of them however host generated - code, and the only two of general interest are `util_ss` and `stub_ss`. + code, and the only two of general interest are ``util_ss`` and ``stub_ss= ``. =20 The separation between these two is purely for documentation purposes. - `util_ss` contains generic utility files. Even though this code is only + ``util_ss`` contains generic utility files. Even though this code is on= ly linked in some binaries, sometimes it requires hooks only in some of these and depend on other functions that are not fully implemented by - all QEMU binaries. `stub_ss` links dummy stubs that will only be linked + all QEMU binaries. ``stub_ss`` links dummy stubs that will only be link= ed into the binary if the real implementation is not present. In a way, the stubs can be thought of as a portable implementation of the weak symbols concept. @@ -307,8 +307,8 @@ Utility sourcesets: The following files concur in the definition of which files are linked into each emulator: =20 -`default-configs/devices/*.mak` - The files under `default-configs/devices/` control the boards and devices +``default-configs/devices/*.mak`` + The files under ``default-configs/devices/`` control the boards and devi= ces that are built into each QEMU system emulation targets. They merely cont= ain a list of config variable definitions such as:: =20 @@ -316,18 +316,18 @@ into each emulator: CONFIG_XLNX_ZYNQMP_ARM=3Dy CONFIG_XLNX_VERSAL=3Dy =20 -`*/Kconfig` - These files are processed together with `default-configs/devices/*.mak` = and +``*/Kconfig`` + These files are processed together with ``default-configs/devices/*.mak`= ` and describe the dependencies between various features, subsystems and device models. They are described in :ref:`kconfig` =20 -`default-configs/targets/*.mak` - These files mostly define symbols that appear in the `*-config-target.h` +``default-configs/targets/*.mak`` + These files mostly define symbols that appear in the ``*-config-target.h= `` file for each emulator [#cfgtarget]_. However, the ``TARGET_ARCH`` - and ``TARGET_BASE_ARCH`` will also be used to select the `hw/` and - `target/` subdirectories that are compiled into each target. + and ``TARGET_BASE_ARCH`` will also be used to select the ``hw/`` and + ``target/`` subdirectories that are compiled into each target. =20 -.. [#cfgtarget] This header is included by `qemu/osdep.h` when +.. [#cfgtarget] This header is included by ``qemu/osdep.h`` when compiling files from the target-specific sourcesets. =20 These files rarely need changing unless you are adding a completely @@ -339,19 +339,19 @@ Support scripts --------------- =20 Meson has a special convention for invoking Python scripts: if their -first line is `#! /usr/bin/env python3` and the file is *not* executable, +first line is ``#! /usr/bin/env python3`` and the file is *not* executable, find_program() arranges to invoke the script under the same Python interpreter that was used to invoke Meson. This is the most common and preferred way to invoke support scripts from Meson build files, because it automatically uses the value of configure's --python=3D option. =20 -In case the script is not written in Python, use a `#! /usr/bin/env ...` +In case the script is not written in Python, use a ``#! /usr/bin/env ...`` line and make the script executable. =20 Scripts written in Python, where it is desirable to make the script executable (for example for test scripts that developers may want to invoke from the command line, such as tests/qapi-schema/test-qapi.py), -should be invoked through the `python` variable in meson.build. For +should be invoked through the ``python`` variable in meson.build. For example:: =20 test('QAPI schema regression tests', python, @@ -375,10 +375,10 @@ rules and wraps them so that e.g. submodules are buil= t before QEMU. The resulting build system is largely non-recursive in nature, in contrast to common practices seen with automake. =20 -Tests are also ran by the Makefile with the traditional `make check` -phony target, while benchmarks are run with `make bench`. Meson test -suites such as `unit` can be ran with `make check-unit` too. It is also -possible to run tests defined in meson.build with `meson test`. +Tests are also ran by the Makefile with the traditional ``make check`` +phony target, while benchmarks are run with ``make bench``. Meson test +suites such as ``unit`` can be ran with ``make check-unit`` too. It is al= so +possible to run tests defined in meson.build with ``meson test``. =20 Important files for the build system =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=3D @@ -390,28 +390,28 @@ The following key files are statically defined in the= source tree, with the rules needed to build QEMU. Their behaviour is influenced by a number of dynamically created files listed later. =20 -`Makefile` +``Makefile`` The main entry point used when invoking make to build all the components of QEMU. The default 'all' target will naturally result in the build of every component. Makefile takes care of recursively building submodules directly via a non-recursive set of rules. =20 -`*/meson.build` +``*/meson.build`` The meson.build file in the root directory is the main entry point for t= he Meson build system, and it coordinates the configuration and build of all executables. Build rules for various subdirectories are included in other meson.build files spread throughout the QEMU source tree. =20 -`tests/Makefile.include` +``tests/Makefile.include`` Rules for external test harnesses. These include the TCG tests, - `qemu-iotests` and the Avocado-based acceptance tests. + ``qemu-iotests`` and the Avocado-based acceptance tests. =20 -`tests/docker/Makefile.include` +``tests/docker/Makefile.include`` Rules for Docker tests. Like tests/Makefile, this file is included directly by the top level Makefile, anything defined in this file will influence the entire build system. =20 -`tests/vm/Makefile.include` +``tests/vm/Makefile.include`` Rules for VM-based tests. Like tests/Makefile, this file is included directly by the top level Makefile, anything defined in this file will influence the entire build system. @@ -427,11 +427,11 @@ Makefile. =20 Built by configure: =20 -`config-host.mak` +``config-host.mak`` When configure has determined the characteristics of the build host it will write a long list of variables to config-host.mak file. This provides the various install directories, compiler / linker flags and a - variety of `CONFIG_*` variables related to optionally enabled features. + variety of ``CONFIG_*`` variables related to optionally enabled features. This is imported by the top level Makefile and meson.build in order to tailor the build output. =20 @@ -446,29 +446,29 @@ Built by configure: =20 Built by Meson: =20 -`${TARGET-NAME}-config-devices.mak` +``${TARGET-NAME}-config-devices.mak`` TARGET-NAME is again the name of a system or userspace emulator. The config-devices.mak file is automatically generated by make using the scripts/make_device_config.sh program, feeding it the default-configs/$TARGET-NAME file as input. =20 -`config-host.h`, `$TARGET-NAME/config-target.h`, `$TARGET-NAME/config-devi= ces.h` +``config-host.h``, ``$TARGET-NAME/config-target.h``, ``$TARGET-NAME/config= -devices.h`` These files are used by source code to determine what features are enabled. They are generated from the contents of the corresponding - `*.h` files using the scripts/create_config program. This extracts + ``*.h`` files using the scripts/create_config program. This extracts relevant variables and formats them as C preprocessor macros. =20 -`build.ninja` +``build.ninja`` The build rules. =20 =20 Built by Makefile: =20 -`Makefile.ninja` +``Makefile.ninja`` A Makefile include that bridges to ninja for the actual build. The Makefile is mostly a list of targets that Meson included in build.ninja. =20 -`Makefile.mtest` +``Makefile.mtest`` The Makefile definitions that let "make check" run tests defined in meson.build. The rules are produced from Meson's JSON description of tests (obtained with "meson introspect --tests") through the script @@ -478,9 +478,9 @@ Built by Makefile: Useful make targets ------------------- =20 -`help` +``help`` Print a help message for the most common build targets. =20 -`print-VAR` +``print-VAR`` Print the value of the variable VAR. Useful for debugging the build system. --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309530322667.0924530695335; Mon, 26 Jul 2021 07:25:30 -0700 (PDT) Received: from localhost ([::1]:49334 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81Xt-0008FC-6C for importer@patchew.org; Mon, 26 Jul 2021 10:25:29 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42316) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WD-0005O2-BO for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:45 -0400 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]:37829) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WB-0008Oz-Ix for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:45 -0400 Received: by mail-wr1-x429.google.com with SMTP id l4so11317204wrs.4 for ; Mon, 26 Jul 2021 07:23:43 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:42 -0700 (PDT) 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=yn7blkb0f6XoVxzZMIcR5RpiUR0GwJynhTh2o+9emH0=; b=eV10zmHGHRijP6xLdO5AoBQdXngvOtkcW6Gqu3ZwPmy2dVqB+YXNDWrCGIoo1mDf08 KLcLsQWV9tin9aQmI2LbLpEEI02Ejbehh3WWceLJ1ajTmUVYikdKb0fsMz21z1bIcK4y YqXAvyprU4YpwSF4SR/tlqnywK57up7uNCdItfYQt+iH2/gT+95w+SJI47AAYJRFDkSU YMm9sOG6KQ8qad003K6UBoMvu/PAqS2nOwrdiiSqUgZd5VtjfCJo5KMGY+3wacNu6JGi KUJsLkYXg03L09uQEO/tFr/Tlq3/1d+edBSUiJw4Fm8zg/SSCsos+tduPuYrJ7R5ykhK Fv3A== 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=yn7blkb0f6XoVxzZMIcR5RpiUR0GwJynhTh2o+9emH0=; b=ddQ3fvCXFjw3UUX16ZNrYpt885Ld0bInbR3p4wj6m9nbnb7MiWwWuKpFKkxHnhZPjQ RURhSFX4MtDExZZ1AdzlY5IqjwHKN8kzSxnod2G1PQW3Fj7kKXNXQOeMz4IDmRQnC7IH e3FTH+qZ7u/9Wv1vIkfIJbk5tOfIacJRy4Vzd19Q9uSXRXXXractzwrzylUOZyDGvva8 fxuumDwe/I6/Vlq2tmct+jEewT3rnfKmpiiBZhkuLp0iZ1VoukR8D0RzD9p27Ua9fUbi 6qhMIiz/CiUuuPSdmLZg4ILMfuerFVWa25Q3jypH8Vh4ra3pgWTdc3oGukyNuI0Iw6sN frdA== X-Gm-Message-State: AOAM533el4YK/oYfSdJfQARgIQnxCgQA2OrIWtbhvj/ItnQG66ZfqKZc s9/bt2dF9VlcPgH0qzI+ZDbWyhxVwEeNtA== X-Google-Smtp-Source: ABdhPJxxvh17B1wIuFzm/etI74ppV2vzbUtL/azO/tdIsJQGGGK8hdDyBajbO9lDzTyL98Ed5CaFgA== X-Received: by 2002:a5d:6804:: with SMTP id w4mr19287240wru.417.1627309422353; Mon, 26 Jul 2021 07:23:42 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code Date: Mon, 26 Jul 2021 15:23:30 +0100 Message-Id: <20210726142338.31872-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::429; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x429.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309531757100001 Content-Type: text/plain; charset="utf-8" One of the example meson.build fragments incorrectly quotes some symbols as 'CONFIG_FOO`; the correct syntax here is 'CONFIG_FOO'. (This isn't a rST formatting mistake because the example is displayed literally; it's just the wrong kind of quote.) Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Richard Henderson --- docs/devel/build-system.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index ee660a998d0..3baec158f22 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -235,11 +235,11 @@ Target-independent emulator sourcesets: symbol:: =20 # Some targets have CONFIG_ACPI, some don't, so this is not enough - softmmu_ss.add(when: 'CONFIG_ACPI`, if_true: files('acpi.c'), + softmmu_ss.add(when: 'CONFIG_ACPI', if_true: files('acpi.c'), if_false: files('acpi-stub.c')) =20 # This is required as well: - softmmu_ss.add(when: 'CONFIG_ALL`, if_true: files('acpi-stub.c')) + softmmu_ss.add(when: 'CONFIG_ALL', if_true: files('acpi-stub.c')) =20 Target-dependent emulator sourcesets: In the target-dependent set lives CPU emulation, some device emulation a= nd --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309624463938.9543394078646; Mon, 26 Jul 2021 07:27:04 -0700 (PDT) Received: from localhost ([::1]:57750 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81ZP-0005Qs-Fs for importer@patchew.org; Mon, 26 Jul 2021 10:27:03 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42348) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WF-0005Sq-C3 for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:47 -0400 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]:41784) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WD-0008Pg-3q for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:47 -0400 Received: by mail-wm1-x333.google.com with SMTP id a80-20020a1c98530000b0290245467f26a4so132995wme.0 for ; Mon, 26 Jul 2021 07:23:44 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:42 -0700 (PDT) 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=IgI3vvsL2YVBU+vSqnLmuqypZ1Yx7TJO0yv9+ZaGTlg=; b=CJBBprd5Dh6bJymVbKI61UMbxKSC7Tfn6u88ZGjikYz8siO8N6g5mRoCCaQ2Qh3s3z REd5w3WLw4o+42z6VZUUH112LJYZrPvlOqVRKC+l9SqTCvrtG8rfUZAWxfxeRKC5MHxQ bZ1O8StLyrnS+a/mewT5Pj+iERA0yppw89qVyfsGgJjkXNPEBPW5SU+99NBn2tOP6DDp g0GzViXxsmdLyaH5Vyz8iCBD3bncBp24XCyS4JHi+ouk+DzgmfCEFUrE6UT2zPcGoZaD d17V+gz+CXcAcGg5loAASbEK0UtfPIokX/1R3JIgZ231ACY/OkxEkWo2JD9rz3yH3Q1T ICVg== 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=IgI3vvsL2YVBU+vSqnLmuqypZ1Yx7TJO0yv9+ZaGTlg=; b=ZkPlZv7AmJyY4b1h5psnGnhiWc9WqeK7cBsx1/nnucC8R1JmDJPXmf7eZTne+L3swA c2slAfOFPOx8GBw4pqt2VQV1Apu09v8LErbzNY1lD8y3LA3KHpVjH6DGG83mtbt6rY7/ GaaVbtkB4GsDBp6sFefFVX3Ltx1mN0w5Qc9vN/agScqa8tcceoNLrwLymkNMhZO8cA/w Ekw4dnxr4eOLOZb4+Rwvodud0YFvff/97DpjBu2UKBTtiblc4HZlQ1KE5KdOkUI/S69b o4MM5sDUQ6zvASFQ3hGmbK4Fvn1Frzt/K3iKo89/nvaGB6YSX2Otqfex/lJEreACiDiR X/eA== X-Gm-Message-State: AOAM531b94sL66ycoAe/3JS1ObVgHzias3B+LdmXaOn1dTt/xGqFWqM8 sg51S8g/sMNLIEPtSeoDFpBRAphLQcKNag== X-Google-Smtp-Source: ABdhPJwkMGDw2ydGOAl0C2IsgOfyZsdzOvoHwQFMb4lAjbTRoWmnDgMlxronMih30w71EDiC5YPA9A== X-Received: by 2002:a7b:cbda:: with SMTP id n26mr17261564wmi.179.1627309423244; Mon, 26 Jul 2021 07:23:43 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly Date: Mon, 26 Jul 2021 15:23:31 +0100 Message-Id: <20210726142338.31872-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::333; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x333.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309626373100003 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. ebpf_rss.rst gets this wrong in a few places; correct them. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- docs/devel/ebpf_rss.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/devel/ebpf_rss.rst b/docs/devel/ebpf_rss.rst index e00962577ad..4a68682b31a 100644 --- a/docs/devel/ebpf_rss.rst +++ b/docs/devel/ebpf_rss.rst @@ -72,7 +72,7 @@ eBPF RSS implementation =20 eBPF RSS loading functionality located in ebpf/ebpf_rss.c and ebpf/ebpf_rs= s.h. =20 -The `struct EBPFRSSContext` structure that holds 4 file descriptors: +The ``struct EBPFRSSContext`` structure that holds 4 file descriptors: =20 - ctx - pointer of the libbpf context. - program_fd - file descriptor of the eBPF RSS program. @@ -80,20 +80,20 @@ The `struct EBPFRSSContext` structure that holds 4 file= descriptors: - map_toeplitz_key - file descriptor of the 'Toeplitz key' map. One elemen= t of the 40byte key prepared for the hashing algorithm. - map_indirections_table - 128 elements of queue indexes. =20 -`struct EBPFRSSConfig` fields: +``struct EBPFRSSConfig`` fields: =20 -- redirect - "boolean" value, should the hash be calculated, on false - `= default_queue` would be used as the final decision. +- redirect - "boolean" value, should the hash be calculated, on false - `= `default_queue`` would be used as the final decision. - populate_hash - for now, not used. eBPF RSS doesn't support hash reporti= ng. -- hash_types - binary mask of different hash types. See `VIRTIO_NET_RSS_HA= SH_TYPE_*` defines. If for packet hash should not be calculated - `default_= queue` would be used. +- hash_types - binary mask of different hash types. See ``VIRTIO_NET_RSS_H= ASH_TYPE_*`` defines. If for packet hash should not be calculated - ``defau= lt_queue`` would be used. - indirections_len - length of the indirections table, maximum 128. - default_queue - the queue index that used for packet that shouldn't be h= ashed. For some packets, the hash can't be calculated(g.e ARP). =20 Functions: =20 -- `ebpf_rss_init()` - sets ctx to NULL, which indicates that EBPFRSSContex= t is not loaded. -- `ebpf_rss_load()` - creates 3 maps and loads eBPF program from the rss.b= pf.skeleton.h. Returns 'true' on success. After that, program_fd can be use= d to set steering for TAP. -- `ebpf_rss_set_all()` - sets values for eBPF maps. `indirections_table` l= ength is in EBPFRSSConfig. `toeplitz_key` is VIRTIO_NET_RSS_MAX_KEY_SIZE ak= a 40 bytes array. -- `ebpf_rss_unload()` - close all file descriptors and set ctx to NULL. +- ``ebpf_rss_init()`` - sets ctx to NULL, which indicates that EBPFRSSCont= ext is not loaded. +- ``ebpf_rss_load()`` - creates 3 maps and loads eBPF program from the rss= .bpf.skeleton.h. Returns 'true' on success. After that, program_fd can be u= sed to set steering for TAP. +- ``ebpf_rss_set_all()`` - sets values for eBPF maps. ``indirections_table= `` length is in EBPFRSSConfig. ``toeplitz_key`` is VIRTIO_NET_RSS_MAX_KEY_S= IZE aka 40 bytes array. +- ``ebpf_rss_unload()`` - close all file descriptors and set ctx to NULL. =20 Simplified eBPF RSS workflow: =20 @@ -122,4 +122,4 @@ Simplified eBPF RSS workflow: NetClientState SetSteeringEBPF() ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 -For now, `set_steering_ebpf()` method supported by Linux TAP NetClientStat= e. The method requires an eBPF program file descriptor as an argument. +For now, ``set_steering_ebpf()`` method supported by Linux TAP NetClientSt= ate. The method requires an eBPF program file descriptor as an argument. --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309559538451.3345239339287; Mon, 26 Jul 2021 07:25:59 -0700 (PDT) Received: from localhost ([::1]:52118 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81YM-0001eq-FJ for importer@patchew.org; Mon, 26 Jul 2021 10:25:58 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42382) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WG-0005Xb-OX for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:48 -0400 Received: from mail-wm1-x336.google.com ([2a00:1450:4864:20::336]:40663) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WE-0008QU-D9 for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:48 -0400 Received: by mail-wm1-x336.google.com with SMTP id z8-20020a1c4c080000b029022d4c6cfc37so8294013wmf.5 for ; Mon, 26 Jul 2021 07:23:45 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:43 -0700 (PDT) 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=Mf2QwxAd+JWIGrDewPwqms3Ysowyr66X8I/eW3Y0/ns=; b=L6CVNZ6VcX7oUdX+U1OiuLlhiXZ/SJGoFSk3JhPUXyMqa+0ytdLt/SWKjhugZ7p2uK UOI1NVgOAV5vUri9Vlt7stBBPHd69UZJn198NEP1RhKcDIdveY8hLFGQFzlO5J27svdh OVYyoIK8uNsnQNMhIVMy91yGFKbgO4OkdMcl2o9kBjftvs2T/AmxRJwhDpF6ygosZNZG rPWf5UfRyckvPGKBBR4RkVJIcHynJpH+jD/UF1noAttshsVzveB1Sb83mouK82UnDdLt gqruNHBt/g55Sia3UqzJqo1I7rWBHEud1pR9w+eToVMhdNmMcfo2PjFXXhQL33gadIqB q2Vg== 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=Mf2QwxAd+JWIGrDewPwqms3Ysowyr66X8I/eW3Y0/ns=; b=BrCIGlopNISQ80aKIgV/pLsgBCx2ICWvKUC0/ThOievOr6Rg22jrXYqVzwb1DXfDvh OsDpiLQWUOJoMZaIAivm/dkI54eKChIx9WJBH2lTTKVd/KRP2Jh/epDnfjzuxGcJ61UR LbSbvS/J1dFzElUtcKMTohpGvXTlsI62QE/0qI3qIEABSIKLNvZBNjfZjIlsvSnxWLI4 sj3BttnFu7DrnpmY8+VKxyeHWGdk0zW14L/tfwkccZbAhrHIkePoGubXptgdVpKyMd7h I/erSAcjvGjroL6kd0hSFgMoxl33udresf8uqetOZeXW37lMKCWCBcc8ERmEVFTPIUY6 053A== X-Gm-Message-State: AOAM531XrPbx8i65MR/Tp4VjW10BFxiz6crU5g0MIKZQ38jVbLVKH/z1 QWQ9Xavw6qI8WDMsj6bybBSI1/NqTHBVlw== X-Google-Smtp-Source: ABdhPJyRoujRVkVhRmonQbCQhdZJL4Q/TOCz1T1x6PjWf2eDsa+kVTaZtBTBLP8IOiMp5kE6svYPbA== X-Received: by 2002:a05:600c:354e:: with SMTP id i14mr17503187wmq.96.1627309424200; Mon, 26 Jul 2021 07:23:44 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 04/10] docs/devel/migration.rst: Format literals correctly Date: Mon, 26 Jul 2021 15:23:32 +0100 Message-Id: <20210726142338.31872-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::336; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x336.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309560690100001 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. Mostly migration.rst gets this right, but some places incorrectly use single backticks where double backticks were intended; correct them. Signed-off-by: Peter Maydell Acked-by: Dr. David Alan Gilbert Reviewed-by: Richard Henderson --- docs/devel/migration.rst | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/devel/migration.rst b/docs/devel/migration.rst index 19c3d4f3eac..24012534827 100644 --- a/docs/devel/migration.rst +++ b/docs/devel/migration.rst @@ -53,7 +53,7 @@ savevm/loadvm functionality. Debugging =3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -The migration stream can be analyzed thanks to `scripts/analyze-migration.= py`. +The migration stream can be analyzed thanks to ``scripts/analyze-migration= .py``. =20 Example usage: =20 @@ -75,8 +75,8 @@ Common infrastructure =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 The files, sockets or fd's that carry the migration stream are abstracted = by -the ``QEMUFile`` type (see `migration/qemu-file.h`). In most cases this -is connected to a subtype of ``QIOChannel`` (see `io/`). +the ``QEMUFile`` type (see ``migration/qemu-file.h``). In most cases this +is connected to a subtype of ``QIOChannel`` (see ``io/``). =20 =20 Saving the state of one device @@ -166,14 +166,14 @@ An example (from hw/input/pckbd.c) }; =20 We are declaring the state with name "pckbd". -The `version_id` is 3, and the fields are 4 uint8_t in a KBDState structur= e. +The ``version_id`` is 3, and the fields are 4 uint8_t in a KBDState struct= ure. We registered this with: =20 .. code:: c =20 vmstate_register(NULL, 0, &vmstate_kbd, s); =20 -For devices that are `qdev` based, we can register the device in the class +For devices that are ``qdev`` based, we can register the device in the cla= ss init function: =20 .. code:: c @@ -210,9 +210,9 @@ another to load the state back. SaveVMHandlers *ops, void *opaque); =20 -Two functions in the ``ops`` structure are the `save_state` -and `load_state` functions. Notice that `load_state` receives a version_id -parameter to know what state format is receiving. `save_state` doesn't +Two functions in the ``ops`` structure are the ``save_state`` +and ``load_state`` functions. Notice that ``load_state`` receives a versi= on_id +parameter to know what state format is receiving. ``save_state`` doesn't have a version_id parameter because it always uses the latest version. =20 Note that because the VMState macros still save the data in a raw @@ -385,18 +385,18 @@ migration of a device, and using them breaks backward= -migration compatibility; in general most changes can be made by adding Subsections (see above) or _TEST macros (see above) which won't break compatibility. =20 -Each version is associated with a series of fields saved. The `save_state= ` always saves -the state as the newer version. But `load_state` sometimes is able to +Each version is associated with a series of fields saved. The ``save_stat= e`` always saves +the state as the newer version. But ``load_state`` sometimes is able to load state from an older version. =20 You can see that there are several version fields: =20 -- `version_id`: the maximum version_id supported by VMState for that devic= e. -- `minimum_version_id`: the minimum version_id that VMState is able to und= erstand +- ``version_id``: the maximum version_id supported by VMState for that dev= ice. +- ``minimum_version_id``: the minimum version_id that VMState is able to u= nderstand for that device. -- `minimum_version_id_old`: For devices that were not able to port to vmst= ate, we can +- ``minimum_version_id_old``: For devices that were not able to port to vm= state, we can assign a function that knows how to read this old state. This field is - ignored if there is no `load_state_old` handler. + ignored if there is no ``load_state_old`` handler. =20 VMState is able to read versions from minimum_version_id to version_id. And the function ``load_state_old()`` (if present) is able to @@ -454,7 +454,7 @@ data and then transferred to the main structure. =20 If you use memory API functions that update memory layout outside initialization (i.e., in response to a guest action), this is a strong -indication that you need to call these functions in a `post_load` callback. +indication that you need to call these functions in a ``post_load`` callba= ck. Examples of such memory API functions are: =20 - memory_region_add_subregion() @@ -823,12 +823,12 @@ 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. =20 -The Linux kernel userfault support works on `/dev/shm` memory and on `huge= tlbfs` -(although the kernel doesn't provide an equivalent to `madvise(MADV_DONTNE= ED)` +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)`` for hugetlbfs which may be a problem in some configurations). =20 The vhost-user code in QEMU supports clients that have Postcopy support, -and the `vhost-user-bridge` (in `tests/`) and the DPDK package have changes +and the ``vhost-user-bridge`` (in ``tests/``) and the DPDK package have ch= anges to support postcopy. =20 The client needs to open a userfaultfd and register the areas --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 16273097796841005.7541844246429; Mon, 26 Jul 2021 07:29:39 -0700 (PDT) Received: from localhost ([::1]:38002 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81bu-0002kf-JQ for importer@patchew.org; Mon, 26 Jul 2021 10:29:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42384) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WH-0005YP-0k for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:49 -0400 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:39457) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WE-0008R9-TH for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:48 -0400 Received: by mail-wr1-x432.google.com with SMTP id e2so11312358wrq.6 for ; Mon, 26 Jul 2021 07:23:46 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:44 -0700 (PDT) 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=sE8AHXwCcmk/41Hwf9/dPSWG/yzq4enhkHMBHWg8JOk=; b=k2uc9YMHDWKyCA9pPwwqZTgQKa4Pkm/L3p6weS1TUJO3hQpNZfDMgG0p9iOGH4ykED GfL/42xlnfqoUykgwpSHMP0sP03tyx/rv2koU4jIX+iy1wNgZQMCHbOfRN7oboP28Lcs 1jBHBcsIqW+tTnNEbjfR50/dEUdKjhzeL/ESXNd3JzBxSj8h6gNOXcH8fxnHJ/C77Hr0 E7v4QgvyNttCFfRyHHUzb+fTa08cK4N5EJZXz1rtw0LeXdp4XAoplHmH+gBDiu90jFyd aMAiFWKpQbiWU4404BpNnlOnXua8wpd19rnMspcVrzZpV+Mj/WI+B3wxLv7jKxpyxO5b lg6w== 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=sE8AHXwCcmk/41Hwf9/dPSWG/yzq4enhkHMBHWg8JOk=; b=NPN9m93MFfi9UFrXnoyxskSSMOSsdo37fPL3oYrwHZUrFkI9liFG46tS6UgfrCCqmq Ppq3miTwbhkZN2DNqhi6u5s5WN2dTLYK1fZezdhHdMcmPo4bBc6bAGCAtejWWp18XGoN iZ13JAVPSNpI1NVUjLu03sUdpr1UF57cwVDk06tHw+fiEA3LLXTxjQOQwen85M6jyUMy qneBzVgFBBOEeoFTNJLTjO8mh3TqAVRM15i4XubssBCj9D5H8HcAn+e0I4Mxhj1GhRgQ oGgeHzsZcT+lFJiqfOti7fK18I9aGnYPI3E8gbw70frLDq4vEooeoLigjjJGaJK3GdnF wu0g== X-Gm-Message-State: AOAM533uG7b/4Q0mvicwqFnrk8JfUj4jITNlQQtoFgOs5JrjDTvLjy5Y HaqJ0VdMw7LjvshTZJcZhhsynBDiammQmQ== X-Google-Smtp-Source: ABdhPJzEsZjqEAjlZN6jPYtiWP2z09BXd7gK/Khrh8xShPJaQfN0nHPjXRHCrA/9Akt/hq1elOy5FQ== X-Received: by 2002:a5d:408a:: with SMTP id o10mr19093938wrp.272.1627309425138; Mon, 26 Jul 2021 07:23:45 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 05/10] docs/devel: Format literals correctly Date: Mon, 26 Jul 2021 15:23:33 +0100 Message-Id: <20210726142338.31872-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::432; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x432.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309780313100001 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). Fix various places in the devel section of the manual which were using single backticks when double backticks (for literal text) were intended. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- docs/devel/qgraph.rst | 8 ++++---- docs/devel/tcg-plugins.rst | 14 +++++++------- docs/devel/testing.rst | 8 ++++---- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/devel/qgraph.rst b/docs/devel/qgraph.rst index 318534d4b08..39e293687e6 100644 --- a/docs/devel/qgraph.rst +++ b/docs/devel/qgraph.rst @@ -66,11 +66,11 @@ Notes for the nodes: Edges ^^^^^^ =20 -An edge relation between two nodes (drivers or machines) `X` and `Y` can b= e: +An edge relation between two nodes (drivers or machines) ``X`` and ``Y`` c= an be: =20 -- ``X CONSUMES Y``: `Y` can be plugged into `X` -- ``X PRODUCES Y``: `X` provides the interface `Y` -- ``X CONTAINS Y``: `Y` is part of `X` component +- ``X CONSUMES Y``: ``Y`` can be plugged into ``X`` +- ``X PRODUCES Y``: ``X`` provides the interface ``Y`` +- ``X CONTAINS Y``: ``Y`` is part of ``X`` component =20 Execution steps ^^^^^^^^^^^^^^^ diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 7e54f128375..047bf4ada7c 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -34,11 +34,11 @@ version they were built against. This can be done simpl= y by:: QEMU_PLUGIN_EXPORT int qemu_plugin_version =3D QEMU_PLUGIN_VERSION; =20 The core code will refuse to load a plugin that doesn't export a -`qemu_plugin_version` symbol or if plugin version is outside of QEMU's +``qemu_plugin_version`` symbol or if plugin version is outside of QEMU's supported range of API versions. =20 -Additionally the `qemu_info_t` structure which is passed to the -`qemu_plugin_install` method of a plugin will detail the minimum and +Additionally the ``qemu_info_t`` structure which is passed to the +``qemu_plugin_install`` method of a plugin will detail the minimum and current API versions supported by QEMU. The API version will be incremented if new APIs are added. The minimum API version will be incremented if existing APIs are changed or removed. @@ -146,12 +146,12 @@ Example Plugins =20 There are a number of plugins included with QEMU and you are encouraged to contribute your own plugins plugins upstream. There is a -`contrib/plugins` directory where they can go. +``contrib/plugins`` directory where they can go. =20 - tests/plugins =20 These are some basic plugins that are used to test and exercise the -API during the `make check-tcg` target. +API during the ``make check-tcg`` target. =20 - contrib/plugins/hotblocks.c =20 @@ -163,7 +163,7 @@ with linux-user execution as system emulation tends to = generate re-translations as blocks from different programs get swapped in and out of system memory. =20 -If your program is single-threaded you can use the `inline` option for +If your program is single-threaded you can use the ``inline`` option for slightly faster (but not thread safe) counters. =20 Example:: @@ -251,7 +251,7 @@ which will lead to a sorted list after the class breakd= own:: ... =20 To find the argument shorthand for the class you need to examine the -source code of the plugin at the moment, specifically the `*opt` +source code of the plugin at the moment, specifically the ``*opt`` argument in the InsnClassExecCount tables. =20 - contrib/plugins/lockstep.c diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst index 8f572255d32..8a9cda33a5d 100644 --- a/docs/devel/testing.rst +++ b/docs/devel/testing.rst @@ -775,7 +775,7 @@ The base test class has also support for tests with mor= e than one QEMUMachine. The way to get machines is through the ``self.get_vm()`` method which will return a QEMUMachine instance. The ``self.get_vm()`` method accepts arguments that will be passed to the QEMUMachine creation -and also an optional `name` attribute so you can identify a specific +and also an optional ``name`` attribute so you can identify a specific machine and get it more than once through the tests methods. A simple and hypothetical example follows: =20 @@ -1062,7 +1062,7 @@ Here is a list of the most used variables: AVOCADO_ALLOW_LARGE_STORAGE ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Tests which are going to fetch or produce assets considered *large* are not -going to run unless that `AVOCADO_ALLOW_LARGE_STORAGE=3D1` is exported on +going to run unless that ``AVOCADO_ALLOW_LARGE_STORAGE=3D1`` is exported on the environment. =20 The definition of *large* is a bit arbitrary here, but it usually means an @@ -1076,7 +1076,7 @@ skipped by default. The definition of *not safe* is a= lso arbitrary but usually it means a blob which either its source or build process aren't public available. =20 -You should export `AVOCADO_ALLOW_UNTRUSTED_CODE=3D1` on the environment in +You should export ``AVOCADO_ALLOW_UNTRUSTED_CODE=3D1`` on the environment = in order to allow tests which make use of those kind of assets. =20 AVOCADO_TIMEOUT_EXPECTED @@ -1090,7 +1090,7 @@ property defined in the test class, for further detai= ls:: Even though the timeout can be set by the test developer, there are some t= ests that may not have a well-defined limit of time to finish under certain conditions. For example, tests that take longer to execute when QEMU is -compiled with debug flags. Therefore, the `AVOCADO_TIMEOUT_EXPECTED` varia= ble +compiled with debug flags. Therefore, the ``AVOCADO_TIMEOUT_EXPECTED`` var= iable has been used to determine whether those tests should run or not. =20 GITLAB_CI --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309617164378.4598476113615; Mon, 26 Jul 2021 07:26:57 -0700 (PDT) Received: from localhost ([::1]:57148 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81ZI-00052D-4W for importer@patchew.org; Mon, 26 Jul 2021 10:26:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42386) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WH-0005Zl-Cu for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:49 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:39461) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WF-0008RX-GA for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:49 -0400 Received: by mail-wr1-x436.google.com with SMTP id e2so11312406wrq.6 for ; Mon, 26 Jul 2021 07:23:47 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:45 -0700 (PDT) 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=UigroMdf1guDPuwFhMX1nmIx4c8X1Ptid/7aSU8rYdk=; b=U1Oi0Od4BqRoT2ncW22GF/WQ/Al9/lNCbHC5HZ7ca+3KejayQSDKCew2k6VWes9MR+ BGTr6Tq2nakqZVqCOgKH8HP3wGDPA+AGwYNzEAxP/V54SQ2ablBlNawIK29nbzd8Dl1b xyC7Yols83SIIq0zsPSx75HTpZsJLyG+NZVwvomxcG06tfuiLKIwJtKLLZBggHRmkWbn 75Vx/7kRfMVwDY46Ik2MLQCHvrOktUDII5yPxTq3Z2amgIvamjWNvBHOkp71XI8jHBRF j8sBssz7OeW+Yc+BBjoSY3mlafzXxvRnB/MznDMb6uKy4FRtHBHtm8WKcDWSe1h5qt+m XCqA== 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=UigroMdf1guDPuwFhMX1nmIx4c8X1Ptid/7aSU8rYdk=; b=Wii2kIZV6UjrimqFmIPk5MsaMZnEIxeuiVO0Y5RAED1Bg2ReHanFCb/6yeoPvDkOuA AHcZZUy4lsBR/Ec7TDM8zSGzCaWmtvHoMA9Zbvg74hebiL3NugFeounAFTHreJZLbtSh K61sjGeZs0CVk7PFI7/sSOeIrzX68bTXS1BKA5koPEF7us+K4Ifp17DlNHsG78Og+uE+ Y/larm7qH9+f5eRt2tSoM7lRnWEvMoAYOCRsd+IXbhc6ZSfjZazqj7XJAPIMbqCXzoYr e9BfoIXAu/cxgNBxFqM+OvMSQw+qpMf3Rr68hYQVvBDH09cWwBihHrwJ/3V7ECQe6vUd cwwQ== X-Gm-Message-State: AOAM5304vSLcSRCQ+WuvHHTbFU/6h74QCEFPlBm7SY+5yjwPg/S74ddJ 33XiO9z+jtD4jovwvh3WoFZmf8II6VIKbA== X-Google-Smtp-Source: ABdhPJyIxeeznvuOgtGdsAq8l4snbp1vjqGGN3iXcPU46D42Pnkw+6A8ffD8GKTRhBZ5EWrv4zEbDw== X-Received: by 2002:a05:6000:154c:: with SMTP id 12mr19754938wry.393.1627309425970; Mon, 26 Jul 2021 07:23:45 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly Date: Mon, 26 Jul 2021 15:23:34 +0100 Message-Id: <20210726142338.31872-7-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::436; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x436.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309618008100001 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. protvirt.rst consistently uses single backticks when double backticks are required; correct it. Signed-off-by: Peter Maydell Acked-by: Cornelia Huck Reviewed-by: Richard Henderson --- docs/system/s390x/protvirt.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/system/s390x/protvirt.rst b/docs/system/s390x/protvirt.rst index 0f481043d99..aee63ed7ec9 100644 --- a/docs/system/s390x/protvirt.rst +++ b/docs/system/s390x/protvirt.rst @@ -14,11 +14,11 @@ Prerequisites To run PVMs, a machine with the Protected Virtualization feature, as indicated by the Ultravisor Call facility (stfle bit 158), is required. The Ultravisor needs to be initialized at boot by setting -`prot_virt=3D1` on the host's kernel command line. +``prot_virt=3D1`` on the host's kernel command line. =20 Running PVMs requires using the KVM hypervisor. =20 -If those requirements are met, the capability `KVM_CAP_S390_PROTECTED` +If those requirements are met, the capability ``KVM_CAP_S390_PROTECTED`` will indicate that KVM can support PVMs on that LPAR. =20 =20 @@ -26,15 +26,15 @@ Running a Protected Virtual Machine ----------------------------------- =20 To run a PVM you will need to select a CPU model which includes the -`Unpack facility` (stfle bit 161 represented by the feature -`unpack`/`S390_FEAT_UNPACK`), and add these options to the command line:: +``Unpack facility`` (stfle bit 161 represented by the feature +``unpack``/``S390_FEAT_UNPACK``), and add these options to the command lin= e:: =20 -object s390-pv-guest,id=3Dpv0 \ -machine confidential-guest-support=3Dpv0 =20 Adding these options will: =20 -* Ensure the `unpack` facility is available +* Ensure the ``unpack`` facility is available * Enable the IOMMU by default for all I/O devices * Initialize the PV mechanism =20 @@ -63,5 +63,5 @@ from the disk boot. This memory layout includes the encry= pted components (kernel, initrd, cmdline), the stage3a loader and metadata. In case this boot method is used, the command line options -initrd and -cmdline are ineffective. The preparation of a PVM -image is done via the `genprotimg` tool from the s390-tools +image is done via the ``genprotimg`` tool from the s390-tools collection. --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309754299990.319806638183; Mon, 26 Jul 2021 07:29:14 -0700 (PDT) Received: from localhost ([::1]:35744 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81bV-0001Cz-2C for importer@patchew.org; Mon, 26 Jul 2021 10:29:13 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42438) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WL-0005r2-F5 for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:53 -0400 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:42537) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WG-0008Sf-J9 for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:53 -0400 Received: by mail-wm1-x32f.google.com with SMTP id e25-20020a05600c4b99b0290253418ba0fbso109407wmp.1 for ; Mon, 26 Jul 2021 07:23:48 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.46 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:46 -0700 (PDT) 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=L4k2864pl4R2dWHbyQVhIxQIrLjbv610/CR7GEyyZ2w=; b=RXRvy6v5LsrDcB+oIcfyazmQJTlKl7VZXP4MJjI6QOEz+olBID4ouaEeLUKk179CX7 el2wfpsnFCKupNGJVbZrHFX/5yWFsmEOJIBhA3L7B5QSqRlxtQYsC176U9RIld6dZo3Z 4D1XfPLZVWh9xoyfUEfRfwYyhJciwxr6tL5S9vmsdtXLdraduZe4OnS3BXOfsFodk58r U1oEbWgFeCIxMo/yI++WPdljf8a32/M4oItYa64QFXSz7XNLKUopUEyM1b3TU2IxpQ2Q 4FdNcpP75I6ZO/NS6CYvHOidpHnB31SUs8fnxcFCoqSwvB717vpX1wtxHSaCpWsQ9G5f wNIw== 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=L4k2864pl4R2dWHbyQVhIxQIrLjbv610/CR7GEyyZ2w=; b=eWIlOerUYRxLD1Ac61/IyBVBvpqZ4lzfegwtLOR2/u7yAUblGgCbGrH3SK6UnxFZUd NWbFUjr6GrmvEIlOvDLgnTZrTrYxv410BHSwc0qxBJvNAl2RYNB/wfj9A1zHZXku4WJb 38emC/OsUmgcXMcDLsHmvotDrKuzJFepvhrtvsIKunRrAPM98B/GUkQiqZB1h6M0cIZS qYq3S+f2xi36K+hoa/BEGDfiDz3f4yFYmfFNeEatUly06sexSfNOBTUh70fsP9Kly9k3 fgweOXGYhxWrgaUsoxIpbJZhjVAMK1l76bcplM7BP0C9+PvcXyMNZtJGyh+AmYHvlmJj KJCA== X-Gm-Message-State: AOAM5339rW2v5fLkTajuzjA0n+mR44mnZQHHqH/BUnvvCaLrAHlkGytO w0YFyt1qdKnYzBVJ3JUA9lwqKnxWRzumRA== X-Google-Smtp-Source: ABdhPJxTkYZrqd46R+FXBXCrUjh+1HozbjUONdqdac1K2XcCSCMPWUtGW9Xn8iqUNgDK+3G+GpAgXQ== X-Received: by 2002:a1c:5419:: with SMTP id i25mr17499931wmb.71.1627309426977; Mon, 26 Jul 2021 07:23:46 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 07/10] docs/system/arm/cpu-features.rst: Format literals correctly Date: Mon, 26 Jul 2021 15:23:35 +0100 Message-Id: <20210726142338.31872-8-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::32f; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32f.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309754772100001 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. cpu-features.rst consistently uses single backticks when double backticks are required; correct it. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- docs/system/arm/cpu-features.rst | 116 +++++++++++++++---------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/system/arm/cpu-features.rst b/docs/system/arm/cpu-feature= s.rst index c455442eaf5..ca1420b0463 100644 --- a/docs/system/arm/cpu-features.rst +++ b/docs/system/arm/cpu-features.rst @@ -10,22 +10,22 @@ is the Performance Monitoring Unit (PMU). CPU types su= ch as the Cortex-A15 and the Cortex-A57, which respectively implement Arm architecture reference manuals ARMv7-A and ARMv8-A, may both optionally implement PMUs. For example, if a user wants to use a Cortex-A15 without -a PMU, then the `-cpu` parameter should contain `pmu=3Doff` on the QEMU -command line, i.e. `-cpu cortex-a15,pmu=3Doff`. +a PMU, then the ``-cpu`` parameter should contain ``pmu=3Doff`` on the QEMU +command line, i.e. ``-cpu cortex-a15,pmu=3Doff``. =20 As not all CPU types support all optional CPU features, then whether or not a CPU property exists depends on the CPU type. For example, CPUs that implement the ARMv8-A architecture reference manual may optionally support the AArch32 CPU feature, which may be enabled by disabling the -`aarch64` CPU property. A CPU type such as the Cortex-A15, which does -not implement ARMv8-A, will not have the `aarch64` CPU property. +``aarch64`` CPU property. A CPU type such as the Cortex-A15, which does +not implement ARMv8-A, will not have the ``aarch64`` CPU property. =20 QEMU's support may be limited for some CPU features, only partially supporting the feature or only supporting the feature under certain -configurations. For example, the `aarch64` CPU feature, which, when +configurations. For example, the ``aarch64`` CPU feature, which, when disabled, enables the optional AArch32 CPU feature, is only supported when using the KVM accelerator and when running on a host CPU type that -supports the feature. While `aarch64` currently only works with KVM, +supports the feature. While ``aarch64`` currently only works with KVM, it could work with TCG. CPU features that are specific to KVM are prefixed with "kvm-" and are described in "KVM VCPU Features". =20 @@ -33,12 +33,12 @@ CPU Feature Probing =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 Determining which CPU features are available and functional for a given -CPU type is possible with the `query-cpu-model-expansion` QMP command. -Below are some examples where `scripts/qmp/qmp-shell` (see the top comment +CPU type is possible with the ``query-cpu-model-expansion`` QMP command. +Below are some examples where ``scripts/qmp/qmp-shell`` (see the top comme= nt block in the script for usage) is used to issue the QMP commands. =20 -1. Determine which CPU features are available for the `max` CPU type - (Note, we started QEMU with qemu-system-aarch64, so `max` is +1. Determine which CPU features are available for the ``max`` CPU type + (Note, we started QEMU with qemu-system-aarch64, so ``max`` is implementing the ARMv8-A reference manual in this case):: =20 (QEMU) query-cpu-model-expansion type=3Dfull model=3D{"name":"max"} @@ -51,9 +51,9 @@ block in the script for usage) is used to issue the QMP c= ommands. "sve896": true, "sve1280": true, "sve2048": true }}}} =20 -We see that the `max` CPU type has the `pmu`, `aarch64`, `sve`, and many -`sve` CPU features. We also see that all the CPU features are -enabled, as they are all `true`. (The `sve` CPU features are all +We see that the ``max`` CPU type has the ``pmu``, ``aarch64``, ``sve``, an= d many +``sve`` CPU features. We also see that all the CPU features are +enabled, as they are all ``true``. (The ``sve`` CPU features are all optional SVE vector lengths (see "SVE CPU Properties"). While with TCG all SVE vector lengths can be supported, when KVM is in use it's more likely that only a few lengths will be supported, if SVE is supported at @@ -71,9 +71,9 @@ all.) "sve896": true, "sve1280": true, "sve2048": true }}}} =20 -We see it worked, as `pmu` is now `false`. +We see it worked, as ``pmu`` is now ``false``. =20 -(3) Let's try to disable `aarch64`, which enables the AArch32 CPU feature:: +(3) Let's try to disable ``aarch64``, which enables the AArch32 CPU featur= e:: =20 (QEMU) query-cpu-model-expansion type=3Dfull model=3D{"name":"max","= props":{"aarch64":false}} {"error": { @@ -84,7 +84,7 @@ We see it worked, as `pmu` is now `false`. It looks like this feature is limited to a configuration we do not currently have. =20 -(4) Let's disable `sve` and see what happens to all the optional SVE +(4) Let's disable ``sve`` and see what happens to all the optional SVE vector lengths:: =20 (QEMU) query-cpu-model-expansion type=3Dfull model=3D{"name":"max","= props":{"sve":false}} @@ -97,14 +97,14 @@ currently have. "sve896": false, "sve1280": false, "sve2048": false }}}} =20 -As expected they are now all `false`. +As expected they are now all ``false``. =20 (5) Let's try probing CPU features for the Cortex-A15 CPU type:: =20 (QEMU) query-cpu-model-expansion type=3Dfull model=3D{"name":"cortex= -a15"} {"return": {"model": {"name": "cortex-a15", "props": {"pmu": true}}}} =20 -Only the `pmu` CPU feature is available. +Only the ``pmu`` CPU feature is available. =20 A note about CPU feature dependencies ------------------------------------- @@ -123,29 +123,29 @@ A note about CPU models and KVM ------------------------------- =20 Named CPU models generally do not work with KVM. There are a few cases -that do work, e.g. using the named CPU model `cortex-a57` with KVM on a -seattle host, but mostly if KVM is enabled the `host` CPU type must be +that do work, e.g. using the named CPU model ``cortex-a57`` with KVM on a +seattle host, but mostly if KVM is enabled the ``host`` CPU type must be used. This means the guest is provided all the same CPU features as the -host CPU type has. And, for this reason, the `host` CPU type should +host CPU type has. And, for this reason, the ``host`` CPU type should enable all CPU features that the host has by default. Indeed it's even a bit strange to allow disabling CPU features that the host has when using -the `host` CPU type, but in the absence of CPU models it's the best we can +the ``host`` CPU type, but in the absence of CPU models it's the best we c= an do if we want to launch guests without all the host's CPU features enabled. =20 -Enabling KVM also affects the `query-cpu-model-expansion` QMP command. The +Enabling KVM also affects the ``query-cpu-model-expansion`` QMP command. = The affect is not only limited to specific features, as pointed out in example (3) of "CPU Feature Probing", but also to which CPU types may be expanded. -When KVM is enabled, only the `max`, `host`, and current CPU type may be +When KVM is enabled, only the ``max``, ``host``, and current CPU type may = be expanded. This restriction is necessary as it's not possible to know all CPU types that may work with KVM, but it does impose a small risk of users experiencing unexpected errors. For example on a seattle, as mentioned -above, the `cortex-a57` CPU type is also valid when KVM is enabled. -Therefore a user could use the `host` CPU type for the current type, but -then attempt to query `cortex-a57`, however that query will fail with our +above, the ``cortex-a57`` CPU type is also valid when KVM is enabled. +Therefore a user could use the ``host`` CPU type for the current type, but +then attempt to query ``cortex-a57``, however that query will fail with our restrictions. This shouldn't be an issue though as management layers and -users have been preferring the `host` CPU type for use with KVM for quite +users have been preferring the ``host`` CPU type for use with KVM for quite some time. Additionally, if the KVM-enabled QEMU instance running on a -seattle host is using the `cortex-a57` CPU type, then querying `cortex-a57` +seattle host is using the ``cortex-a57`` CPU type, then querying ``cortex-= a57`` will work. =20 Using CPU Features @@ -158,12 +158,12 @@ QEMU command line with that CPU type:: $ qemu-system-aarch64 -M virt -cpu max,pmu=3Doff,sve=3Don,sve128=3Don,sv= e256=3Don =20 The example above disables the PMU and enables the first two SVE vector -lengths for the `max` CPU type. Note, the `sve=3Don` isn't actually -necessary, because, as we observed above with our probe of the `max` CPU -type, `sve` is already on by default. Also, based on our probe of +lengths for the ``max`` CPU type. Note, the ``sve=3Don`` isn't actually +necessary, because, as we observed above with our probe of the ``max`` CPU +type, ``sve`` is already on by default. Also, based on our probe of defaults, it would seem we need to disable many SVE vector lengths, rather than only enabling the two we want. This isn't the case, because, as -disabling many SVE vector lengths would be quite verbose, the `sve` CPU +disabling many SVE vector lengths would be quite verbose, the ``sve`` C= PU properties have special semantics (see "SVE CPU Property Parsing Semantics"). =20 @@ -217,11 +217,11 @@ TCG VCPU Features TCG VCPU features are CPU features that are specific to TCG. Below is the list of TCG VCPU features and their descriptions. =20 - pauth Enable or disable `FEAT_Pauth`, pointer + pauth Enable or disable ``FEAT_Pauth``, pointer authentication. By default, the feature is - enabled with `-cpu max`. + enabled with ``-cpu max``. =20 - pauth-impdef When `FEAT_Pauth` is enabled, either the + pauth-impdef When ``FEAT_Pauth`` is enabled, either the *impdef* (Implementation Defined) algorithm is enabled or the *architected* QARMA algorithm is enabled. By default the impdef algorithm @@ -235,49 +235,49 @@ Below is the list of TCG VCPU features and their desc= riptions. SVE CPU Properties =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -There are two types of SVE CPU properties: `sve` and `sve`. The first -is used to enable or disable the entire SVE feature, just as the `pmu` +There are two types of SVE CPU properties: ``sve`` and ``sve``. The fi= rst +is used to enable or disable the entire SVE feature, just as the ``pmu`` CPU property completely enables or disables the PMU. The second type -is used to enable or disable specific vector lengths, where `N` is the -number of bits of the length. The `sve` CPU properties have special +is used to enable or disable specific vector lengths, where ``N`` is the +number of bits of the length. The ``sve`` CPU properties have special dependencies and constraints, see "SVE CPU Property Dependencies and Constraints" below. Additionally, as we want all supported vector lengths to be enabled by default, then, in order to avoid overly verbose command -lines (command lines full of `sve=3Doff`, for all `N` not wanted), we +lines (command lines full of ``sve=3Doff``, for all ``N`` not wanted), = we provide the parsing semantics listed in "SVE CPU Property Parsing Semantics". =20 SVE CPU Property Dependencies and Constraints --------------------------------------------- =20 - 1) At least one vector length must be enabled when `sve` is enabled. + 1) At least one vector length must be enabled when ``sve`` is enabled. =20 - 2) If a vector length `N` is enabled, then, when KVM is enabled, all + 2) If a vector length ``N`` is enabled, then, when KVM is enabled, all smaller, host supported vector lengths must also be enabled. If KVM is not enabled, then only all the smaller, power-of-two vector lengths must be enabled. E.g. with KVM if the host supports all - vector lengths up to 512-bits (128, 256, 384, 512), then if `sve512` + vector lengths up to 512-bits (128, 256, 384, 512), then if ``sve512`` is enabled, the 128-bit vector length, 256-bit vector length, and 384-bit vector length must also be enabled. Without KVM, the 384-bit vector length would not be required. =20 3) If KVM is enabled then only vector lengths that the host CPU type support may be enabled. If SVE is not supported by the host, then - no `sve*` properties may be enabled. + no ``sve*`` properties may be enabled. =20 SVE CPU Property Parsing Semantics ---------------------------------- =20 - 1) If SVE is disabled (`sve=3Doff`), then which SVE vector lengths + 1) If SVE is disabled (``sve=3Doff``), then which SVE vector lengths are enabled or disabled is irrelevant to the guest, as the entire SVE feature is disabled and that disables all vector lengths for - the guest. However QEMU will still track any `sve` CPU - properties provided by the user. If later an `sve=3Don` is provided, - then the guest will get only the enabled lengths. If no `sve=3Don` + the guest. However QEMU will still track any ``sve`` CPU + properties provided by the user. If later an ``sve=3Don`` is provide= d, + then the guest will get only the enabled lengths. If no ``sve=3Don`` is provided and there are explicitly enabled vector lengths, then an error is generated. =20 - 2) If SVE is enabled (`sve=3Don`), but no `sve` CPU properties are + 2) If SVE is enabled (``sve=3Don``), but no ``sve`` CPU properties are provided, then all supported vector lengths are enabled, which when KVM is not in use means including the non-power-of-two lengths, and, when KVM is in use, it means all vector lengths supported by the host @@ -293,7 +293,7 @@ SVE CPU Property Parsing Semantics constraint (2) of "SVE CPU Property Dependencies and Constraints"). =20 5) When KVM is enabled, if the host does not support SVE, then an error - is generated when attempting to enable any `sve*` properties (see + is generated when attempting to enable any ``sve*`` properties (see constraint (3) of "SVE CPU Property Dependencies and Constraints"). =20 6) When KVM is enabled, if the host does support SVE, then an error is @@ -301,8 +301,8 @@ SVE CPU Property Parsing Semantics by the host (see constraint (3) of "SVE CPU Property Dependencies and Constraints"). =20 - 7) If one or more `sve` CPU properties are set `off`, but no `sve`, - CPU properties are set `on`, then the specified vector lengths are + 7) If one or more ``sve`` CPU properties are set ``off``, but no ``sv= e``, + CPU properties are set ``on``, then the specified vector lengths are disabled but the default for any unspecified lengths remains enabled. When KVM is not enabled, disabling a power-of-two vector length also disables all vector lengths larger than the power-of-two length. @@ -310,15 +310,15 @@ SVE CPU Property Parsing Semantics disables all larger vector lengths (see constraint (2) of "SVE CPU Property Dependencies and Constraints"). =20 - 8) If one or more `sve` CPU properties are set to `on`, then they + 8) If one or more ``sve`` CPU properties are set to ``on``, then they are enabled and all unspecified lengths default to disabled, except for the required lengths per constraint (2) of "SVE CPU Property Dependencies and Constraints", which will even be auto-enabled if they were not explicitly enabled. =20 - 9) If SVE was disabled (`sve=3Doff`), allowing all vector lengths to be + 9) If SVE was disabled (``sve=3Doff``), allowing all vector lengths to be explicitly disabled (i.e. avoiding the error specified in (3) of - "SVE CPU Property Parsing Semantics"), then if later an `sve=3Don` is + "SVE CPU Property Parsing Semantics"), then if later an ``sve=3Don`` = is provided an error will be generated. To avoid this error, one must enable at least one vector length prior to enabling SVE. =20 @@ -329,12 +329,12 @@ SVE CPU Property Examples =20 $ qemu-system-aarch64 -M virt -cpu max,sve=3Doff =20 - 2) Implicitly enable all vector lengths for the `max` CPU type:: + 2) Implicitly enable all vector lengths for the ``max`` CPU type:: =20 $ qemu-system-aarch64 -M virt -cpu max =20 3) When KVM is enabled, implicitly enable all host CPU supported vector - lengths with the `host` CPU type:: + lengths with the ``host`` CPU type:: =20 $ qemu-system-aarch64 -M virt,accel=3Dkvm -cpu host =20 --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309623194272.015337842388; Mon, 26 Jul 2021 07:27:03 -0700 (PDT) Received: from localhost ([::1]:57606 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81ZN-0005Ka-Ve for importer@patchew.org; Mon, 26 Jul 2021 10:27:02 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42424) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WJ-0005jP-Nq for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:51 -0400 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]:39923) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WH-0008TI-FR for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:51 -0400 Received: by mail-wm1-x32c.google.com with SMTP id f14-20020a05600c154eb02902519e4abe10so2137833wmg.4 for ; Mon, 26 Jul 2021 07:23:49 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:47 -0700 (PDT) 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=7gwq6Br5Y6+V67xD+873/QRYUOjzOo/xxivGb8gOrKs=; b=CdGIQYPoGPdcFAbprHTroxphegHzLkyF1oD1rZ+H3Sn8WDloEtrU44gTt7pC0oEgoX Pg/xcloeDBdyq3ap3go6yraRgwpU8RAfoDNG2Xs2dwMjkMzSn6du2DjvLCIeccTs7Ogv aHuP+xkdjM70RKQBGMBApo8shfd1dihIJ2coxTWlfYkRsO6yVaenGa4kgoMCIbJkF1HR PDOZyYKv3DxxDNXhZhPMg8VJaoImlMzTH7caKDDA3zFMpchC5r/Ygk1aV++l/amHifgM jTOzSMRyEcneklQgaTnQ5U83sj7NPpjqxvIiuuNqn7vS6DJmX/p6oieS8OnNT+VOLxWw qszQ== 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=7gwq6Br5Y6+V67xD+873/QRYUOjzOo/xxivGb8gOrKs=; b=fxxyWcWdBwwmF/1La002OxYtN05g+rlPhS8F69FOLTtQEcnS+XLRgKsScBSm6cqVGh KLK/4CZaHoSXxXb1EweXtZmk4mZgSgBnCDf6glZFiBJPH6w3AlAu0Q/r30rGtaycGUnW 2sjGNajXCnwulrOLPRgqM5KVj9Luui6gHAmEoGWHXOqeISc/EzR/Bzm8FsMgVjHD67jy f1Ud7VYqFwmcQ0RvXj5cMp7Y5ZEEp1vizYLRt5RkgaqfJNdEaQfBUEPo+k1Gb3ApYszv 7GHxvYPv7Y+dt6h4kDKHhyUX8hV7d6eUQQ6vmjajuQWqoWE7N6AtWwlfQHBSrkETwW7U VbkQ== X-Gm-Message-State: AOAM530AnrRWkM7SQKfF2mQIX9r8UEn9qdUYobm+96nwtibe8RK5Qmk5 bDUVlXODsEr2czQCB0I12BgDjGZ5Y84mlg== X-Google-Smtp-Source: ABdhPJxGUvGD4XioLWlwvfgr7hn0dFsl3UF/M6aPBR/va0tZkfAhbU2nQpvepTcVtGhpgoKjD7f9ag== X-Received: by 2002:a05:600c:4788:: with SMTP id k8mr16328909wmo.75.1627309427876; Mon, 26 Jul 2021 07:23:47 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 08/10] docs: Format literals correctly Date: Mon, 26 Jul 2021 15:23:36 +0100 Message-Id: <20210726142338.31872-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::32c; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32c.google.com X-Spam_score_int: 0 X-Spam_score: -0.1 X-Spam_bar: / X-Spam_report: (-0.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, PDS_OTHER_BAD_TLD=1.999, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309624301100001 Content-Type: text/plain; charset="utf-8" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpre= ted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). This commit fixes various places in the manual which were using single backticks when double backticks (for literal text) were intended, and covers those files where only one or two instances of these errors were made. Reviewed-by: Richard Henderson --- docs/about/index.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/arm/nuvoton.rst | 2 +- docs/system/arm/sbsa.rst | 4 ++-- docs/system/arm/virt.rst | 2 +- docs/system/cpu-hotplug.rst | 2 +- docs/system/guest-loader.rst | 6 +++--- docs/system/ppc/powernv.rst | 8 ++++---- docs/system/riscv/microchip-icicle-kit.rst | 2 +- docs/system/riscv/virt.rst | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/about/index.rst b/docs/about/index.rst index 689a9861dc3..beb762aa0a9 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -15,7 +15,7 @@ where QEMU can launch processes compiled for one CPU on a= nother CPU. In this mode the CPU is always emulated. =20 QEMU also provides a number of standalone commandline utilities, -such as the `qemu-img` disk image utility that allows you to create, +such as the ``qemu-img`` disk image utility that allows you to create, convert and modify disk images. =20 .. toctree:: diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-blo= ck-operations.rst index 477d085f54e..9e3635b2338 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -781,7 +781,7 @@ the content of image [D]. } =20 (6) [On *destination* QEMU] Finally, resume the guest vCPUs by issuing the - QMP command `cont`:: + QMP command ``cont``:: =20 (QEMU) cont { diff --git a/docs/system/arm/nuvoton.rst b/docs/system/arm/nuvoton.rst index 3cd2b2b18d8..69f57c2886f 100644 --- a/docs/system/arm/nuvoton.rst +++ b/docs/system/arm/nuvoton.rst @@ -79,7 +79,7 @@ Boot options ------------ =20 The Nuvoton machines can boot from an OpenBMC firmware image, or directly = into -a kernel using the ``-kernel`` option. OpenBMC images for `quanta-gsj` and +a kernel using the ``-kernel`` option. OpenBMC images for ``quanta-gsj`` a= nd possibly others can be downloaded from the OpenPOWER jenkins : =20 https://openpower.xyz/ diff --git a/docs/system/arm/sbsa.rst b/docs/system/arm/sbsa.rst index 27b0999aaca..b499d7e9272 100644 --- a/docs/system/arm/sbsa.rst +++ b/docs/system/arm/sbsa.rst @@ -1,8 +1,8 @@ Arm Server Base System Architecture Reference board (``sbsa-ref``) =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=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 =20 -While the `virt` board is a generic board platform that doesn't match -any real hardware the `sbsa-ref` board intends to look like real +While the ``virt`` board is a generic board platform that doesn't match +any real hardware the ``sbsa-ref`` board intends to look like real hardware. The `Server Base System Architecture `_ defines a minimum base line of hardware support and importantly how the firmware diff --git a/docs/system/arm/virt.rst b/docs/system/arm/virt.rst index 27652adfae1..59acf0eeafa 100644 --- a/docs/system/arm/virt.rst +++ b/docs/system/arm/virt.rst @@ -1,7 +1,7 @@ 'virt' generic virtual platform (``virt``) =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=3D=3D=3D=3D=3D=3D=3D =20 -The `virt` board is a platform which does not correspond to any +The ``virt`` board is a platform which does not correspond to any real hardware; it is designed for use in virtual machines. It is the recommended board type if you simply want to run a guest such as Linux and do not care about reproducing the diff --git a/docs/system/cpu-hotplug.rst b/docs/system/cpu-hotplug.rst index bd0663616e8..015ce2b6ec3 100644 --- a/docs/system/cpu-hotplug.rst +++ b/docs/system/cpu-hotplug.rst @@ -78,7 +78,7 @@ vCPU hotplug } (QEMU) =20 -(5) Optionally, run QMP `query-cpus-fast` for some details about the +(5) Optionally, run QMP ``query-cpus-fast`` for some details about the vCPUs:: =20 (QEMU) query-cpus-fast diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 37d03cbd892..4320d1183f7 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -4,7 +4,7 @@ Guest Loader ------------ =20 -The guest loader is similar to the `generic-loader` although it is +The guest loader is similar to the ``generic-loader`` although it is aimed at a particular use case of loading hypervisor guests. This is useful for debugging hypervisors without having to jump through the hoops of firmware and boot-loaders. @@ -27,12 +27,12 @@ multi-boot capability. A typical example would look lik= e: In the above example the Xen hypervisor is loaded by the -kernel parameter and passed it's boot arguments via -append. The Dom0 guest is loaded into the areas of memory. Each blob will get -`/chosen/module@` entry in the FDT to indicate it's location and +``/chosen/module@`` entry in the FDT to indicate it's location and size. Additional information can be passed with by using additional arguments. =20 Currently the only supported machines which use FDT data to boot are -the ARM and RiscV `virt` machines. +the ARM and RiscV ``virt`` machines. =20 Arguments ^^^^^^^^^ diff --git a/docs/system/ppc/powernv.rst b/docs/system/ppc/powernv.rst index 43c58bc32e7..4c4cdea527e 100644 --- a/docs/system/ppc/powernv.rst +++ b/docs/system/ppc/powernv.rst @@ -48,15 +48,15 @@ Firmware -------- =20 The OPAL firmware (OpenPower Abstraction Layer) for OpenPower systems -includes the runtime services `skiboot` and the bootloader kernel and -initramfs `skiroot`. Source code can be found on GitHub: +includes the runtime services ``skiboot`` and the bootloader kernel and +initramfs ``skiroot``. Source code can be found on GitHub: =20 https://github.com/open-power. =20 -Prebuilt images of `skiboot` and `skiboot` are made available on the `Open= POWER `__ site= . To boot a POWER9 machine, use the `witherspoon `__ images. For POWER8, use +Prebuilt images of ``skiboot`` and ``skiboot`` are made available on the `= OpenPOWER `__ = site. To boot a POWER9 machine, use the `witherspoon `__ images. For POWER8, use the `palmetto `__ images. =20 -QEMU includes a prebuilt image of `skiboot` which is updated when a +QEMU includes a prebuilt image of ``skiboot`` which is updated when a more recent version is required by the models. =20 Boot options diff --git a/docs/system/riscv/microchip-icicle-kit.rst b/docs/system/riscv= /microchip-icicle-kit.rst index 817d2aec9cd..40798b1aae5 100644 --- a/docs/system/riscv/microchip-icicle-kit.rst +++ b/docs/system/riscv/microchip-icicle-kit.rst @@ -95,7 +95,7 @@ Then we can boot the machine by: -serial chardev:serial1 =20 With above command line, current terminal session will be used for the fir= st -serial port. Open another terminal window, and use `minicom` to connect the +serial port. Open another terminal window, and use ``minicom`` to connect = the second serial port. =20 .. code-block:: bash diff --git a/docs/system/riscv/virt.rst b/docs/system/riscv/virt.rst index 3709f057972..321d77e07d4 100644 --- a/docs/system/riscv/virt.rst +++ b/docs/system/riscv/virt.rst @@ -1,7 +1,7 @@ 'virt' Generic Virtual Platform (``virt``) =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=3D=3D=3D=3D=3D=3D=3D =20 -The `virt` board is a platform which does not correspond to any real hardw= are; +The ``virt`` board is a platform which does not correspond to any real har= dware; it is designed for use in virtual machines. It is the recommended board ty= pe if you simply want to run a guest such as Linux and do not care about reproducing the idiosyncrasies and limitations of a particular bit of --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309744069772.6471339983801; Mon, 26 Jul 2021 07:29:04 -0700 (PDT) Received: from localhost ([::1]:35052 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81bL-0000l5-0Y for importer@patchew.org; Mon, 26 Jul 2021 10:29:03 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42426) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WJ-0005jV-OY for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:51 -0400 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:33382) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WI-0008TX-37 for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:51 -0400 Received: by mail-wr1-x435.google.com with SMTP id q3so11389729wrx.0 for ; Mon, 26 Jul 2021 07:23:49 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:48 -0700 (PDT) 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=1SF2wV60jHXpA3/icP5948eF0SHHMvzDyypIB3tlxP8=; b=dbHTRdhfOgl6Vgp0Zt7GiL44umoKZVLFrc4odmfVULSChFxBeg35TxdtuAx63qP0ei VCXvMw9k56TSY4oGDXU+2D3WjU4Yksof7512PYFzORhE0oVTrFZKNHSwgWvy21e/uJSi WJKpUWGYfcKGfc/GP6qEVGfkYIwA0y2GksIR1Uq94wwRtgGSelcEG6jhELqXqBpdlwEj 1dNeJ+8Bm8CVhjABS8xlutZi4SVWFZyNqBpSF6fkFznjdVRkQsfTuH7fraReGyPHul+P 9KYVdjvIdSHinBffHwnZ4AHj5xrIDBHZTEosPzHGvRUkUF8pOchXjORbPjgtG/HHQTAi D9ig== 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=1SF2wV60jHXpA3/icP5948eF0SHHMvzDyypIB3tlxP8=; b=EsVNCaCQuXYdJzad6WGbYfJkvmlItlja87Yw1Rss5Dw31OY+A4eR8EgzUw43g67EPC ZvCbpmQSsE+JausFo9jl6+iplhCdNQdg0kRrOR4Xx6+q4q71j4zkGUwfhX1I8eXBRGnu OxZG3mTTb5ZiP6CyM+8SkmwlQAGlNnWVtttUVAeVk1F5gbzQh4ZgDMl8583KchcSOaSY foW6VolP5LwxIZksA3p9WVrYB7XLShi6xywcwhV16+gab54R5RQHAysXwubLopvjTYIK k5qokQ7XB9+rYDxDmQUwswgx4AM7J4PDr/U7+DUYTDrwmG2k5uc53GzmCPpal96Q2TRE IWFg== X-Gm-Message-State: AOAM533F1fEi+9A/4uPZEqMLjzGgiVj3YpPD0OYU4J8vWLB6Lb8cVJ6Z KrzhxySxTZ1moIGe6MTLDMPkgpHxaqBerQ== X-Google-Smtp-Source: ABdhPJyVw2FNMuMyo9z9mKboe0pdB+lK1vxXqHOa/kQ18rPdlPDSCcXhwpgLvWJqXGG2jbD+1FBZVQ== X-Received: by 2002:a05:6000:1841:: with SMTP id c1mr19037308wri.423.1627309428721; Mon, 26 Jul 2021 07:23:48 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error Date: Mon, 26 Jul 2021 15:23:37 +0100 Message-Id: <20210726142338.31872-10-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::435; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x435.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309745251100001 Content-Type: text/plain; charset="utf-8" The section describing the removed feature "-usbdevice ccid" had a typo so the markup started with single backtick and ended with double backtick; fix it. Signed-off-by: Peter Maydell Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Richard Henderson --- docs/about/removed-features.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.= rst index 28bb035043d..07d597847c9 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -124,7 +124,7 @@ devices. Drives the board doesn't pick up can no longe= r be used with ''''''''''''''''''''''''''''''''''''' =20 This option was undocumented and not used in the field. -Use `-device usb-ccid`` instead. +Use ``-device usb-ccid`` instead. =20 RISC-V firmware not booted by default (removed in 5.1) '''''''''''''''''''''''''''''''''''''''''''''''''''''' --=20 2.20.1 From nobody Mon Feb 9 11:17:36 2026 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=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1627309892706319.9452094166053; Mon, 26 Jul 2021 07:31:32 -0700 (PDT) Received: from localhost ([::1]:42368 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m81dj-0005ir-NQ for importer@patchew.org; Mon, 26 Jul 2021 10:31:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42436) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m81WK-0005p3-WC for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:53 -0400 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:46610) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m81WI-0008UH-PR for qemu-devel@nongnu.org; Mon, 26 Jul 2021 10:23:52 -0400 Received: by mail-wr1-x42f.google.com with SMTP id c16so1465753wrp.13 for ; Mon, 26 Jul 2021 07:23:50 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 6sm13823427wmi.3.2021.07.26.07.23.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jul 2021 07:23:49 -0700 (PDT) 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=JXrACPGjJOl3ZLJ79V5z4zW3o5n82UJCSBx/ivJqqSs=; b=ZR5K3lRPENDy/hWL++45V1vyRgdWrQdWgY0/u2u94TmcaSBP66JcZIicFyND5I5Ih7 UJX9MVuvQa4wFBsWkUWRV8xqxE7WPSVrT5cVpaKKl7rrNNekYBFgZUIqA1JwWaO6+Cun rlRR+ifTqA6X2OWQUoY73VoKVUk7LxSfjfLLnL04D2Ok1daJjaBKzM5dVaO1+3CjEco4 bMNmdBcHEy/i+BiGJ0ftlbWMOZPN6CINnX9iQgdyVGwrELMkYBMMl9li87aR/qrkfGP2 gFXOwIlt329hnGiqKqJhTn+BGiHp8QtV8fZ66+Lgvbw3TXuc7DTwgzut4p+vdR9cykfB hvuw== 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=JXrACPGjJOl3ZLJ79V5z4zW3o5n82UJCSBx/ivJqqSs=; b=Qhuc0Bf456snE8vOqiPvJWFJRio6QRPLnc3v+cwD0uRx6J+lWnuhBXV6trUw+jdkSV 9xsacGBUsDmGg3YrCaJyoqSFDKcYwKnwykID/h/6kSwu0oSIXn94UnC1cM5Lp6VpwEHw 5fuyQCR/hTDAA0uwi0bGVP0SUj23NQcKbGlFtA9GZLS4Nc8Qxrd4JYzVp7VGGkOJyJXh upBCxUjP1VIcyXjIE/mnca3Oy+X6FAr+bI8H9xwcKn0GF1DNvDPsZewLvBcd6410phYn qa1aP6tJ3F6dfa9R/EjcQIpG6gZErU9W0eKRBOXwhL5pvRLo1JcEpXhr4KxUT2JFT9mY 3oGw== X-Gm-Message-State: AOAM532Ww//1oU/0gw6QuaY1XfaXmsYHQYq+vaKr5rggWdJ+i4I55kZL G+e0MXwdzIBN0yZMSsbPIRUC8u8V+R7qKw== X-Google-Smtp-Source: ABdhPJwXpjvE1oH52Gbqbqqarf5UjYU5hhfLcmpJ4KfwDF/t+LFy+7InLEHRqY8Vyzbl6CiSVXwslg== X-Received: by 2002:adf:ffca:: with SMTP id x10mr102553wrs.221.1627309429569; Mon, 26 Jul 2021 07:23:49 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick Date: Mon, 26 Jul 2021 15:23:38 +0100 Message-Id: <20210726142338.31872-11-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210726142338.31872-1-peter.maydell@linaro.org> References: <20210726142338.31872-1-peter.maydell@linaro.org> MIME-Version: 1.0 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=2a00:1450:4864:20::42f; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42f.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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: Juan Quintela , Cornelia Huck , "Dr. David Alan Gilbert" , Stefan Hajnoczi , Paolo Bonzini , =?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: 1627309893994100001 Content-Type: text/plain; charset="utf-8" The documentation of the posix_acl option has a stray backtick at the end of the text (which is rendered literally into the HTML). Delete it. Signed-off-by: Peter Maydell Acked-by: Dr. David Alan Gilbert Reviewed-by: Richard Henderson --- docs/tools/virtiofsd.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst index c4ac7fdf38f..b208f2a6f05 100644 --- a/docs/tools/virtiofsd.rst +++ b/docs/tools/virtiofsd.rst @@ -102,7 +102,7 @@ Options default is ``no_xattr``. =20 * posix_acl|no_posix_acl - - Enable/disable posix acl support. Posix ACLs are disabled by default`. + Enable/disable posix acl support. Posix ACLs are disabled by default. =20 .. option:: --socket-path=3DPATH =20 --=20 2.20.1