docs: Fix some typos (found by codespell and typos)
PATCH 1/1 docs: Fix some typos (found by codespell and typos)
Signed-off-by Stefan Weil <[email protected]>
--- docs/about/deprecated.rst | 4 ++-- docs/devel/codebase.rst | 6 +++--- docs/devel/qapi-domain.rst | 4 ++-- include/exec/memory.h | 4 ++-- qapi/qdev.json | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-)
docs/about/deprecated.rst +2 -2
@@ -452,7 +452,7 @@ Backend ``memory`` (since 9.0) ``reconnect`` (since 9.2) ^^^^^^^^^^^^^^^^^^^^^^^^^ -The ``reconnect`` option only allows specifiying second granularity timeouts, +The ``reconnect`` option only allows specifying second granularity timeouts, which is not enough for all types of use cases, use ``reconnect-ms`` instead.
@@ -462,7 +462,7 @@ Net device options Stream ``reconnect`` (since 9.2) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ``reconnect`` option only allows specifiying second granularity timeouts, +The ``reconnect`` option only allows specifying second granularity timeouts, which is not enough for all types of use cases, use ``reconnect-ms`` instead. VFIO device options
docs/devel/codebase.rst +3 -3
@@ -5,7 +5,7 @@ Codebase This section presents the various parts of QEMU and how the codebase is organized. -Beyond giving succint descriptions, the goal is to offer links to various +Beyond giving succinct descriptions, the goal is to offer links to various parts of the documentation/codebase. Subsystems
@@ -67,7 +67,7 @@ yet, so sometimes the source code is all you have. * `chardev <https://gitlab.com/qemu-project/qemu/-/tree/master/chardev>`_: Various backends used by char devices. * `common-user <https://gitlab.com/qemu-project/qemu/-/tree/master/common-user>`_: - User-mode assembly code for dealing with signals occuring during syscalls. + User-mode assembly code for dealing with signals occurring during syscalls. * `configs <https://gitlab.com/qemu-project/qemu/-/tree/master/configs>`_: Makefiles defining configurations to build QEMU. * `contrib <https://gitlab.com/qemu-project/qemu/-/tree/master/contrib>`_:
@@ -102,7 +102,7 @@ yet, so sometimes the source code is all you have. * `.gitlab-ci.d <https://gitlab.com/qemu-project/qemu/-/tree/master/.gitlab-ci.d>`_: `CI <ci>` yaml and scripts. * `include <https://gitlab.com/qemu-project/qemu/-/tree/master/include>`_: - All headers associated to different subsystems in QEMU. The hierachy used + All headers associated to different subsystems in QEMU. The hierarchy used mirrors source code organization and naming. * `hw <https://gitlab.com/qemu-project/qemu/-/tree/master/hw>`_: `Devices <device-emulation>` and boards emulation. Devices are categorized by
docs/devel/qapi-domain.rst +2 -2
@@ -41,7 +41,7 @@ Schema or generating documentation from code that exists. It is merely the rST syntax used to describe things. For instance, the Sphinx Python domain adds syntax like ``:py:func:`` for describing Python functions in documentation, but it's the autodoc module that is responsible for -reading python code and generating such syntax. QAPI is analagous here: +reading Python code and generating such syntax. QAPI is analogous here: qapidoc.py is responsible for reading the QAPI Schema and generating rST syntax, and qapi_domain.py is responsible for translating that special syntax and providing APIs for Sphinx internals.
@@ -514,7 +514,7 @@ the definition's "fully qualified name", allowing two different namespaces to create an otherwise identically named definition. This directive also influences how reference resolution works for any -references that do not explicity specify a namespace, so this directive +references that do not explicitly specify a namespace, so this directive can be used to nudge references into preferring targets from within that namespace.
include/exec/memory.h +2 -2
@@ -2162,7 +2162,7 @@ void memory_region_flush_rom_device(MemoryRegion *mr, hwaddr addr, hwaddr size);* only useful on RAM regions. * * @mr: the region being updated. -* @readonly: whether rhe region is to be ROM or RAM. +* @readonly: whether the region is to be ROM or RAM. */ void memory_region_set_readonly (MemoryRegion *mr,bool readonly);
@@ -2173,7 +2173,7 @@ void memory_region_set_readonly(MemoryRegion *mr, bool readonly);* only useful on RAM regions. * * @mr: the region being updated. -* @nonvolatile: whether rhe region is to be non-volatile. +* @nonvolatile: whether the region is to be non-volatile. */ void memory_region_set_nonvolatile (MemoryRegion *mr,bool nonvolatile);
qapi/qdev.json +1 -1
@@ -173,7 +173,7 @@ # configuration changed. # # The command may be used to notify the guest about block device -# capcity change. Currently only vhost-user-blk device supports +# capacity change. Currently only vhost-user-blk device supports # this. # # @id: the device's ID or QOM path
Signature · 1 line
2.39.5
Quoted 8 lines · Stefan Weil via
Signed-off-by Stefan Weil <[email protected]>--- docs/about/deprecated.rst | 4 ++-- docs/devel/codebase.rst | 6 +++--- docs/devel/qapi-domain.rst | 4 ++-- include/exec/memory.h | 4 ++-- qapi/qdev.json | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-)
Reviewed-by Daniel P. Berrangé <[email protected]>
With regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Quoted 8 lines · Stefan Weil via
Signed-off-by Stefan Weil <[email protected]>--- docs/about/deprecated.rst | 4 ++-- docs/devel/codebase.rst | 6 +++--- docs/devel/qapi-domain.rst | 4 ++-- include/exec/memory.h | 4 ++-- qapi/qdev.json | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-)
Reviewed-by Philippe Mathieu-Daudé <[email protected]>