Re: [PATCH V3 03/10] docs/: fix some comment spelling errors

[Laurent Vivier]

Le 17/09/2020 à 09:50, zhaolichang a écrit :
> I found that there are many spelling errors in the comments of qemu,
> so I used the spellcheck tool to check the spelling errors
> and finally found some spelling errors in the docs folder.
> 
> Signed-off-by: zhaolichang <zhaolichang@huawei.com>
> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/COLO-FT.txt                 | 6 +++---
>  docs/devel/blkdebug.txt          | 2 +-
>  docs/devel/migration.rst         | 2 +-
>  docs/devel/testing.rst           | 2 +-
>  docs/devel/tracing.txt           | 2 +-
>  docs/interop/bitmaps.rst         | 2 +-
>  docs/interop/dbus.rst            | 4 ++--
>  docs/interop/nbd.txt             | 2 +-
>  docs/interop/vhost-user-gpu.rst  | 2 +-
>  docs/interop/vhost-user.rst      | 4 ++--
>  docs/rdma.txt                    | 2 +-
>  docs/specs/ppc-spapr-hotplug.txt | 4 ++--
>  docs/specs/ppc-spapr-xive.rst    | 4 ++--
>  docs/system/arm/aspeed.rst       | 2 +-
>  docs/system/deprecated.rst       | 8 ++++----
>  docs/system/target-avr.rst       | 4 ++--
>  docs/tools/virtiofsd.rst         | 2 +-
>  17 files changed, 27 insertions(+), 27 deletions(-)
> 
> diff --git a/docs/COLO-FT.txt b/docs/COLO-FT.txt
> index c8e1740935..bc5fb2a1bb 100644
> --- a/docs/COLO-FT.txt
> +++ b/docs/COLO-FT.txt
> @@ -91,7 +91,7 @@ the heartbeat stops responding, the secondary node will 
> trigger a failover
>  as soon as it determines the absence.
>  
>  COLO disk Manager:
> -When primary VM writes data into image, the colo disk manger captures this 
> data
> +When primary VM writes data into image, the colo disk manager captures this 
> data
>  and sends it to secondary VM's which makes sure the context of secondary VM's
>  image is consistent with the context of primary VM 's image.
>  For more details, please refer to docs/block-replication.txt.
> @@ -146,12 +146,12 @@ in test procedure.
>  
>  == Test procedure ==
>  Note: Here we are running both instances on the same host for testing,
> -change the IP Addresses if you want to run it on two hosts. Initally
> +change the IP Addresses if you want to run it on two hosts. Initially
>  127.0.0.1 is the Primary Host and 127.0.0.2 is the Secondary Host.
>  
>  == Startup qemu ==
>  1. Primary:
> -Note: Initally, $imagefolder/primary.qcow2 needs to be copied to all hosts.
> +Note: Initially, $imagefolder/primary.qcow2 needs to be copied to all hosts.
>  You don't need to change any IP's here, because 0.0.0.0 listens on any
>  interface. The chardev's with 127.0.0.1 IP's loopback to the local qemu
>  instance.
> diff --git a/docs/devel/blkdebug.txt b/docs/devel/blkdebug.txt
> index 43d8e8f9c6..0b0c128d35 100644
> --- a/docs/devel/blkdebug.txt
> +++ b/docs/devel/blkdebug.txt
> @@ -62,7 +62,7 @@ Rules support the following attributes:
>  
>    errno - the numeric errno value to return when a request matches this rule.
>            The errno values depend on the host since the numeric values are 
> not
> -          standarized in the POSIX specification.
> +          standardized in the POSIX specification.
>  
>    sector - (optional) a sector number that the request must overlap in order 
> to
>             match this rule
> diff --git a/docs/devel/migration.rst b/docs/devel/migration.rst
> index 2eb08624fc..49112bb27a 100644
> --- a/docs/devel/migration.rst
> +++ b/docs/devel/migration.rst
> @@ -625,7 +625,7 @@ It can be issued immediately after migration is started 
> or any
>  time later on.  Issuing it after the end of a migration is harmless.
>  
>  Blocktime is a postcopy live migration metric, intended to show how
> -long the vCPU was in state of interruptable sleep due to pagefault.
> +long the vCPU was in state of interruptible sleep due to pagefault.
>  That metric is calculated both for all vCPUs as overlapped value, and
>  separately for each vCPU. These values are calculated on destination
>  side.  To enable postcopy blocktime calculation, enter following
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index 196e3bc35e..bd64c1bdcd 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst
> @@ -471,7 +471,7 @@ the warning.
>  A few important files for suppressing warnings are:
>  
>  tests/tsan/suppressions.tsan - Has TSan warnings we wish to suppress at 
> runtime.
> -The comment on each supression will typically indicate why we are
> +The comment on each suppression will typically indicate why we are
>  suppressing it.  More information on the file format can be found here:
>  
>  https://github.com/google/sanitizers/wiki/ThreadSanitizerSuppressions
> diff --git a/docs/devel/tracing.txt b/docs/devel/tracing.txt
> index 6144d9921b..d2160655b4 100644
> --- a/docs/devel/tracing.txt
> +++ b/docs/devel/tracing.txt
> @@ -55,7 +55,7 @@ without any sub-directory path prefix. eg 
> io/channel-buffer.c would do
>    #include "trace.h"
>  
>  To access the 'io/trace.h' file. While it is possible to include a trace.h
> -file from outside a source files' own sub-directory, this is discouraged in
> +file from outside a source file's own sub-directory, this is discouraged in
>  general. It is strongly preferred that all events be declared directly in
>  the sub-directory that uses them. The only exception is where there are some
>  shared trace events defined in the top level directory trace-events file.
> diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst
> index c20bd37a79..059ad67929 100644
> --- a/docs/interop/bitmaps.rst
> +++ b/docs/interop/bitmaps.rst
> @@ -484,7 +484,7 @@ Bitmaps can generally be modified at any time, but 
> certain operations often
>  only make sense when paired directly with other commands. When a VM is 
> paused,
>  it's easy to ensure that no guest writes occur between individual QMP
>  commands. When a VM is running, this is difficult to accomplish with
> -individual QMP commands that may allow guest writes to occur inbetween each
> +individual QMP commands that may allow guest writes to occur between each
>  command.
>  
>  For example, using only individual QMP commands, we could:
> diff --git a/docs/interop/dbus.rst b/docs/interop/dbus.rst
> index 76a5bde625..be596d3f41 100644
> --- a/docs/interop/dbus.rst
> +++ b/docs/interop/dbus.rst
> @@ -57,7 +57,7 @@ Depending on the use case, you may choose different 
> scenarios:
>   - Everything the same UID
>  
>     - Convenient for developers
> -   - Improved reliability - crash of one part doens't take
> +   - Improved reliability - crash of one part doesn't take
>       out entire VM
>     - No security benefit over traditional QEMU, unless additional
>       unless additional controls such as SELinux or AppArmor are
> @@ -87,7 +87,7 @@ For example, to allow only ``qemu`` user to talk to 
> ``qemu-helper``
>    </policy>
>  
>  
> -dbus-daemon can also perfom SELinux checks based on the security
> +dbus-daemon can also perform SELinux checks based on the security
>  context of the source and the target. For example, ``virtiofs_t``
>  could be allowed to send a message to ``svirt_t``, but ``virtiofs_t``
>  wouldn't be allowed to send a message to ``virtiofs_t``.
> diff --git a/docs/interop/nbd.txt b/docs/interop/nbd.txt
> index 4511880961..f3b3cacc96 100644
> --- a/docs/interop/nbd.txt
> +++ b/docs/interop/nbd.txt
> @@ -53,5 +53,5 @@ the operation of that feature.
>  * 2.12: NBD_CMD_BLOCK_STATUS for "base:allocation"
>  * 3.0: NBD_OPT_STARTTLS with TLS Pre-Shared Keys (PSK),
>  NBD_CMD_BLOCK_STATUS for "qemu:dirty-bitmap:", NBD_CMD_CACHE
> -* 4.2: NBD_FLAG_CAN_MULTI_CONN for sharable read-only exports,
> +* 4.2: NBD_FLAG_CAN_MULTI_CONN for shareable read-only exports,
>  NBD_CMD_FLAG_FAST_ZERO
> diff --git a/docs/interop/vhost-user-gpu.rst b/docs/interop/vhost-user-gpu.rst
> index 688f8b4259..3268bf405c 100644
> --- a/docs/interop/vhost-user-gpu.rst
> +++ b/docs/interop/vhost-user-gpu.rst
> @@ -66,7 +66,7 @@ VhostUserGpuCursorPos
>  
>  :scanout-id: ``u32``, the scanout where the cursor is located
>  
> -:x/y: ``u32``, the cursor postion
> +:x/y: ``u32``, the cursor position
>  
>  VhostUserGpuCursorUpdate
>  ^^^^^^^^^^^^^^^^^^^^^^^^
> diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
> index 10e3e3475e..988f154144 100644
> --- a/docs/interop/vhost-user.rst
> +++ b/docs/interop/vhost-user.rst
> @@ -464,7 +464,7 @@ the ``VHOST_USER_SET_MEM_TABLE`` request. For 
> invalidation events, the
>  (3), the I/O virtual address and the size. On success, the slave is
>  expected to reply with a zero payload, non-zero otherwise.
>  
> -The slave relies on the slave communcation channel (see :ref:`Slave
> +The slave relies on the slave communication channel (see :ref:`Slave
>  communication <slave_communication>` section below) to send IOTLB miss
>  and access failure events, by sending ``VHOST_USER_SLAVE_IOTLB_MSG``
>  requests to the master with a ``struct vhost_iotlb_msg`` as
> @@ -1450,7 +1450,7 @@ vhost-user backends can provide various devices & 
> services and may
>  need to be configured manually depending on the use case. However, it
>  is a good idea to follow the conventions listed here when
>  possible. Users, QEMU or libvirt, can then rely on some common
> -behaviour to avoid heterogenous configuration and management of the
> +behaviour to avoid heterogeneous configuration and management of the
>  backend programs and facilitate interoperability.
>  
>  Each backend installed on a host system should come with at least one
> diff --git a/docs/rdma.txt b/docs/rdma.txt
> index a86e992c84..49dc9f8bca 100644
> --- a/docs/rdma.txt
> +++ b/docs/rdma.txt
> @@ -261,7 +261,7 @@ qemu_rdma_exchange_send(header, data, optional response 
> header & data):
>     of the connection (described below).
>  
>  All of the remaining command types (not including 'ready')
> -described above all use the aformentioned two functions to do the hard work:
> +described above all use the aforementioned two functions to do the hard work:
>  
>  1. After connection setup, RAMBlock information is exchanged using
>     this protocol before the actual migration begins. This information 
> includes
> diff --git a/docs/specs/ppc-spapr-hotplug.txt 
> b/docs/specs/ppc-spapr-hotplug.txt
> index 859d52cce6..d4fb2d46d9 100644
> --- a/docs/specs/ppc-spapr-hotplug.txt
> +++ b/docs/specs/ppc-spapr-hotplug.txt
> @@ -371,7 +371,7 @@ ibm,dynamic-memory
>  
>  This property describes the dynamically reconfigurable memory. It is a
>  property encoded array that has an integer N, the number of LMBs followed
> -by N LMB list entires.
> +by N LMB list entries.
>  
>  Each LMB list entry consists of the following elements:
>  
> @@ -390,7 +390,7 @@ Each LMB list entry consists of the following elements:
>  ibm,dynamic-memory-v2
>  
>  This property describes the dynamically reconfigurable memory. This is
> -an alternate and newer way to describe dyanamically reconfigurable memory.
> +an alternate and newer way to describe dynamically reconfigurable memory.
>  It is a property encoded array that has an integer N (the number of
>  LMB set entries) followed by N LMB set entries. There is an LMB set entry
>  for each sequential group of LMBs that share common attributes.
> diff --git a/docs/specs/ppc-spapr-xive.rst b/docs/specs/ppc-spapr-xive.rst
> index 7144347560..f47f739e01 100644
> --- a/docs/specs/ppc-spapr-xive.rst
> +++ b/docs/specs/ppc-spapr-xive.rst
> @@ -46,7 +46,7 @@ default mode. ``dual`` means that both modes XICS **and** 
> XIVE are
>  supported and if the guest OS supports XIVE, this mode will be
>  selected.
>  
> -The choosen interrupt mode is activated after a reconfiguration done
> +The chosen interrupt mode is activated after a reconfiguration done
>  in a machine reset.
>  
>  KVM negotiation
> @@ -158,7 +158,7 @@ XIVE Device tree properties
>  ---------------------------
>  
>  The properties for the PAPR interrupt controller node when the *XIVE
> -native exploitation mode* is selected shoud contain:
> +native exploitation mode* is selected should contain:
>  
>  - ``device_type``
>  
> diff --git a/docs/system/arm/aspeed.rst b/docs/system/arm/aspeed.rst
> index 45f891eb3c..fe45840fbe 100644
> --- a/docs/system/arm/aspeed.rst
> +++ b/docs/system/arm/aspeed.rst
> @@ -72,7 +72,7 @@ Boot options
>  ------------
>  
>  The Aspeed machines can be started using the -kernel option to load a
> -Linux kernel or from a firmare image which can be downloaded from the
> +Linux kernel or from a firmware image which can be downloaded from the
>  OpenPOWER jenkins :
>  
>     https://openpower.xyz/
> diff --git a/docs/system/deprecated.rst b/docs/system/deprecated.rst
> index 0cb8b01424..808c334fe7 100644
> --- a/docs/system/deprecated.rst
> +++ b/docs/system/deprecated.rst
> @@ -79,7 +79,7 @@ Creating sound card devices and vnc without ``audiodev=`` 
> property (since 4.2)
>  
>  When not using the deprecated legacy audio config, each sound card
>  should specify an ``audiodev=`` property.  Additionally, when using
> -vnc, you should specify an ``audiodev=`` propery if you plan to
> +vnc, you should specify an ``audiodev=`` property if you plan to
>  transmit audio through the VNC protocol.
>  
>  Creating sound card devices using ``-soundhw`` (since 5.1)
> @@ -111,7 +111,7 @@ Splitting RAM by default between NUMA nodes has the same 
> issues as ``mem``
>  parameter described above with the difference that the role of the user plays
>  QEMU using implicit generic or board specific splitting rule.
>  Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if
> -it's supported by used machine type) to define mapping explictly instead.
> +it's supported by used machine type) to define mapping explicitly instead.
>  
>  ``-mem-path`` fallback to RAM (since 4.1)
>  '''''''''''''''''''''''''''''''''''''''''
> @@ -541,10 +541,10 @@ The ``[hub_id name]`` parameter tuple of the 
> 'hostfwd_add' and
>  Guest Emulator ISAs
>  -------------------
>  
> -RISC-V ISA privledge specification version 1.09.1 (removed in 5.1)
> +RISC-V ISA privilege specification version 1.09.1 (removed in 5.1)
>  ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
>  
> -The RISC-V ISA privledge specification version 1.09.1 has been removed.
> +The RISC-V ISA privilege specification version 1.09.1 has been removed.
>  QEMU supports both the newer version 1.10.0 and the ratified version 1.11.0, 
> these
>  should be used instead of the 1.09.1 version.
>  
> diff --git a/docs/system/target-avr.rst b/docs/system/target-avr.rst
> index eb5c513cce..25ab46ef05 100644
> --- a/docs/system/target-avr.rst
> +++ b/docs/system/target-avr.rst
> @@ -10,7 +10,7 @@ xmega6 and xmega7.
>  
>  As for now it supports few Arduino boards for educational and testing 
> purposes.
>  These boards use a ATmega controller, which model is limited to USART & 
> 16-bit
> -timer devices, enought to run FreeRTOS based applications (like
> +timer devices, enough to run FreeRTOS based applications (like
>  
> https://github.com/seharris/qemu-avr-tests/blob/master/free-rtos/Demo/AVR_ATMega2560_GCC/demo.elf
>  ).
>  
> @@ -30,7 +30,7 @@ AVR cpu
>  
>     telnet localhost 5678
>  
> -- Debugging wit GDB debugger::
> +- Debugging with GDB debugger::
>  
>     qemu-system-avr -machine mega2560 -bios demo.elf -s -S
>  
> diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst
> index e33c81ed41..7fe6a87291 100644
> --- a/docs/tools/virtiofsd.rst
> +++ b/docs/tools/virtiofsd.rst
> @@ -76,7 +76,7 @@ Options
>      I/O timeout in seconds.  The default depends on cache= option.
>  
>    * writeback|no_writeback -
> -    Enable/disable writeback cache. The cache alows the FUSE client to buffer
> +    Enable/disable writeback cache. The cache allows the FUSE client to 
> buffer
>      and merge write requests.  The default is ``no_writeback``.
>  
>    * xattr|no_xattr -
> 

Applied to my trivial-patches branch.

Thanks,
Laurent