[PATCH for-7.2] Fix several typos in documentation (found by codespell)

Stefan Weil via posted 1 patch 1 year, 5 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20221110190825.879620-1-sw@weilnetz.de
Maintainers: Ani Sinha <ani@anisinha.ca>, Paolo Bonzini <pbonzini@redhat.com>, Fam Zheng <fam@euphon.net>, Peter Xu <peterx@redhat.com>, David Hildenbrand <david@redhat.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, Thomas Huth <thuth@redhat.com>, Laurent Vivier <lvivier@redhat.com>
docs/devel/acpi-bits.rst       | 2 +-
docs/system/devices/can.rst    | 2 +-
hw/scsi/esp.c                  | 6 +++---
include/exec/memory.h          | 6 +++---
qapi/virtio.json               | 4 ++--
qemu-options.hx                | 6 +++---
tests/qtest/libqos/qgraph.h    | 2 +-
tests/qtest/libqos/virtio-9p.c | 2 +-
8 files changed, 15 insertions(+), 15 deletions(-)
[PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Stefan Weil via 1 year, 5 months ago
Those typos are in files which are used to generate the QEMU manual.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
---

I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.

Stefan

 docs/devel/acpi-bits.rst       | 2 +-
 docs/system/devices/can.rst    | 2 +-
 hw/scsi/esp.c                  | 6 +++---
 include/exec/memory.h          | 6 +++---
 qapi/virtio.json               | 4 ++--
 qemu-options.hx                | 6 +++---
 tests/qtest/libqos/qgraph.h    | 2 +-
 tests/qtest/libqos/virtio-9p.c | 2 +-
 8 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
index c9564d871a..5e22be8ef6 100644
--- a/docs/devel/acpi-bits.rst
+++ b/docs/devel/acpi-bits.rst
@@ -132,7 +132,7 @@ Under ``tests/avocado/`` as the root we have:
 
    (a) They are python2.7 based scripts and not python 3 scripts.
    (b) They are run from within the bios bits VM and is not subjected to QEMU
-       build/test python script maintainance and dependency resolutions.
+       build/test python script maintenance and dependency resolutions.
    (c) They need not be loaded by avocado framework when running tests.
 
 
diff --git a/docs/system/devices/can.rst b/docs/system/devices/can.rst
index fe37af8223..24b0d4cf41 100644
--- a/docs/system/devices/can.rst
+++ b/docs/system/devices/can.rst
@@ -169,7 +169,7 @@ and with bitrate switch::
 
   cangen can0 -b
 
-The test can be run viceversa, generate messages in the guest system and capture them
+The test can be run vice-versa, generate messages in the guest system and capture them
 in the host one and much more combinations.
 
 Links to other resources
diff --git a/hw/scsi/esp.c b/hw/scsi/esp.c
index e5b281e836..e52188d022 100644
--- a/hw/scsi/esp.c
+++ b/hw/scsi/esp.c
@@ -515,7 +515,7 @@ static void do_dma_pdma_cb(ESPState *s)
         } else {
             /*
              * Extra message out bytes received: update cmdfifo_cdb_offset
-             * and then switch to commmand phase
+             * and then switch to command phase
              */
             s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
             s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
@@ -627,7 +627,7 @@ static void esp_do_dma(ESPState *s)
         } else {
             /*
              * Extra message out bytes received: update cmdfifo_cdb_offset
-             * and then switch to commmand phase
+             * and then switch to command phase
              */
             s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
             s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
@@ -738,7 +738,7 @@ static void esp_do_nodma(ESPState *s)
         } else {
             /*
              * Extra message out bytes received: update cmdfifo_cdb_offset
-             * and then switch to commmand phase
+             * and then switch to command phase
              */
             s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
             s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
diff --git a/include/exec/memory.h b/include/exec/memory.h
index 80fa75baa1..91f8a2395a 100644
--- a/include/exec/memory.h
+++ b/include/exec/memory.h
@@ -561,7 +561,7 @@ typedef void (*ReplayRamDiscard)(MemoryRegionSection *section, void *opaque);
  * A #RamDiscardManager coordinates which parts of specific RAM #MemoryRegion
  * regions are currently populated to be used/accessed by the VM, notifying
  * after parts were discarded (freeing up memory) and before parts will be
- * populated (consuming memory), to be used/acessed by the VM.
+ * populated (consuming memory), to be used/accessed by the VM.
  *
  * A #RamDiscardManager can only be set for a RAM #MemoryRegion while the
  * #MemoryRegion isn't mapped yet; it cannot change while the #MemoryRegion is
@@ -585,7 +585,7 @@ typedef void (*ReplayRamDiscard)(MemoryRegionSection *section, void *opaque);
  * Listeners are called in multiples of the minimum granularity (unless it
  * would exceed the registered range) and changes are aligned to the minimum
  * granularity within the #MemoryRegion. Listeners have to prepare for memory
- * becomming discarded in a different granularity than it was populated and the
+ * becoming discarded in a different granularity than it was populated and the
  * other way around.
  */
 struct RamDiscardManagerClass {
@@ -1247,7 +1247,7 @@ void memory_region_init_ram_flags_nomigrate(MemoryRegion *mr,
                                             Error **errp);
 
 /**
- * memory_region_init_resizeable_ram:  Initialize memory region with resizeable
+ * memory_region_init_resizeable_ram:  Initialize memory region with resizable
  *                                     RAM.  Accesses into the region will
  *                                     modify memory directly.  Only an initial
  *                                     portion of this RAM is actually used.
diff --git a/qapi/virtio.json b/qapi/virtio.json
index 872c7e3623..019d2d1987 100644
--- a/qapi/virtio.json
+++ b/qapi/virtio.json
@@ -321,7 +321,7 @@
 #          },
 #          "backend-features": {
 #              "dev-features": [
-#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotation supported",
+#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotiation supported",
 #                  "VIRTIO_NET_F_GSO: Handling GSO-type packets supported",
 #                  "VIRTIO_NET_F_CTRL_MAC_ADDR: MAC address set through control channel",
 #                  "VIRTIO_NET_F_GUEST_ANNOUNCE: Driver sending gratuitous packets supported",
@@ -394,7 +394,7 @@
 #          },
 #          "host-features": {
 #              "dev-features": [
-#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotation supported",
+#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotiation supported",
 #                  "VIRTIO_NET_F_GSO: Handling GSO-type packets supported",
 #                  "VIRTIO_NET_F_CTRL_MAC_ADDR: MAC address set through control channel",
 #                  "VIRTIO_NET_F_GUEST_ANNOUNCE: Driver sending gratuitous packets supported",
diff --git a/qemu-options.hx b/qemu-options.hx
index 8b8a4a5d01..7f99d15b23 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -139,7 +139,7 @@ SRST
         interleave requirements before enabling the memory devices.
 
         ``targets.X=target`` provides the mapping to CXL host bridges
-        which may be identified by the id provied in the -device entry.
+        which may be identified by the id provided in the -device entry.
         Multiple entries are needed to specify all the targets when
         the fixed memory window represents interleaved memory. X is the
         target index from 0.
@@ -362,7 +362,7 @@ SRST
   \ 
 ``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]``
   \ 
-``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]``
+``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=type[,latency=lat][,bandwidth=bw]``
   \ 
 ``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]``
     Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA
@@ -1785,7 +1785,7 @@ SRST
     directory on host is made directly accessible by guest as a pass-through
     file system by using the 9P network protocol for communication between
     host and guests, if desired even accessible, shared by several guests
-    simultaniously.
+    simultaneously.
 
     Note that ``-virtfs`` is actually just a convenience shortcut for its
     generalized form ``-fsdev -device virtio-9p-pci``.
diff --git a/tests/qtest/libqos/qgraph.h b/tests/qtest/libqos/qgraph.h
index 5c0046e989..287022a67c 100644
--- a/tests/qtest/libqos/qgraph.h
+++ b/tests/qtest/libqos/qgraph.h
@@ -381,7 +381,7 @@ QOSGraphObject *qos_driver_new(QOSGraphNode *node, QOSGraphObject *parent,
  * mind: only tests with a path down from the actual test case node (leaf) up
  * to the graph's root node are actually executed by the qtest framework. And
  * the qtest framework uses QMP to automatically check which QEMU drivers are
- * actually currently available, and accordingly qos marks certain pathes as
+ * actually currently available, and accordingly qos marks certain paths as
  * 'unavailable' in such cases (e.g. when QEMU was compiled without support for
  * a certain feature).
  */
diff --git a/tests/qtest/libqos/virtio-9p.c b/tests/qtest/libqos/virtio-9p.c
index ae9b0a20e2..7f21028256 100644
--- a/tests/qtest/libqos/virtio-9p.c
+++ b/tests/qtest/libqos/virtio-9p.c
@@ -31,7 +31,7 @@
 static QGuestAllocator *alloc;
 static char *local_test_path;
 
-/* Concatenates the passed 2 pathes. Returned result must be freed. */
+/* Concatenates the passed 2 paths. Returned result must be freed. */
 static char *concat_path(const char* a, const char* b)
 {
     return g_build_filename(a, b, NULL);
-- 
2.30.2
Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Ani Sinha 1 year, 5 months ago
On Fri, Nov 11, 2022 at 12:38 AM Stefan Weil <sw@weilnetz.de> wrote:
>
> Those typos are in files which are used to generate the QEMU manual.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>

For acpi-bits.rst,
Reviewed-by: Ani Sinha <ani@anisinha.ca>

> ---
>
> I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.
>
> Stefan
>
>  docs/devel/acpi-bits.rst       | 2 +-
>  docs/system/devices/can.rst    | 2 +-
>  hw/scsi/esp.c                  | 6 +++---
>  include/exec/memory.h          | 6 +++---
>  qapi/virtio.json               | 4 ++--
>  qemu-options.hx                | 6 +++---
>  tests/qtest/libqos/qgraph.h    | 2 +-
>  tests/qtest/libqos/virtio-9p.c | 2 +-
>  8 files changed, 15 insertions(+), 15 deletions(-)
>
> diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
> index c9564d871a..5e22be8ef6 100644
> --- a/docs/devel/acpi-bits.rst
> +++ b/docs/devel/acpi-bits.rst
> @@ -132,7 +132,7 @@ Under ``tests/avocado/`` as the root we have:
>
>     (a) They are python2.7 based scripts and not python 3 scripts.
>     (b) They are run from within the bios bits VM and is not subjected to QEMU
> -       build/test python script maintainance and dependency resolutions.
> +       build/test python script maintenance and dependency resolutions.
>     (c) They need not be loaded by avocado framework when running tests.
>
>
> diff --git a/docs/system/devices/can.rst b/docs/system/devices/can.rst
> index fe37af8223..24b0d4cf41 100644
> --- a/docs/system/devices/can.rst
> +++ b/docs/system/devices/can.rst
> @@ -169,7 +169,7 @@ and with bitrate switch::
>
>    cangen can0 -b
>
> -The test can be run viceversa, generate messages in the guest system and capture them
> +The test can be run vice-versa, generate messages in the guest system and capture them
>  in the host one and much more combinations.
>
>  Links to other resources
> diff --git a/hw/scsi/esp.c b/hw/scsi/esp.c
> index e5b281e836..e52188d022 100644
> --- a/hw/scsi/esp.c
> +++ b/hw/scsi/esp.c
> @@ -515,7 +515,7 @@ static void do_dma_pdma_cb(ESPState *s)
>          } else {
>              /*
>               * Extra message out bytes received: update cmdfifo_cdb_offset
> -             * and then switch to commmand phase
> +             * and then switch to command phase
>               */
>              s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
>              s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
> @@ -627,7 +627,7 @@ static void esp_do_dma(ESPState *s)
>          } else {
>              /*
>               * Extra message out bytes received: update cmdfifo_cdb_offset
> -             * and then switch to commmand phase
> +             * and then switch to command phase
>               */
>              s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
>              s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
> @@ -738,7 +738,7 @@ static void esp_do_nodma(ESPState *s)
>          } else {
>              /*
>               * Extra message out bytes received: update cmdfifo_cdb_offset
> -             * and then switch to commmand phase
> +             * and then switch to command phase
>               */
>              s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
>              s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index 80fa75baa1..91f8a2395a 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -561,7 +561,7 @@ typedef void (*ReplayRamDiscard)(MemoryRegionSection *section, void *opaque);
>   * A #RamDiscardManager coordinates which parts of specific RAM #MemoryRegion
>   * regions are currently populated to be used/accessed by the VM, notifying
>   * after parts were discarded (freeing up memory) and before parts will be
> - * populated (consuming memory), to be used/acessed by the VM.
> + * populated (consuming memory), to be used/accessed by the VM.
>   *
>   * A #RamDiscardManager can only be set for a RAM #MemoryRegion while the
>   * #MemoryRegion isn't mapped yet; it cannot change while the #MemoryRegion is
> @@ -585,7 +585,7 @@ typedef void (*ReplayRamDiscard)(MemoryRegionSection *section, void *opaque);
>   * Listeners are called in multiples of the minimum granularity (unless it
>   * would exceed the registered range) and changes are aligned to the minimum
>   * granularity within the #MemoryRegion. Listeners have to prepare for memory
> - * becomming discarded in a different granularity than it was populated and the
> + * becoming discarded in a different granularity than it was populated and the
>   * other way around.
>   */
>  struct RamDiscardManagerClass {
> @@ -1247,7 +1247,7 @@ void memory_region_init_ram_flags_nomigrate(MemoryRegion *mr,
>                                              Error **errp);
>
>  /**
> - * memory_region_init_resizeable_ram:  Initialize memory region with resizeable
> + * memory_region_init_resizeable_ram:  Initialize memory region with resizable
>   *                                     RAM.  Accesses into the region will
>   *                                     modify memory directly.  Only an initial
>   *                                     portion of this RAM is actually used.
> diff --git a/qapi/virtio.json b/qapi/virtio.json
> index 872c7e3623..019d2d1987 100644
> --- a/qapi/virtio.json
> +++ b/qapi/virtio.json
> @@ -321,7 +321,7 @@
>  #          },
>  #          "backend-features": {
>  #              "dev-features": [
> -#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotation supported",
> +#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotiation supported",
>  #                  "VIRTIO_NET_F_GSO: Handling GSO-type packets supported",
>  #                  "VIRTIO_NET_F_CTRL_MAC_ADDR: MAC address set through control channel",
>  #                  "VIRTIO_NET_F_GUEST_ANNOUNCE: Driver sending gratuitous packets supported",
> @@ -394,7 +394,7 @@
>  #          },
>  #          "host-features": {
>  #              "dev-features": [
> -#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotation supported",
> +#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotiation supported",
>  #                  "VIRTIO_NET_F_GSO: Handling GSO-type packets supported",
>  #                  "VIRTIO_NET_F_CTRL_MAC_ADDR: MAC address set through control channel",
>  #                  "VIRTIO_NET_F_GUEST_ANNOUNCE: Driver sending gratuitous packets supported",
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 8b8a4a5d01..7f99d15b23 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -139,7 +139,7 @@ SRST
>          interleave requirements before enabling the memory devices.
>
>          ``targets.X=target`` provides the mapping to CXL host bridges
> -        which may be identified by the id provied in the -device entry.
> +        which may be identified by the id provided in the -device entry.
>          Multiple entries are needed to specify all the targets when
>          the fixed memory window represents interleaved memory. X is the
>          target index from 0.
> @@ -362,7 +362,7 @@ SRST
>    \
>  ``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]``
>    \
> -``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]``
> +``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=type[,latency=lat][,bandwidth=bw]``
>    \
>  ``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]``
>      Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA
> @@ -1785,7 +1785,7 @@ SRST
>      directory on host is made directly accessible by guest as a pass-through
>      file system by using the 9P network protocol for communication between
>      host and guests, if desired even accessible, shared by several guests
> -    simultaniously.
> +    simultaneously.
>
>      Note that ``-virtfs`` is actually just a convenience shortcut for its
>      generalized form ``-fsdev -device virtio-9p-pci``.
> diff --git a/tests/qtest/libqos/qgraph.h b/tests/qtest/libqos/qgraph.h
> index 5c0046e989..287022a67c 100644
> --- a/tests/qtest/libqos/qgraph.h
> +++ b/tests/qtest/libqos/qgraph.h
> @@ -381,7 +381,7 @@ QOSGraphObject *qos_driver_new(QOSGraphNode *node, QOSGraphObject *parent,
>   * mind: only tests with a path down from the actual test case node (leaf) up
>   * to the graph's root node are actually executed by the qtest framework. And
>   * the qtest framework uses QMP to automatically check which QEMU drivers are
> - * actually currently available, and accordingly qos marks certain pathes as
> + * actually currently available, and accordingly qos marks certain paths as
>   * 'unavailable' in such cases (e.g. when QEMU was compiled without support for
>   * a certain feature).
>   */
> diff --git a/tests/qtest/libqos/virtio-9p.c b/tests/qtest/libqos/virtio-9p.c
> index ae9b0a20e2..7f21028256 100644
> --- a/tests/qtest/libqos/virtio-9p.c
> +++ b/tests/qtest/libqos/virtio-9p.c
> @@ -31,7 +31,7 @@
>  static QGuestAllocator *alloc;
>  static char *local_test_path;
>
> -/* Concatenates the passed 2 pathes. Returned result must be freed. */
> +/* Concatenates the passed 2 paths. Returned result must be freed. */
>  static char *concat_path(const char* a, const char* b)
>  {
>      return g_build_filename(a, b, NULL);
> --
> 2.30.2
>
Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Ani Sinha 1 year, 5 months ago
On Fri, Nov 11, 2022 at 10:59 AM Ani Sinha <ani@anisinha.ca> wrote:
>
> On Fri, Nov 11, 2022 at 12:38 AM Stefan Weil <sw@weilnetz.de> wrote:
> >
> > Those typos are in files which are used to generate the QEMU manual.
> >
> > Signed-off-by: Stefan Weil <sw@weilnetz.de>
>
> For acpi-bits.rst,
> Reviewed-by: Ani Sinha <ani@anisinha.ca>
>
> > ---
> >
> > I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.
> >
> > Stefan
> >
> >  docs/devel/acpi-bits.rst       | 2 +-
> >  docs/system/devices/can.rst    | 2 +-
> >  hw/scsi/esp.c                  | 6 +++---
> >  include/exec/memory.h          | 6 +++---
> >  qapi/virtio.json               | 4 ++--
> >  qemu-options.hx                | 6 +++---
> >  tests/qtest/libqos/qgraph.h    | 2 +-
> >  tests/qtest/libqos/virtio-9p.c | 2 +-
> >  8 files changed, 15 insertions(+), 15 deletions(-)
> >
> > diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
> > index c9564d871a..5e22be8ef6 100644
> > --- a/docs/devel/acpi-bits.rst
> > +++ b/docs/devel/acpi-bits.rst
> > @@ -132,7 +132,7 @@ Under ``tests/avocado/`` as the root we have:
> >
> >     (a) They are python2.7 based scripts and not python 3 scripts.
> >     (b) They are run from within the bios bits VM and is not subjected to QEMU
> > -       build/test python script maintainance and dependency resolutions.
> > +       build/test python script maintenance and dependency resolutions.
> >     (c) They need not be loaded by avocado framework when running tests.

btw, if we are going to fix this doc file for typo before the release,
may I also suggest another trivial fix?

https://gitlab.com/anisinha/qemu/-/commit/4bd915a7390d799b332c11f23b6d5982efac5dac#9dedb1d2dec506845c6145696c561451a8b4b659_44_44

(removal of the reference to README from the doc).
Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Peter Maydell 1 year, 5 months ago
On Thu, 10 Nov 2022 at 19:09, Stefan Weil via <qemu-devel@nongnu.org> wrote:
>
> Those typos are in files which are used to generate the QEMU manual.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
>
> I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.

I think that's a UK vs US spellings one anyway... eg
https://dictionary.cambridge.org/dictionary/english/sizable
just says "mainly US spelling of sizeable" and cross refers to:
https://dictionary.cambridge.org/dictionary/english/sizeable

and I think resizeable/resizable is the same.

-- PMM
Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Peter Maydell 1 year, 5 months ago
On Thu, 10 Nov 2022 at 19:09, Stefan Weil via <qemu-devel@nongnu.org> wrote:
>
> Those typos are in files which are used to generate the QEMU manual.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
>
> I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.
>
> Stefan
>
>  docs/devel/acpi-bits.rst       | 2 +-
>  docs/system/devices/can.rst    | 2 +-
>  hw/scsi/esp.c                  | 6 +++---
>  include/exec/memory.h          | 6 +++---
>  qapi/virtio.json               | 4 ++--
>  qemu-options.hx                | 6 +++---
>  tests/qtest/libqos/qgraph.h    | 2 +-
>  tests/qtest/libqos/virtio-9p.c | 2 +-
>  8 files changed, 15 insertions(+), 15 deletions(-)
>
> diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
> index c9564d871a..5e22be8ef6 100644
> --- a/docs/devel/acpi-bits.rst
> +++ b/docs/devel/acpi-bits.rst
> @@ -132,7 +132,7 @@ Under ``tests/avocado/`` as the root we have:
>
>     (a) They are python2.7 based scripts and not python 3 scripts.
>     (b) They are run from within the bios bits VM and is not subjected to QEMU
> -       build/test python script maintainance and dependency resolutions.
> +       build/test python script maintenance and dependency resolutions.
>     (c) They need not be loaded by avocado framework when running tests.
>
>
> diff --git a/docs/system/devices/can.rst b/docs/system/devices/can.rst
> index fe37af8223..24b0d4cf41 100644
> --- a/docs/system/devices/can.rst
> +++ b/docs/system/devices/can.rst
> @@ -169,7 +169,7 @@ and with bitrate switch::
>
>    cangen can0 -b
>
> -The test can be run viceversa, generate messages in the guest system and capture them
> +The test can be run vice-versa, generate messages in the guest system and capture them
>  in the host one and much more combinations.

This isn't a grammatical use of vice-versa, so if we're touching it
then I think the sentence should be recast, eg:
"The test can also be run the other way around, generating
messages in the guest system and capturing them in the host system.
Other combinations are also possible."

(In fact the whole file could do with a proof-reading pass.)

Otherwise
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

thanks
-- PMM
Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Thomas Huth 1 year, 5 months ago
On 10/11/2022 21.10, Peter Maydell wrote:
> On Thu, 10 Nov 2022 at 19:09, Stefan Weil via <qemu-devel@nongnu.org> wrote:
>>
>> Those typos are in files which are used to generate the QEMU manual.
>>
>> Signed-off-by: Stefan Weil <sw@weilnetz.de>
>> ---
>>
>> I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.
>>
>> Stefan
>>
>>   docs/devel/acpi-bits.rst       | 2 +-
>>   docs/system/devices/can.rst    | 2 +-
>>   hw/scsi/esp.c                  | 6 +++---
>>   include/exec/memory.h          | 6 +++---
>>   qapi/virtio.json               | 4 ++--
>>   qemu-options.hx                | 6 +++---
>>   tests/qtest/libqos/qgraph.h    | 2 +-
>>   tests/qtest/libqos/virtio-9p.c | 2 +-
>>   8 files changed, 15 insertions(+), 15 deletions(-)
>>
>> diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
>> index c9564d871a..5e22be8ef6 100644
>> --- a/docs/devel/acpi-bits.rst
>> +++ b/docs/devel/acpi-bits.rst
>> @@ -132,7 +132,7 @@ Under ``tests/avocado/`` as the root we have:
>>
>>      (a) They are python2.7 based scripts and not python 3 scripts.
>>      (b) They are run from within the bios bits VM and is not subjected to QEMU
>> -       build/test python script maintainance and dependency resolutions.
>> +       build/test python script maintenance and dependency resolutions.
>>      (c) They need not be loaded by avocado framework when running tests.
>>
>>
>> diff --git a/docs/system/devices/can.rst b/docs/system/devices/can.rst
>> index fe37af8223..24b0d4cf41 100644
>> --- a/docs/system/devices/can.rst
>> +++ b/docs/system/devices/can.rst
>> @@ -169,7 +169,7 @@ and with bitrate switch::
>>
>>     cangen can0 -b
>>
>> -The test can be run viceversa, generate messages in the guest system and capture them
>> +The test can be run vice-versa, generate messages in the guest system and capture them
>>   in the host one and much more combinations.
> 
> This isn't a grammatical use of vice-versa, so if we're touching it
> then I think the sentence should be recast, eg:
> "The test can also be run the other way around, generating
> messages in the guest system and capturing them in the host system.
> Other combinations are also possible."

Sounds reasonable! ... I'm currently assembling a pull request for misc 
fixes - I can add the patch there and fix the sentence while picking it up.

  Thomas
Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Philippe Mathieu-Daudé 1 year, 5 months ago
On 10/11/22 20:08, Stefan Weil wrote:
> Those typos are in files which are used to generate the QEMU manual.
> 
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
> 
> I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.
> 
> Stefan
> 
>   docs/devel/acpi-bits.rst       | 2 +-
>   docs/system/devices/can.rst    | 2 +-
>   hw/scsi/esp.c                  | 6 +++---
>   include/exec/memory.h          | 6 +++---
>   qapi/virtio.json               | 4 ++--
>   qemu-options.hx                | 6 +++---
>   tests/qtest/libqos/qgraph.h    | 2 +-
>   tests/qtest/libqos/virtio-9p.c | 2 +-
>   8 files changed, 15 insertions(+), 15 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>


Re: [PATCH for-7.2] Fix several typos in documentation (found by codespell)
Posted by Michael S. Tsirkin 1 year, 5 months ago
On Thu, Nov 10, 2022 at 08:08:25PM +0100, Stefan Weil wrote:
> Those typos are in files which are used to generate the QEMU manual.
> 
> Signed-off-by: Stefan Weil <sw@weilnetz.de>

Acked-by: Michael S. Tsirkin <mst@redhat.com>


> ---
> 
> I did not fix memory_region_init_resizeable_ram. That might be done after 7.2.
> 
> Stefan
> 
>  docs/devel/acpi-bits.rst       | 2 +-
>  docs/system/devices/can.rst    | 2 +-
>  hw/scsi/esp.c                  | 6 +++---
>  include/exec/memory.h          | 6 +++---
>  qapi/virtio.json               | 4 ++--
>  qemu-options.hx                | 6 +++---
>  tests/qtest/libqos/qgraph.h    | 2 +-
>  tests/qtest/libqos/virtio-9p.c | 2 +-
>  8 files changed, 15 insertions(+), 15 deletions(-)
> 
> diff --git a/docs/devel/acpi-bits.rst b/docs/devel/acpi-bits.rst
> index c9564d871a..5e22be8ef6 100644
> --- a/docs/devel/acpi-bits.rst
> +++ b/docs/devel/acpi-bits.rst
> @@ -132,7 +132,7 @@ Under ``tests/avocado/`` as the root we have:
>  
>     (a) They are python2.7 based scripts and not python 3 scripts.
>     (b) They are run from within the bios bits VM and is not subjected to QEMU
> -       build/test python script maintainance and dependency resolutions.
> +       build/test python script maintenance and dependency resolutions.
>     (c) They need not be loaded by avocado framework when running tests.
>  
>  
> diff --git a/docs/system/devices/can.rst b/docs/system/devices/can.rst
> index fe37af8223..24b0d4cf41 100644
> --- a/docs/system/devices/can.rst
> +++ b/docs/system/devices/can.rst
> @@ -169,7 +169,7 @@ and with bitrate switch::
>  
>    cangen can0 -b
>  
> -The test can be run viceversa, generate messages in the guest system and capture them
> +The test can be run vice-versa, generate messages in the guest system and capture them
>  in the host one and much more combinations.
>  
>  Links to other resources
> diff --git a/hw/scsi/esp.c b/hw/scsi/esp.c
> index e5b281e836..e52188d022 100644
> --- a/hw/scsi/esp.c
> +++ b/hw/scsi/esp.c
> @@ -515,7 +515,7 @@ static void do_dma_pdma_cb(ESPState *s)
>          } else {
>              /*
>               * Extra message out bytes received: update cmdfifo_cdb_offset
> -             * and then switch to commmand phase
> +             * and then switch to command phase
>               */
>              s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
>              s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
> @@ -627,7 +627,7 @@ static void esp_do_dma(ESPState *s)
>          } else {
>              /*
>               * Extra message out bytes received: update cmdfifo_cdb_offset
> -             * and then switch to commmand phase
> +             * and then switch to command phase
>               */
>              s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
>              s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
> @@ -738,7 +738,7 @@ static void esp_do_nodma(ESPState *s)
>          } else {
>              /*
>               * Extra message out bytes received: update cmdfifo_cdb_offset
> -             * and then switch to commmand phase
> +             * and then switch to command phase
>               */
>              s->cmdfifo_cdb_offset = fifo8_num_used(&s->cmdfifo);
>              s->rregs[ESP_RSTAT] = STAT_TC | STAT_CD;
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index 80fa75baa1..91f8a2395a 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -561,7 +561,7 @@ typedef void (*ReplayRamDiscard)(MemoryRegionSection *section, void *opaque);
>   * A #RamDiscardManager coordinates which parts of specific RAM #MemoryRegion
>   * regions are currently populated to be used/accessed by the VM, notifying
>   * after parts were discarded (freeing up memory) and before parts will be
> - * populated (consuming memory), to be used/acessed by the VM.
> + * populated (consuming memory), to be used/accessed by the VM.
>   *
>   * A #RamDiscardManager can only be set for a RAM #MemoryRegion while the
>   * #MemoryRegion isn't mapped yet; it cannot change while the #MemoryRegion is
> @@ -585,7 +585,7 @@ typedef void (*ReplayRamDiscard)(MemoryRegionSection *section, void *opaque);
>   * Listeners are called in multiples of the minimum granularity (unless it
>   * would exceed the registered range) and changes are aligned to the minimum
>   * granularity within the #MemoryRegion. Listeners have to prepare for memory
> - * becomming discarded in a different granularity than it was populated and the
> + * becoming discarded in a different granularity than it was populated and the
>   * other way around.
>   */
>  struct RamDiscardManagerClass {
> @@ -1247,7 +1247,7 @@ void memory_region_init_ram_flags_nomigrate(MemoryRegion *mr,
>                                              Error **errp);
>  
>  /**
> - * memory_region_init_resizeable_ram:  Initialize memory region with resizeable
> + * memory_region_init_resizeable_ram:  Initialize memory region with resizable
>   *                                     RAM.  Accesses into the region will
>   *                                     modify memory directly.  Only an initial
>   *                                     portion of this RAM is actually used.
> diff --git a/qapi/virtio.json b/qapi/virtio.json
> index 872c7e3623..019d2d1987 100644
> --- a/qapi/virtio.json
> +++ b/qapi/virtio.json
> @@ -321,7 +321,7 @@
>  #          },
>  #          "backend-features": {
>  #              "dev-features": [
> -#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotation supported",
> +#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotiation supported",
>  #                  "VIRTIO_NET_F_GSO: Handling GSO-type packets supported",
>  #                  "VIRTIO_NET_F_CTRL_MAC_ADDR: MAC address set through control channel",
>  #                  "VIRTIO_NET_F_GUEST_ANNOUNCE: Driver sending gratuitous packets supported",
> @@ -394,7 +394,7 @@
>  #          },
>  #          "host-features": {
>  #              "dev-features": [
> -#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotation supported",
> +#                  "VHOST_USER_F_PROTOCOL_FEATURES: Vhost-user protocol features negotiation supported",
>  #                  "VIRTIO_NET_F_GSO: Handling GSO-type packets supported",
>  #                  "VIRTIO_NET_F_CTRL_MAC_ADDR: MAC address set through control channel",
>  #                  "VIRTIO_NET_F_GUEST_ANNOUNCE: Driver sending gratuitous packets supported",
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 8b8a4a5d01..7f99d15b23 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -139,7 +139,7 @@ SRST
>          interleave requirements before enabling the memory devices.
>  
>          ``targets.X=target`` provides the mapping to CXL host bridges
> -        which may be identified by the id provied in the -device entry.
> +        which may be identified by the id provided in the -device entry.
>          Multiple entries are needed to specify all the targets when
>          the fixed memory window represents interleaved memory. X is the
>          target index from 0.
> @@ -362,7 +362,7 @@ SRST
>    \ 
>  ``-numa cpu,node-id=node[,socket-id=x][,core-id=y][,thread-id=z]``
>    \ 
> -``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=tpye[,latency=lat][,bandwidth=bw]``
> +``-numa hmat-lb,initiator=node,target=node,hierarchy=hierarchy,data-type=type[,latency=lat][,bandwidth=bw]``
>    \ 
>  ``-numa hmat-cache,node-id=node,size=size,level=level[,associativity=str][,policy=str][,line=size]``
>      Define a NUMA node and assign RAM and VCPUs to it. Set the NUMA
> @@ -1785,7 +1785,7 @@ SRST
>      directory on host is made directly accessible by guest as a pass-through
>      file system by using the 9P network protocol for communication between
>      host and guests, if desired even accessible, shared by several guests
> -    simultaniously.
> +    simultaneously.
>  
>      Note that ``-virtfs`` is actually just a convenience shortcut for its
>      generalized form ``-fsdev -device virtio-9p-pci``.
> diff --git a/tests/qtest/libqos/qgraph.h b/tests/qtest/libqos/qgraph.h
> index 5c0046e989..287022a67c 100644
> --- a/tests/qtest/libqos/qgraph.h
> +++ b/tests/qtest/libqos/qgraph.h
> @@ -381,7 +381,7 @@ QOSGraphObject *qos_driver_new(QOSGraphNode *node, QOSGraphObject *parent,
>   * mind: only tests with a path down from the actual test case node (leaf) up
>   * to the graph's root node are actually executed by the qtest framework. And
>   * the qtest framework uses QMP to automatically check which QEMU drivers are
> - * actually currently available, and accordingly qos marks certain pathes as
> + * actually currently available, and accordingly qos marks certain paths as
>   * 'unavailable' in such cases (e.g. when QEMU was compiled without support for
>   * a certain feature).
>   */
> diff --git a/tests/qtest/libqos/virtio-9p.c b/tests/qtest/libqos/virtio-9p.c
> index ae9b0a20e2..7f21028256 100644
> --- a/tests/qtest/libqos/virtio-9p.c
> +++ b/tests/qtest/libqos/virtio-9p.c
> @@ -31,7 +31,7 @@
>  static QGuestAllocator *alloc;
>  static char *local_test_path;
>  
> -/* Concatenates the passed 2 pathes. Returned result must be freed. */
> +/* Concatenates the passed 2 paths. Returned result must be freed. */
>  static char *concat_path(const char* a, const char* b)
>  {
>      return g_build_filename(a, b, NULL);
> -- 
> 2.30.2