diff mbox series

[17/24] xen: spelling fixes

Message ID 20230823065335.1919380-16-mjt@tls.msk.ru
State New
Headers show
Series tree-wide spelling fixes | expand

Commit Message

Michael Tokarev Aug. 23, 2023, 6:53 a.m. UTC
Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
---
 hw/xen/xen_pvdev.c                             | 2 +-
 include/hw/xen/interface/arch-x86/xen-x86_64.h | 2 +-
 include/hw/xen/interface/arch-x86/xen.h        | 2 +-
 include/hw/xen/interface/event_channel.h       | 2 +-
 include/hw/xen/interface/grant_table.h         | 2 +-
 include/hw/xen/interface/hvm/hvm_op.h          | 2 +-
 include/hw/xen/interface/io/blkif.h            | 6 +++---
 include/hw/xen/interface/io/fbif.h             | 2 +-
 include/hw/xen/interface/io/kbdif.h            | 2 +-
 include/hw/xen/interface/memory.h              | 2 +-
 include/hw/xen/interface/physdev.h             | 4 ++--
 include/hw/xen/interface/xen.h                 | 4 ++--
 12 files changed, 16 insertions(+), 16 deletions(-)

Comments

David Woodhouse Aug. 23, 2023, 6:38 p.m. UTC | #1
On Wed, 2023-08-23 at 09:53 +0300, Michael Tokarev wrote:
> 
>  include/hw/xen/interface/arch-x86/xen-x86_64.h | 2 +-
>  include/hw/xen/interface/arch-x86/xen.h        | 2 +-
>  include/hw/xen/interface/event_channel.h       | 2 +-
>  include/hw/xen/interface/grant_table.h         | 2 +-
>  include/hw/xen/interface/hvm/hvm_op.h          | 2 +-
>  include/hw/xen/interface/io/blkif.h            | 6 +++---
>  include/hw/xen/interface/io/fbif.h             | 2 +-
>  include/hw/xen/interface/io/kbdif.h            | 2 +-
>  include/hw/xen/interface/memory.h              | 2 +-
>  include/hw/xen/interface/physdev.h             | 4 ++--
>  include/hw/xen/interface/xen.h                 | 4 ++--
>  12 files changed, 16 insertions(+), 16 deletions(-)

Please don't make changes to these unless you also change them in the
upstream Xen project, from which they're imported.

Thanks.

> --- a/include/hw/xen/interface/memory.h
> +++ b/include/hw/xen/interface/memory.h
> @@ -185,5 +185,5 @@ struct xen_machphys_mfn_list {
>      /*
>       * Pointer to buffer to fill with list of extent starts. If there are
> -     * any large discontiguities in the machine address space, 2MB gaps in
> +     * any large discontinuities in the machine address space, 2MB gaps in
>       * the machphys table will be represented by an MFN base of zero.
>       */

If you're already correcting that line, why not also correct MB to MiB?
Michael Tokarev Aug. 23, 2023, 7 p.m. UTC | #2
23.08.2023 21:38, David Woodhouse wrote:
> On Wed, 2023-08-23 at 09:53 +0300, Michael Tokarev wrote:
>>
>>   include/hw/xen/interface/arch-x86/xen-x86_64.h | 2 +-
>>   include/hw/xen/interface/arch-x86/xen.h        | 2 +-
>>   include/hw/xen/interface/event_channel.h       | 2 +-
>>   include/hw/xen/interface/grant_table.h         | 2 +-
>>   include/hw/xen/interface/hvm/hvm_op.h          | 2 +-
>>   include/hw/xen/interface/io/blkif.h            | 6 +++---
>>   include/hw/xen/interface/io/fbif.h             | 2 +-
>>   include/hw/xen/interface/io/kbdif.h            | 2 +-
>>   include/hw/xen/interface/memory.h              | 2 +-
>>   include/hw/xen/interface/physdev.h             | 4 ++--
>>   include/hw/xen/interface/xen.h                 | 4 ++--
>>   12 files changed, 16 insertions(+), 16 deletions(-)
> 
> Please don't make changes to these unless you also change them in the
> upstream Xen project, from which they're imported.

Aha. I didn't know they're imported from elsewhere.
Is it just include/hw/xen/interface/ or whole include/hw/xen/ ?

I guess these changes can be sent to xen project :)

