* [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code Peter Maydell
` (9 subsequent siblings)
10 siblings, 0 replies; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
---
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.
- 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.
- Add information to the help output message to report on the new
feature flag.
- Add code to perform the actual feature check.
- - Add code to include the feature status in `config-host.h`
+ - Add code to include the feature status in ``config-host.h``
- Add code to print out the feature status in the configure summary
upon completion.
@@ -116,51 +116,51 @@ Helper functions
The configure script provides a variety of helper functions to assist
developers in checking for system features:
-`do_cc $ARGS...`
+``do_cc $ARGS...``
Attempt to run the system C compiler passing it $ARGS...
-`do_cxx $ARGS...`
+``do_cxx $ARGS...``
Attempt to run the system C++ compiler passing it $ARGS...
-`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()``.
-`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()``.
-`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()``.
-`check_define $NAME`
+``check_define $NAME``
Determine if the macro $NAME is defined by the system C compiler
-`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()``.
-`write_c_skeleton`
+``write_c_skeleton``
Write a minimal C program main() function to the temporary file
indicated by $TMPC
-`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.
-`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
-`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
@@ -187,7 +187,7 @@ process for:
4) other data files, such as icons or desktop files
-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:
Subsystem sourcesets:
Various subsystems that are common to both tools and emulators have
- their own sourceset, for example `block_ss` for the block device subsystem,
- `chardev_ss` for the character device subsystem, etc. These sourcesets
+ their own sourceset, for example ``block_ss`` for the block device subsystem,
+ ``chardev_ss`` for the character device subsystem, etc. These sourcesets
are then turned into static libraries as follows::
libchardev = static_library('chardev', chardev_ss.sources(),
@@ -211,8 +211,8 @@ Subsystem sourcesets:
chardev = declare_dependency(link_whole: libchardev)
- As of Meson 0.55.1, the special `.fa` suffix should be used for everything
- 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 everything
+ that is used with ``link_whole``, to ensure that the link flags are placed
correctly in the command line.
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.
- 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.
Target-independent sourcesets must exercise particular care when using
- `if_false` rules. The `if_false` rule will be used correctly when linking
+ ``if_false`` rules. The ``if_false`` rule will be used correctly when linking
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::
@@ -245,14 +245,14 @@ Target-dependent emulator sourcesets:
In the target-dependent set lives CPU emulation, some device emulation and
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.
- Each emulator also includes sources for files in the `hw/` and `target/`
+ Each emulator also includes sources for files in the ``hw/`` and ``target/``
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``.
- Each subdirectory in `hw/` adds one sourceset to the `hw_arch` dictionary,
+ Each subdirectory in ``hw/`` adds one sourceset to the ``hw_arch`` dictionary,
for example::
arm_ss = ss.source_set()
@@ -262,8 +262,8 @@ Target-dependent emulator sourcesets:
The sourceset is only used for system emulators.
- Each subdirectory in `target/` instead should add one sourceset to each
- of the `target_arch` and `target_softmmu_arch`, which are used respectively
+ Each subdirectory in ``target/`` instead should add one sourceset to each
+ of the ``target_arch`` and ``target_softmmu_arch``, which are used respectively
for all emulators and for system emulators only. For example::
arm_ss = ss.source_set()
@@ -273,11 +273,11 @@ Target-dependent emulator sourcesets:
target_softmmu_arch += {'arm': arm_softmmu_ss}
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``.
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 += { 'hw-display': hw_display_modules }
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``.
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 only
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 linked
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:
-`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 devices
that are built into each QEMU system emulation targets. They merely contain
a list of config variable definitions such as::
@@ -316,18 +316,18 @@ into each emulator:
CONFIG_XLNX_ZYNQMP_ARM=y
CONFIG_XLNX_VERSAL=y
-`*/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`
-`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.
-.. [#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.
These files rarely need changing unless you are adding a completely
@@ -339,19 +339,19 @@ Support scripts
---------------
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= option.
-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.
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::
test('QAPI schema regression tests', python,
@@ -375,10 +375,10 @@ rules and wraps them so that e.g. submodules are built before QEMU.
The resulting build system is largely non-recursive in nature, in
contrast to common practices seen with automake.
-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 also
+possible to run tests defined in meson.build with ``meson test``.
Important files for the build system
====================================
@@ -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.
-`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.
-`*/meson.build`
+``*/meson.build``
The meson.build file in the root directory is the main entry point for the
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.
-`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.
-`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.
-`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.
Built by configure:
-`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.
@@ -446,29 +446,29 @@ Built by configure:
Built by Meson:
-`${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.
-`config-host.h`, `$TARGET-NAME/config-target.h`, `$TARGET-NAME/config-devices.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.
-`build.ninja`
+``build.ninja``
The build rules.
Built by Makefile:
-`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.
-`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
-------------------
-`help`
+``help``
Print a help message for the most common build targets.
-`print-VAR`
+``print-VAR``
Print the value of the variable VAR. Useful for debugging the build
system.
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:51 ` Philippe Mathieu-Daudé
2021-07-26 14:23 ` [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly Peter Maydell
` (8 subsequent siblings)
10 siblings, 1 reply; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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 <peter.maydell@linaro.org>
---
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::
# 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'))
# 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'))
Target-dependent emulator sourcesets:
In the target-dependent set lives CPU emulation, some device emulation and
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* Re: [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code
2021-07-26 14:23 ` [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code Peter Maydell
@ 2021-07-26 14:51 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 17+ messages in thread
From: Philippe Mathieu-Daudé @ 2021-07-26 14:51 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
On 7/26/21 4:23 PM, Peter Maydell wrote:
> 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 <peter.maydell@linaro.org>
> ---
> docs/devel/build-system.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 01/10] docs/devel/build-system.rst: Format literals correctly Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 02/10] docs/devel/build-system.rst: Correct typo in example code Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 04/10] docs/devel/migration.rst: " Peter Maydell
` (7 subsequent siblings)
10 siblings, 0 replies; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
---
| 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
--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
eBPF RSS loading functionality located in ebpf/ebpf_rss.c and ebpf/ebpf_rss.h.
-The `struct EBPFRSSContext` structure that holds 4 file descriptors:
+The ``struct EBPFRSSContext`` structure that holds 4 file descriptors:
- 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 element of the 40byte key prepared for the hashing algorithm.
- map_indirections_table - 128 elements of queue indexes.
-`struct EBPFRSSConfig` fields:
+``struct EBPFRSSConfig`` fields:
-- 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 reporting.
-- hash_types - binary mask of different hash types. See `VIRTIO_NET_RSS_HASH_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_HASH_TYPE_*`` defines. If for packet hash should not be calculated - ``default_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 hashed. For some packets, the hash can't be calculated(g.e ARP).
Functions:
-- `ebpf_rss_init()` - sets ctx to NULL, which indicates that EBPFRSSContext 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 used 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_SIZE aka 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 EBPFRSSContext 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 used 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_SIZE aka 40 bytes array.
+- ``ebpf_rss_unload()`` - close all file descriptors and set ctx to NULL.
Simplified eBPF RSS workflow:
@@ -122,4 +122,4 @@ Simplified eBPF RSS workflow:
NetClientState SetSteeringEBPF()
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-For now, `set_steering_ebpf()` method supported by Linux TAP NetClientState. The method requires an eBPF program file descriptor as an argument.
+For now, ``set_steering_ebpf()`` method supported by Linux TAP NetClientState. The method requires an eBPF program file descriptor as an argument.
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* [PATCH for-6.1 04/10] docs/devel/migration.rst: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (2 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 03/10] docs/devel/ebpf_rss.rst: Format literals correctly Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:33 ` Dr. David Alan Gilbert
2021-07-26 14:23 ` [PATCH for-6.1 05/10] docs/devel: " Peter Maydell
` (6 subsequent siblings)
10 siblings, 1 reply; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
---
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
=========
-The migration stream can be analyzed thanks to `scripts/analyze-migration.py`.
+The migration stream can be analyzed thanks to ``scripts/analyze-migration.py``.
Example usage:
@@ -75,8 +75,8 @@ Common infrastructure
=====================
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/``).
Saving the state of one device
@@ -166,14 +166,14 @@ An example (from hw/input/pckbd.c)
};
We are declaring the state with name "pckbd".
-The `version_id` is 3, and the fields are 4 uint8_t in a KBDState structure.
+The ``version_id`` is 3, and the fields are 4 uint8_t in a KBDState structure.
We registered this with:
.. code:: c
vmstate_register(NULL, 0, &vmstate_kbd, s);
-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 class
init function:
.. code:: c
@@ -210,9 +210,9 @@ another to load the state back.
SaveVMHandlers *ops,
void *opaque);
-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 version_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.
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.
-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_state`` always saves
+the state as the newer version. But ``load_state`` sometimes is able to
load state from an older version.
You can see that there are several version fields:
-- `version_id`: the maximum version_id supported by VMState for that device.
-- `minimum_version_id`: the minimum version_id that VMState is able to understand
+- ``version_id``: the maximum version_id supported by VMState for that device.
+- ``minimum_version_id``: the minimum version_id that VMState is able to understand
for that device.
-- `minimum_version_id_old`: For devices that were not able to port to vmstate, we can
+- ``minimum_version_id_old``: For devices that were not able to port to vmstate, 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.
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.
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`` callback.
Examples of such memory API functions are:
- 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 type of
memory that userfault can support shared.
-The Linux kernel userfault support works on `/dev/shm` memory and on `hugetlbfs`
-(although the kernel doesn't provide an equivalent to `madvise(MADV_DONTNEED)`
+The Linux kernel userfault support works on ``/dev/shm`` memory and on ``hugetlbfs``
+(although the kernel doesn't provide an equivalent to ``madvise(MADV_DONTNEED)``
for hugetlbfs which may be a problem in some configurations).
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 changes
to support postcopy.
The client needs to open a userfaultfd and register the areas
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* Re: [PATCH for-6.1 04/10] docs/devel/migration.rst: Format literals correctly
2021-07-26 14:23 ` [PATCH for-6.1 04/10] docs/devel/migration.rst: " Peter Maydell
@ 2021-07-26 14:33 ` Dr. David Alan Gilbert
0 siblings, 0 replies; 17+ messages in thread
From: Dr. David Alan Gilbert @ 2021-07-26 14:33 UTC (permalink / raw)
To: Peter Maydell
Cc: Juan Quintela, Cornelia Huck, qemu-devel, Stefan Hajnoczi,
Paolo Bonzini, Alex Bennée
* Peter Maydell (peter.maydell@linaro.org) wrote:
> 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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
> ---
> 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
> =========
>
> -The migration stream can be analyzed thanks to `scripts/analyze-migration.py`.
> +The migration stream can be analyzed thanks to ``scripts/analyze-migration.py``.
>
> Example usage:
>
> @@ -75,8 +75,8 @@ Common infrastructure
> =====================
>
> 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/``).
>
>
> Saving the state of one device
> @@ -166,14 +166,14 @@ An example (from hw/input/pckbd.c)
> };
>
> We are declaring the state with name "pckbd".
> -The `version_id` is 3, and the fields are 4 uint8_t in a KBDState structure.
> +The ``version_id`` is 3, and the fields are 4 uint8_t in a KBDState structure.
> We registered this with:
>
> .. code:: c
>
> vmstate_register(NULL, 0, &vmstate_kbd, s);
>
> -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 class
> init function:
>
> .. code:: c
> @@ -210,9 +210,9 @@ another to load the state back.
> SaveVMHandlers *ops,
> void *opaque);
>
> -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 version_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.
>
> 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.
>
> -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_state`` always saves
> +the state as the newer version. But ``load_state`` sometimes is able to
> load state from an older version.
>
> You can see that there are several version fields:
>
> -- `version_id`: the maximum version_id supported by VMState for that device.
> -- `minimum_version_id`: the minimum version_id that VMState is able to understand
> +- ``version_id``: the maximum version_id supported by VMState for that device.
> +- ``minimum_version_id``: the minimum version_id that VMState is able to understand
> for that device.
> -- `minimum_version_id_old`: For devices that were not able to port to vmstate, we can
> +- ``minimum_version_id_old``: For devices that were not able to port to vmstate, 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.
>
> 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.
>
> 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`` callback.
> Examples of such memory API functions are:
>
> - 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 type of
> memory that userfault can support shared.
>
> -The Linux kernel userfault support works on `/dev/shm` memory and on `hugetlbfs`
> -(although the kernel doesn't provide an equivalent to `madvise(MADV_DONTNEED)`
> +The Linux kernel userfault support works on ``/dev/shm`` memory and on ``hugetlbfs``
> +(although the kernel doesn't provide an equivalent to ``madvise(MADV_DONTNEED)``
> for hugetlbfs which may be a problem in some configurations).
>
> 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 changes
> to support postcopy.
>
> The client needs to open a userfaultfd and register the areas
> --
> 2.20.1
>
--
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH for-6.1 05/10] docs/devel: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (3 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 04/10] docs/devel/migration.rst: " Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: " Peter Maydell
` (5 subsequent siblings)
10 siblings, 0 replies; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
---
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
^^^^^^
-An edge relation between two nodes (drivers or machines) `X` and `Y` can be:
+An edge relation between two nodes (drivers or machines) ``X`` and ``Y`` can be:
-- ``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
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 simply by::
QEMU_PLUGIN_EXPORT int qemu_plugin_version = QEMU_PLUGIN_VERSION;
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.
-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
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.
- tests/plugins
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.
- contrib/plugins/hotblocks.c
@@ -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.
-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.
Example::
@@ -251,7 +251,7 @@ which will lead to a sorted list after the class breakdown::
...
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.
- 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 more 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:
@@ -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=1` is exported on
+going to run unless that ``AVOCADO_ALLOW_LARGE_STORAGE=1`` is exported on
the environment.
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 also arbitrary but
usually it means a blob which either its source or build process aren't
public available.
-You should export `AVOCADO_ALLOW_UNTRUSTED_CODE=1` on the environment in
+You should export ``AVOCADO_ALLOW_UNTRUSTED_CODE=1`` on the environment in
order to allow tests which make use of those kind of assets.
AVOCADO_TIMEOUT_EXPECTED
@@ -1090,7 +1090,7 @@ property defined in the test class, for further details::
Even though the timeout can be set by the test developer, there are some tests
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` variable
+compiled with debug flags. Therefore, the ``AVOCADO_TIMEOUT_EXPECTED`` variable
has been used to determine whether those tests should run or not.
GITLAB_CI
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (4 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 05/10] docs/devel: " Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:30 ` Cornelia Huck
2021-07-26 14:23 ` [PATCH for-6.1 07/10] docs/system/arm/cpu-features.rst: " Peter Maydell
` (4 subsequent siblings)
10 siblings, 1 reply; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
---
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=1` on the host's kernel command line.
+``prot_virt=1`` on the host's kernel command line.
Running PVMs requires using the KVM hypervisor.
-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.
@@ -26,15 +26,15 @@ Running a Protected Virtual Machine
-----------------------------------
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 line::
-object s390-pv-guest,id=pv0 \
-machine confidential-guest-support=pv0
Adding these options will:
-* 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
@@ -63,5 +63,5 @@ from the disk boot. This memory layout includes the encrypted
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.
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* Re: [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: Format literals correctly
2021-07-26 14:23 ` [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: " Peter Maydell
@ 2021-07-26 14:30 ` Cornelia Huck
0 siblings, 0 replies; 17+ messages in thread
From: Cornelia Huck @ 2021-07-26 14:30 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: Paolo Bonzini, Alex Bennée, Dr. David Alan Gilbert,
Stefan Hajnoczi, Juan Quintela
On Mon, Jul 26 2021, Peter Maydell <peter.maydell@linaro.org> wrote:
> 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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
> ---
> docs/system/s390x/protvirt.rst | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
Acked-by: Cornelia Huck <cohuck@redhat.com>
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH for-6.1 07/10] docs/system/arm/cpu-features.rst: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (5 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 06/10] docs/system/s390x/protvirt.rst: " Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 08/10] docs: " Peter Maydell
` (3 subsequent siblings)
10 siblings, 0 replies; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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 <peter.maydell@linaro.org>
---
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-features.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 such 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=off` on the QEMU
-command line, i.e. `-cpu cortex-a15,pmu=off`.
+a PMU, then the ``-cpu`` parameter should contain ``pmu=off`` on the QEMU
+command line, i.e. ``-cpu cortex-a15,pmu=off``.
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.
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".
@@ -33,12 +33,12 @@ CPU Feature Probing
===================
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 comment
block in the script for usage) is used to issue the QMP commands.
-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)::
(QEMU) query-cpu-model-expansion type=full model={"name":"max"}
@@ -51,9 +51,9 @@ block in the script for usage) is used to issue the QMP commands.
"sve896": true, "sve1280": true, "sve2048": true
}}}}
-We see that the `max` CPU type has the `pmu`, `aarch64`, `sve`, and many
-`sve<N>` CPU features. We also see that all the CPU features are
-enabled, as they are all `true`. (The `sve<N>` CPU features are all
+We see that the ``max`` CPU type has the ``pmu``, ``aarch64``, ``sve``, and many
+``sve<N>`` CPU features. We also see that all the CPU features are
+enabled, as they are all ``true``. (The ``sve<N>`` 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
}}}}
-We see it worked, as `pmu` is now `false`.
+We see it worked, as ``pmu`` is now ``false``.
-(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 feature::
(QEMU) query-cpu-model-expansion type=full model={"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.
-(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::
(QEMU) query-cpu-model-expansion type=full model={"name":"max","props":{"sve":false}}
@@ -97,14 +97,14 @@ currently have.
"sve896": false, "sve1280": false, "sve2048": false
}}}}
-As expected they are now all `false`.
+As expected they are now all ``false``.
(5) Let's try probing CPU features for the Cortex-A15 CPU type::
(QEMU) query-cpu-model-expansion type=full model={"name":"cortex-a15"}
{"return": {"model": {"name": "cortex-a15", "props": {"pmu": true}}}}
-Only the `pmu` CPU feature is available.
+Only the ``pmu`` CPU feature is available.
A note about CPU feature dependencies
-------------------------------------
@@ -123,29 +123,29 @@ A note about CPU models and KVM
-------------------------------
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 can
do if we want to launch guests without all the host's CPU features enabled.
-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.
Using CPU Features
@@ -158,12 +158,12 @@ QEMU command line with that CPU type::
$ qemu-system-aarch64 -M virt -cpu max,pmu=off,sve=on,sve128=on,sve256=on
The example above disables the PMU and enables the first two SVE vector
-lengths for the `max` CPU type. Note, the `sve=on` 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=on`` 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<N>` CPU
+disabling many SVE vector lengths would be quite verbose, the ``sve<N>`` CPU
properties have special semantics (see "SVE CPU Property Parsing
Semantics").
@@ -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.
- 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``.
- 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 descriptions.
SVE CPU Properties
==================
-There are two types of SVE CPU properties: `sve` and `sve<N>`. 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<N>``. The first
+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<N>` 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<N>`` 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<N>=off`, for all `N` not wanted), we
+lines (command lines full of ``sve<N>=off``, for all ``N`` not wanted), we
provide the parsing semantics listed in "SVE CPU Property Parsing
Semantics".
SVE CPU Property Dependencies and Constraints
---------------------------------------------
- 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.
- 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.
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.
SVE CPU Property Parsing Semantics
----------------------------------
- 1) If SVE is disabled (`sve=off`), then which SVE vector lengths
+ 1) If SVE is disabled (``sve=off``), 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<N>` CPU
- properties provided by the user. If later an `sve=on` is provided,
- then the guest will get only the enabled lengths. If no `sve=on`
+ the guest. However QEMU will still track any ``sve<N>`` CPU
+ properties provided by the user. If later an ``sve=on`` is provided,
+ then the guest will get only the enabled lengths. If no ``sve=on``
is provided and there are explicitly enabled vector lengths, then
an error is generated.
- 2) If SVE is enabled (`sve=on`), but no `sve<N>` CPU properties are
+ 2) If SVE is enabled (``sve=on``), but no ``sve<N>`` 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").
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").
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").
- 7) If one or more `sve<N>` CPU properties are set `off`, but no `sve<N>`,
- CPU properties are set `on`, then the specified vector lengths are
+ 7) If one or more ``sve<N>`` CPU properties are set ``off``, but no ``sve<N>``,
+ 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").
- 8) If one or more `sve<N>` CPU properties are set to `on`, then they
+ 8) If one or more ``sve<N>`` 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.
- 9) If SVE was disabled (`sve=off`), allowing all vector lengths to be
+ 9) If SVE was disabled (``sve=off``), 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=on` is
+ "SVE CPU Property Parsing Semantics"), then if later an ``sve=on`` is
provided an error will be generated. To avoid this error, one must
enable at least one vector length prior to enabling SVE.
@@ -329,12 +329,12 @@ SVE CPU Property Examples
$ qemu-system-aarch64 -M virt -cpu max,sve=off
- 2) Implicitly enable all vector lengths for the `max` CPU type::
+ 2) Implicitly enable all vector lengths for the ``max`` CPU type::
$ qemu-system-aarch64 -M virt -cpu max
3) When KVM is enabled, implicitly enable all host CPU supported vector
- lengths with the `host` CPU type::
+ lengths with the ``host`` CPU type::
$ qemu-system-aarch64 -M virt,accel=kvm -cpu host
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* [PATCH for-6.1 08/10] docs: Format literals correctly
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (6 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 07/10] docs/system/arm/cpu-features.rst: " Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:23 ` [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error Peter Maydell
` (2 subsequent siblings)
10 siblings, 0 replies; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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#interpreted-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 <cite>...</cite> (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.
---
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 another CPU.
In this mode the CPU is always emulated.
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.
.. toctree::
diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-block-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].
}
(6) [On *destination* QEMU] Finally, resume the guest vCPUs by issuing the
- QMP command `cont`::
+ QMP command ``cont``::
(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
------------
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`` and
possibly others can be downloaded from the OpenPOWER jenkins :
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``)
==================================================================
-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
<https://developer.arm.com/documentation/den0029/latest>`_ 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``)
==========================================
-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)
-(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::
(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
------------
-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 like:
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@<addr>` entry in the FDT to indicate it's location and
+``/chosen/module@<addr>`` entry in the FDT to indicate it's location and
size. Additional information can be passed with by using additional
arguments.
Currently the only supported machines which use FDT data to boot are
-the ARM and RiscV `virt` machines.
+the ARM and RiscV ``virt`` machines.
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
--------
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:
https://github.com/open-power.
-Prebuilt images of `skiboot` and `skiboot` are made available on the `OpenPOWER <https://openpower.xyz/job/openpower/job/openpower-op-build/>`__ site. To boot a POWER9 machine, use the `witherspoon <https://openpower.xyz/job/openpower/job/openpower-op-build/label=slave,target=witherspoon/lastSuccessfulBuild/>`__ images. For POWER8, use
+Prebuilt images of ``skiboot`` and ``skiboot`` are made available on the `OpenPOWER <https://openpower.xyz/job/openpower/job/openpower-op-build/>`__ site. To boot a POWER9 machine, use the `witherspoon <https://openpower.xyz/job/openpower/job/openpower-op-build/label=slave,target=witherspoon/lastSuccessfulBuild/>`__ images. For POWER8, use
the `palmetto <https://openpower.xyz/job/openpower/job/openpower-op-build/label=slave,target=palmetto/lastSuccessfulBuild/>`__ images.
-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.
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
With above command line, current terminal session will be used for the first
-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.
.. 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``)
==========================================
-The `virt` board is a platform which does not correspond to any real hardware;
+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 idiosyncrasies and limitations of a particular bit of
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (7 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 08/10] docs: " Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:50 ` Philippe Mathieu-Daudé
2021-07-26 14:23 ` [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick Peter Maydell
2021-07-26 23:09 ` [PATCH for-6.1 00/10] docs: Format literals correctly in rST Richard Henderson
10 siblings, 1 reply; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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 <peter.maydell@linaro.org>
---
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 longer be used with
'''''''''''''''''''''''''''''''''''''
This option was undocumented and not used in the field.
-Use `-device usb-ccid`` instead.
+Use ``-device usb-ccid`` instead.
RISC-V firmware not booted by default (removed in 5.1)
''''''''''''''''''''''''''''''''''''''''''''''''''''''
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* Re: [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error
2021-07-26 14:23 ` [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error Peter Maydell
@ 2021-07-26 14:50 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 17+ messages in thread
From: Philippe Mathieu-Daudé @ 2021-07-26 14:50 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
On 7/26/21 4:23 PM, Peter Maydell wrote:
> 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 <peter.maydell@linaro.org>
> ---
> docs/about/removed-features.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (8 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 09/10] docs/about/removed-features: Fix markup error Peter Maydell
@ 2021-07-26 14:23 ` Peter Maydell
2021-07-26 14:35 ` Dr. David Alan Gilbert
2021-07-26 23:09 ` [PATCH for-6.1 00/10] docs: Format literals correctly in rST Richard Henderson
10 siblings, 1 reply; 17+ messages in thread
From: Peter Maydell @ 2021-07-26 14:23 UTC (permalink / raw)
To: qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
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 <peter.maydell@linaro.org>
---
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``.
* 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.
.. option:: --socket-path=PATH
--
2.20.1
^ permalink raw reply related [flat|nested] 17+ messages in thread* Re: [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick
2021-07-26 14:23 ` [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick Peter Maydell
@ 2021-07-26 14:35 ` Dr. David Alan Gilbert
0 siblings, 0 replies; 17+ messages in thread
From: Dr. David Alan Gilbert @ 2021-07-26 14:35 UTC (permalink / raw)
To: Peter Maydell
Cc: Juan Quintela, Cornelia Huck, qemu-devel, Stefan Hajnoczi,
Paolo Bonzini, Alex Bennée
* Peter Maydell (peter.maydell@linaro.org) wrote:
> 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 <peter.maydell@linaro.org>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
> ---
> 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``.
>
> * 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.
>
> .. option:: --socket-path=PATH
>
> --
> 2.20.1
>
--
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK
^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [PATCH for-6.1 00/10] docs: Format literals correctly in rST
2021-07-26 14:23 [PATCH for-6.1 00/10] docs: Format literals correctly in rST Peter Maydell
` (9 preceding siblings ...)
2021-07-26 14:23 ` [PATCH for-6.1 10/10] docs/tools/virtiofsd.rst: Delete stray backtick Peter Maydell
@ 2021-07-26 23:09 ` Richard Henderson
10 siblings, 0 replies; 17+ messages in thread
From: Richard Henderson @ 2021-07-26 23:09 UTC (permalink / raw)
To: Peter Maydell, qemu-devel
Cc: Juan Quintela, Cornelia Huck, Dr. David Alan Gilbert,
Stefan Hajnoczi, Paolo Bonzini, Alex Bennée
On 7/26/21 4:23 AM, Peter Maydell wrote:
> Peter Maydell (10):
> docs/devel/build-system.rst: Format literals correctly
> docs/devel/build-system.rst: Correct typo in example code
> docs/devel/ebpf_rss.rst: Format literals correctly
> docs/devel/migration.rst: Format literals correctly
> docs/devel: Format literals correctly
> docs/system/s390x/protvirt.rst: Format literals correctly
> docs/system/arm/cpu-features.rst: Format literals correctly
> docs: Format literals correctly
> docs/about/removed-features: Fix markup error
> docs/tools/virtiofsd.rst: Delete stray backtick
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
r~
^ permalink raw reply [flat|nested] 17+ messages in thread