> Thanks.
> 
>> --- a/include/hw/xen/interface/memory.h
>> +++ b/include/hw/xen/interface/memory.h
>> @@ -185,5 +185,5 @@ struct xen_machphys_mfn_list {
>>       /*
>>        * Pointer to buffer to fill with list of extent starts. If there are
>> -     * any large discontiguities in the machine address space, 2MB gaps in
>> +     * any large discontinuities in the machine address space, 2MB gaps in
>>        * the machphys table will be represented by an MFN base of zero.
>>        */
> 
> If you're already correcting that line, why not also correct MB to MiB?

That's not really spelling fix anymore.  Also, this is not universal, some
still prefer MB over MiB (to mean 1024 not 1000).  Else it's just too many
changes and the thing will never finish :)

Here in this patch, after removing include/hw/xen/, there's just one file
with one fix left, hw/xen/xen_pvdev.c. Hwell.. :)

/mjt
David Woodhouse Aug. 25, 2023, 8:52 a.m. UTC | #3
On Wed, 2023-08-23 at 22:00 +0300, Michael Tokarev wrote:
> 23.08.2023 21:38, David Woodhouse wrote:
> > On Wed, 2023-08-23 at 09:53 +0300, Michael Tokarev wrote:
> > > 
> > >   include/hw/xen/interface/arch-x86/xen-x86_64.h | 2 +-
> > >   include/hw/xen/interface/arch-x86/xen.h        | 2 +-
> > >   include/hw/xen/interface/event_channel.h       | 2 +-
> > >   include/hw/xen/interface/grant_table.h         | 2 +-
> > >   include/hw/xen/interface/hvm/hvm_op.h          | 2 +-
> > >   include/hw/xen/interface/io/blkif.h            | 6 +++---
> > >   include/hw/xen/interface/io/fbif.h             | 2 +-
> > >   include/hw/xen/interface/io/kbdif.h            | 2 +-
> > >   include/hw/xen/interface/memory.h              | 2 +-
> > >   include/hw/xen/interface/physdev.h             | 4 ++--
> > >   include/hw/xen/interface/xen.h                 | 4 ++--
> > >   12 files changed, 16 insertions(+), 16 deletions(-)
> > 
> > Please don't make changes to these unless you also change them in the
> > upstream Xen project, from which they're imported.
> 
> Aha. I didn't know they're imported from elsewhere.
> Is it just include/hw/xen/interface/ or whole include/hw/xen/ ?

For this particular set of imported files, I believe it's just the ones
in include/hw/xen/interface/

> I guess these changes can be sent to xen project :)

Maybe we should add it in MAINTAINERS? :)

> > > -     * any large discontiguities in the machine address space, 2MB gaps in
> > > +     * any large discontinuities in the machine address space, 2MB gaps in
> > 
> > If you're already correcting that line, why not also correct MB to MiB?
> 
> That's not really spelling fix anymore.  Also, this is not universal, some
> still prefer MB over MiB (to mean 1024 not 1000).  Else it's just too many
> changes and the thing will never finish :)

I'll buy your second reason, but not the first. I don't think there's a
good reason to be tolerant of people who "prefer" to be deliberately
wrong. MB means one thing, MiB — the IEC standard since 1998 — means
something else. To use one when you mean the other is just wrong.

Maybe in the final years of the 1900s when the IEC standard was still
new, and people found MiB unfamiliar and "ugly", it wasn't universal.
That was quarter of a century ago.

The unfamiliarity, and thus the natural human reaction to perceive
anything new as "ugly", will pass.

The correctness, and the lack of ambiguity, will not.

> Here in this patch, after removing include/hw/xen/, there's just one file
> with one fix left, hw/xen/xen_pvdev.c. Hwell.. :)

For that part,

Acked-by: David Woodhouse <dwmw@amazon.co.uk>
diff mbox series

Patch

diff --git a/hw/xen/xen_pvdev.c b/hw/xen/xen_pvdev.c
index be1504b82c..c5ad71e8dc 100644
--- a/hw/xen/xen_pvdev.c
+++ b/hw/xen/xen_pvdev.c
@@ -90,5 +90,5 @@  char *xenstore_read_str(const char *base, const char *node)
     if (str != NULL) {
         /* move to qemu-allocated memory to make sure
-         * callers can savely g_free() stuff. */
+         * callers can safely g_free() stuff. */
         ret = g_strdup(str);
         free(str);
diff --git a/include/hw/xen/interface/arch-x86/xen-x86_64.h b/include/hw/xen/interface/arch-x86/xen-x86_64.h
index 40aed14366..eae96f4f67 100644
--- a/include/hw/xen/interface/arch-x86/xen-x86_64.h
+++ b/include/hw/xen/interface/arch-x86/xen-x86_64.h
@@ -107,5 +107,5 @@ 
  *   RING2 -> RING3 kernel mode.
  *   RING3 -> RING3 user mode.
- * However RING0 indicates that the guest kernel should return to iteself
+ * However RING0 indicates that the guest kernel should return to itself
  * directly with
  *      orb   $3,1*8(%rsp)
diff --git a/include/hw/xen/interface/arch-x86/xen.h b/include/hw/xen/interface/arch-x86/xen.h
index 7acd94c8eb..efa67d1499 100644
--- a/include/hw/xen/interface/arch-x86/xen.h
+++ b/include/hw/xen/interface/arch-x86/xen.h
@@ -140,5 +140,5 @@  typedef unsigned long xen_ulong_t;
  * interrupt. On x86/64, since rings 1 and 2 are unavailable, we allocate
  * privilege levels as follows:
- *  Level == 0: Noone may enter
+ *  Level == 0: No one may enter
  *  Level == 1: Kernel may enter
  *  Level == 2: Kernel may enter
diff --git a/include/hw/xen/interface/event_channel.h b/include/hw/xen/interface/event_channel.h
index 73c9f38ce1..9073d3852f 100644
--- a/include/hw/xen/interface/event_channel.h
+++ b/include/hw/xen/interface/event_channel.h
@@ -320,5 +320,5 @@  typedef struct evtchn_set_priority evtchn_set_priority_t;
  * ` HYPERVISOR_event_channel_op_compat(struct evtchn_op *op)
  * `
- * Superceded by new event_channel_op() hypercall since 0x00030202.
+ * Superseded by new event_channel_op() hypercall since 0x00030202.
  */
 struct evtchn_op {
diff --git a/include/hw/xen/interface/grant_table.h b/include/hw/xen/interface/grant_table.h
index 7934d7b718..f8e4398ecd 100644
--- a/include/hw/xen/interface/grant_table.h
+++ b/include/hw/xen/interface/grant_table.h
@@ -625,5 +625,5 @@  DEFINE_XEN_GUEST_HANDLE(gnttab_cache_flush_t);
   * GNTMAP_contains_pte subflag:
   *  0 => This map request contains a host virtual address.
-  *  1 => This map request contains the machine addess of the PTE to update.
+  *  1 => This map request contains the machine address of the PTE to update.
   */
 #define _GNTMAP_contains_pte    (4)
diff --git a/include/hw/xen/interface/hvm/hvm_op.h b/include/hw/xen/interface/hvm/hvm_op.h
index 870ec52060..188960da7e 100644
--- a/include/hw/xen/interface/hvm/hvm_op.h
+++ b/include/hw/xen/interface/hvm/hvm_op.h
@@ -355,5 +355,5 @@  struct xen_hvm_altp2m_op {
 /* Get the active vcpu p2m index */
 #define HVMOP_altp2m_get_p2m_idx          14
-/* Set the "Supress #VE" bit for a range of pages */
+/* Set the "Suppress #VE" bit for a range of pages */
 #define HVMOP_altp2m_set_suppress_ve_multi 15
 /* Set visibility for a given altp2m view */
diff --git a/include/hw/xen/interface/io/blkif.h b/include/hw/xen/interface/io/blkif.h
index 4cdba79aba..507d5170db 100644
--- a/include/hw/xen/interface/io/blkif.h
+++ b/include/hw/xen/interface/io/blkif.h
@@ -60,5 +60,5 @@ 
  * values are encoded in decimal.  Integer value ranges listed below are
  * expressed as fixed sized integer types capable of storing the conversion
- * of a properly formated node string, without loss of information.
+ * of a properly formatted node string, without loss of information.
  *
  * Any specified default value is in effect if the corresponding XenBus node
@@ -259,5 +259,5 @@ 
  *
  *      NOTE: Because of implementation bugs in some frontends this must be
- *            set to 512, unless the frontend advertizes a non-zero value
+ *            set to 512, unless the frontend advertises a non-zero value
  *            in its "feature-large-sector-size" xenbus node. (See below).
  *
@@ -416,5 +416,5 @@ 
  * (9) Linux implementation doesn't have a limit on the maximum number of
  *     grants that can be persistently mapped in the frontend driver, but
- *     due to the frontent driver implementation it should never be bigger
+ *     due to the frontend driver implementation it should never be bigger
  *     than RING_SIZE * BLKIF_MAX_SEGMENTS_PER_REQUEST.
  *(10) The discard-secure property may be present and will be set to 1 if the
diff --git a/include/hw/xen/interface/io/fbif.h b/include/hw/xen/interface/io/fbif.h
index cc25aab32e..098561c55a 100644
--- a/include/hw/xen/interface/io/fbif.h
+++ b/include/hw/xen/interface/io/fbif.h
@@ -90,5 +90,5 @@  union xenfb_out_event
  * refresh the framebuffer (and send an update notification event if
  * those have been requested), then use the update frequency to guide
- * their periodical refreshs.
+ * their periodical refreshes.
  */
 #define XENFB_TYPE_REFRESH_PERIOD 1
diff --git a/include/hw/xen/interface/io/kbdif.h b/include/hw/xen/interface/io/kbdif.h
index a6b01c52c7..6fb73c8004 100644
--- a/include/hw/xen/interface/io/kbdif.h
+++ b/include/hw/xen/interface/io/kbdif.h
@@ -40,5 +40,5 @@ 
  * values are encoded in decimal. Integer value ranges listed below are
  * expressed as fixed sized integer types capable of storing the conversion
- * of a properly formated node string, without loss of information.
+ * of a properly formatted node string, without loss of information.
  *
  *****************************************************************************
diff --git a/include/hw/xen/interface/memory.h b/include/hw/xen/interface/memory.h
index 383a9468c3..b5edabf63c 100644
--- a/include/hw/xen/interface/memory.h
+++ b/include/hw/xen/interface/memory.h
@@ -185,5 +185,5 @@  struct xen_machphys_mfn_list {
     /*
      * Pointer to buffer to fill with list of extent starts. If there are
-     * any large discontiguities in the machine address space, 2MB gaps in
+     * any large discontinuities in the machine address space, 2MB gaps in
      * the machphys table will be represented by an MFN base of zero.
      */
diff --git a/include/hw/xen/interface/physdev.h b/include/hw/xen/interface/physdev.h
index d271766ad0..55cd5892ac 100644
--- a/include/hw/xen/interface/physdev.h
+++ b/include/hw/xen/interface/physdev.h
@@ -224,5 +224,5 @@  DEFINE_XEN_GUEST_HANDLE(physdev_manage_pci_ext_t);
 
 /*
- * Argument to physdev_op_compat() hypercall. Superceded by new physdev_op()
+ * Argument to physdev_op_compat() hypercall. Superseded by new physdev_op()
  * hypercall since 0x00030202.
  */
@@ -350,5 +350,5 @@  DEFINE_XEN_GUEST_HANDLE(physdev_dbgp_op_t);
 #if __XEN_INTERFACE_VERSION__ < 0x00040600
 /*
- * These all-capitals physdev operation names are superceded by the new names
+ * These all-capitals physdev operation names are superseded by the new names
  * (defined above) since interface version 0x00030202. The guard above was
  * added post-4.5 only though and hence shouldn't check for 0x00030202.
diff --git a/include/hw/xen/interface/xen.h b/include/hw/xen/interface/xen.h
index e373592c33..8c7914bbfb 100644
--- a/include/hw/xen/interface/xen.h
+++ b/include/hw/xen/interface/xen.h
@@ -607,5 +607,5 @@  DEFINE_XEN_GUEST_HANDLE(mmuext_op_t);
 
 /*
- * DOMID_COW is used as the owner of sharable pages */
+ * DOMID_COW is used as the owner of shareable pages */
 #define DOMID_COW            xen_mk_uint(0x7FF3)
 
@@ -751,5 +751,5 @@  struct shared_info {
      *  1. Bi-directional inter- and intra-domain connections. Domains must
      *     arrange out-of-band to set up a connection (usually by allocating
-     *     an unbound 'listener' port and avertising that via a storage service
+     *     an unbound 'listener' port and advertising that via a storage service
      *     such as xenstore).
      *  2. Physical interrupts. A domain with suitable hardware-access