diff mbox series

[v1,01/21] docs: correct typos

Message ID 135bbfcb6dd09377cfd39fb73c862cd0fb66bb20.1708419115.git.manos.pitsidianakis@linaro.org (mailing list archive)
State New, archived
Headers show
Series Trivial tree wide typo fixes | expand

Commit Message

Manos Pitsidianakis Feb. 20, 2024, 8:52 a.m. UTC
Correct typos automatically found with the `typos` tool
<https://crates.io/crates/typos>

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
---
 docs/devel/ci-jobs.rst.inc      | 2 +-
 docs/devel/docs.rst             | 2 +-
 docs/devel/testing.rst          | 2 +-
 docs/interop/prl-xml.txt        | 2 +-
 docs/interop/vhost-user.rst     | 2 +-
 docs/system/devices/canokey.rst | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

Comments

Alex Bennée Feb. 20, 2024, 10:18 a.m. UTC | #1
Manos Pitsidianakis <manos.pitsidianakis@linaro.org> writes:

> Correct typos automatically found with the `typos` tool
> <https://crates.io/crates/typos>
>
> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Michael S. Tsirkin Feb. 20, 2024, 10:36 a.m. UTC | #2
On Tue, Feb 20, 2024 at 10:52:08AM +0200, Manos Pitsidianakis wrote:
> Correct typos automatically found with the `typos` tool
> <https://crates.io/crates/typos>
> 
> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

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

> ---
>  docs/devel/ci-jobs.rst.inc      | 2 +-
>  docs/devel/docs.rst             | 2 +-
>  docs/devel/testing.rst          | 2 +-
>  docs/interop/prl-xml.txt        | 2 +-
>  docs/interop/vhost-user.rst     | 2 +-
>  docs/system/devices/canokey.rst | 2 +-
>  6 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/ci-jobs.rst.inc
> index 4c39cdb2d9..6678b4f4ef 100644
> --- a/docs/devel/ci-jobs.rst.inc
> +++ b/docs/devel/ci-jobs.rst.inc
> @@ -147,7 +147,7 @@ Set this variable to 1 to create the pipelines, but leave all
>  the jobs to be manually started from the UI
>  
>  Set this variable to 2 to create the pipelines and run all
> -the jobs immediately, as was historicaly behaviour
> +the jobs immediately, as was historically behaviour

as long as we do this let's fix grammar too?

as was historically the behaviour

>  QEMU_CI_AVOCADO_TESTING
>  ~~~~~~~~~~~~~~~~~~~~~~~
> diff --git a/docs/devel/docs.rst b/docs/devel/docs.rst
> index 50ff0d67f8..a7768b5311 100644
> --- a/docs/devel/docs.rst
> +++ b/docs/devel/docs.rst
> @@ -21,7 +21,7 @@ are processed in two ways:
>  
>  The syntax of these ``.hx`` files is simple. It is broadly an
>  alternation of C code put into the C output and rST format text
> -put into the documention. A few special directives are recognised;
> +put into the documentation. A few special directives are recognised;
>  these are all-caps and must be at the beginning of the line.
>  
>  ``HXCOMM`` is the comment marker. The line, including any arbitrary
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index bd132306c1..aa96eacec5 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst
> @@ -728,7 +728,7 @@ For example to setup the HPPA ports builds of Debian::
>      EXECUTABLE=(pwd)/qemu-hppa V=1
>  
>  The ``DEB_`` variables are substitutions used by
> -``debian-boostrap.pre`` which is called to do the initial debootstrap
> +``debian-bootstrap.pre`` which is called to do the initial debootstrap
>  of the rootfs before it is copied into the container. The second stage
>  is run as part of the build. The final image will be tagged as
>  ``qemu/debian-sid-hppa``.
> diff --git a/docs/interop/prl-xml.txt b/docs/interop/prl-xml.txt
> index 7031f8752c..cf9b3fba26 100644
> --- a/docs/interop/prl-xml.txt
> +++ b/docs/interop/prl-xml.txt
> @@ -122,7 +122,7 @@ Each Image element has following child elements:
>      * Type - image type of the element. It can be:
>               "Plain" for raw files.
>               "Compressed" for expanding disks.
> -    * File - path to image file. Path can be relative to DiskDecriptor.xml or
> +    * File - path to image file. Path can be relative to DiskDescriptor.xml or
>               absolute.
>  
>  == Snapshots element ==
> diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
> index ad6e142f23..d1ed39dfa0 100644
> --- a/docs/interop/vhost-user.rst
> +++ b/docs/interop/vhost-user.rst
> @@ -989,7 +989,7 @@ When reconnecting:
>  
>     #. If ``d.flags`` is not equal to the calculated flags value (means
>        back-end has submitted the buffer to guest driver before crash, so
> -      it has to commit the in-progres update), set ``old_free_head``,
> +      it has to commit the in-progress update), set ``old_free_head``,
>        ``old_used_idx``, ``old_used_wrap_counter`` to ``free_head``,
>        ``used_idx``, ``used_wrap_counter``
>  
> diff --git a/docs/system/devices/canokey.rst b/docs/system/devices/canokey.rst
> index cfa6186e48..7f3664963f 100644
> --- a/docs/system/devices/canokey.rst
> +++ b/docs/system/devices/canokey.rst
> @@ -14,7 +14,7 @@ CanoKey [1]_ is an open-source secure key with supports of
>  All these platform-independent features are in canokey-core [3]_.
>  
>  For different platforms, CanoKey has different implementations,
> -including both hardware implementions and virtual cards:
> +including both hardware implementations and virtual cards:
>  
>  * CanoKey STM32 [4]_
>  * CanoKey Pigeon [5]_
> -- 
> γαῖα πυρί μιχθήτω
Manos Pitsidianakis Feb. 20, 2024, 10:42 a.m. UTC | #3
On Tue, 20 Feb 2024 12:36, "Michael S. Tsirkin" <mst@redhat.com> wrote:
>On Tue, Feb 20, 2024 at 10:52:08AM +0200, Manos Pitsidianakis wrote:
>> Correct typos automatically found with the `typos` tool
>> <https://crates.io/crates/typos>
>> 
>> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
>
>Acked-by: Michael S. Tsirkin <mst@redhat.com>
>
>> ---
>>  docs/devel/ci-jobs.rst.inc      | 2 +-
>>  docs/devel/docs.rst             | 2 +-
>>  docs/devel/testing.rst          | 2 +-
>>  docs/interop/prl-xml.txt        | 2 +-
>>  docs/interop/vhost-user.rst     | 2 +-
>>  docs/system/devices/canokey.rst | 2 +-
>>  6 files changed, 6 insertions(+), 6 deletions(-)
>> 
>> diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/ci-jobs.rst.inc
>> index 4c39cdb2d9..6678b4f4ef 100644
>> --- a/docs/devel/ci-jobs.rst.inc
>> +++ b/docs/devel/ci-jobs.rst.inc
>> @@ -147,7 +147,7 @@ Set this variable to 1 to create the pipelines, but leave all
>>  the jobs to be manually started from the UI
>>  
>>  Set this variable to 2 to create the pipelines and run all
>> -the jobs immediately, as was historicaly behaviour
>> +the jobs immediately, as was historically behaviour
>
>as long as we do this let's fix grammar too?
>
>as was historically the behaviour

After the fact, I think it should be "as was historical behaviour".

I will re-spin with only this change, and keep the Acks/RoBs if that is 
okay with everyone.

Thanks,

>
>>  QEMU_CI_AVOCADO_TESTING
>>  ~~~~~~~~~~~~~~~~~~~~~~~
>> diff --git a/docs/devel/docs.rst b/docs/devel/docs.rst
>> index 50ff0d67f8..a7768b5311 100644
>> --- a/docs/devel/docs.rst
>> +++ b/docs/devel/docs.rst
>> @@ -21,7 +21,7 @@ are processed in two ways:
>>  
>>  The syntax of these ``.hx`` files is simple. It is broadly an
>>  alternation of C code put into the C output and rST format text
>> -put into the documention. A few special directives are recognised;
>> +put into the documentation. A few special directives are recognised;
>>  these are all-caps and must be at the beginning of the line.
>>  
>>  ``HXCOMM`` is the comment marker. The line, including any arbitrary
>> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
>> index bd132306c1..aa96eacec5 100644
>> --- a/docs/devel/testing.rst
>> +++ b/docs/devel/testing.rst
>> @@ -728,7 +728,7 @@ For example to setup the HPPA ports builds of Debian::
>>      EXECUTABLE=(pwd)/qemu-hppa V=1
>>  
>>  The ``DEB_`` variables are substitutions used by
>> -``debian-boostrap.pre`` which is called to do the initial debootstrap
>> +``debian-bootstrap.pre`` which is called to do the initial debootstrap
>>  of the rootfs before it is copied into the container. The second stage
>>  is run as part of the build. The final image will be tagged as
>>  ``qemu/debian-sid-hppa``.
>> diff --git a/docs/interop/prl-xml.txt b/docs/interop/prl-xml.txt
>> index 7031f8752c..cf9b3fba26 100644
>> --- a/docs/interop/prl-xml.txt
>> +++ b/docs/interop/prl-xml.txt
>> @@ -122,7 +122,7 @@ Each Image element has following child elements:
>>      * Type - image type of the element. It can be:
>>               "Plain" for raw files.
>>               "Compressed" for expanding disks.
>> -    * File - path to image file. Path can be relative to DiskDecriptor.xml or
>> +    * File - path to image file. Path can be relative to DiskDescriptor.xml or
>>               absolute.
>>  
>>  == Snapshots element ==
>> diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
>> index ad6e142f23..d1ed39dfa0 100644
>> --- a/docs/interop/vhost-user.rst
>> +++ b/docs/interop/vhost-user.rst
>> @@ -989,7 +989,7 @@ When reconnecting:
>>  
>>     #. If ``d.flags`` is not equal to the calculated flags value (means
>>        back-end has submitted the buffer to guest driver before crash, so
>> -      it has to commit the in-progres update), set ``old_free_head``,
>> +      it has to commit the in-progress update), set ``old_free_head``,
>>        ``old_used_idx``, ``old_used_wrap_counter`` to ``free_head``,
>>        ``used_idx``, ``used_wrap_counter``
>>  
>> diff --git a/docs/system/devices/canokey.rst b/docs/system/devices/canokey.rst
>> index cfa6186e48..7f3664963f 100644
>> --- a/docs/system/devices/canokey.rst
>> +++ b/docs/system/devices/canokey.rst
>> @@ -14,7 +14,7 @@ CanoKey [1]_ is an open-source secure key with supports of
>>  All these platform-independent features are in canokey-core [3]_.
>>  
>>  For different platforms, CanoKey has different implementations,
>> -including both hardware implementions and virtual cards:
>> +including both hardware implementations and virtual cards:
>>  
>>  * CanoKey STM32 [4]_
>>  * CanoKey Pigeon [5]_
>> -- 
>> γαῖα πυρί μιχθήτω
>
Michael S. Tsirkin Feb. 20, 2024, 10:56 a.m. UTC | #4
On Tue, Feb 20, 2024 at 12:42:28PM +0200, Manos Pitsidianakis wrote:
> On Tue, 20 Feb 2024 12:36, "Michael S. Tsirkin" <mst@redhat.com> wrote:
> > On Tue, Feb 20, 2024 at 10:52:08AM +0200, Manos Pitsidianakis wrote:
> > > Correct typos automatically found with the `typos` tool
> > > <https://crates.io/crates/typos>
> > > 
> > > Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> > 
> > Acked-by: Michael S. Tsirkin <mst@redhat.com>
> > 
> > > ---
> > >  docs/devel/ci-jobs.rst.inc      | 2 +-
> > >  docs/devel/docs.rst             | 2 +-
> > >  docs/devel/testing.rst          | 2 +-
> > >  docs/interop/prl-xml.txt        | 2 +-
> > >  docs/interop/vhost-user.rst     | 2 +-
> > >  docs/system/devices/canokey.rst | 2 +-
> > >  6 files changed, 6 insertions(+), 6 deletions(-)
> > > 
> > > diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/ci-jobs.rst.inc
> > > index 4c39cdb2d9..6678b4f4ef 100644
> > > --- a/docs/devel/ci-jobs.rst.inc
> > > +++ b/docs/devel/ci-jobs.rst.inc
> > > @@ -147,7 +147,7 @@ Set this variable to 1 to create the pipelines, but leave all
> > >  the jobs to be manually started from the UI
> > >  Set this variable to 2 to create the pipelines and run all
> > > -the jobs immediately, as was historicaly behaviour
> > > +the jobs immediately, as was historically behaviour
> > 
> > as long as we do this let's fix grammar too?
> > 
> > as was historically the behaviour
> 
> After the fact, I think it should be "as was historical behaviour".

it needs the definite article though.

> I will re-spin with only this change, and keep the Acks/RoBs if that is okay
> with everyone.
> 
> Thanks,
> 
> > 
> > >  QEMU_CI_AVOCADO_TESTING
> > >  ~~~~~~~~~~~~~~~~~~~~~~~
> > > diff --git a/docs/devel/docs.rst b/docs/devel/docs.rst
> > > index 50ff0d67f8..a7768b5311 100644
> > > --- a/docs/devel/docs.rst
> > > +++ b/docs/devel/docs.rst
> > > @@ -21,7 +21,7 @@ are processed in two ways:
> > >  The syntax of these ``.hx`` files is simple. It is broadly an
> > >  alternation of C code put into the C output and rST format text
> > > -put into the documention. A few special directives are recognised;
> > > +put into the documentation. A few special directives are recognised;
> > >  these are all-caps and must be at the beginning of the line.
> > >  ``HXCOMM`` is the comment marker. The line, including any arbitrary
> > > diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> > > index bd132306c1..aa96eacec5 100644
> > > --- a/docs/devel/testing.rst
> > > +++ b/docs/devel/testing.rst
> > > @@ -728,7 +728,7 @@ For example to setup the HPPA ports builds of Debian::
> > >      EXECUTABLE=(pwd)/qemu-hppa V=1
> > >  The ``DEB_`` variables are substitutions used by
> > > -``debian-boostrap.pre`` which is called to do the initial debootstrap
> > > +``debian-bootstrap.pre`` which is called to do the initial debootstrap
> > >  of the rootfs before it is copied into the container. The second stage
> > >  is run as part of the build. The final image will be tagged as
> > >  ``qemu/debian-sid-hppa``.
> > > diff --git a/docs/interop/prl-xml.txt b/docs/interop/prl-xml.txt
> > > index 7031f8752c..cf9b3fba26 100644
> > > --- a/docs/interop/prl-xml.txt
> > > +++ b/docs/interop/prl-xml.txt
> > > @@ -122,7 +122,7 @@ Each Image element has following child elements:
> > >      * Type - image type of the element. It can be:
> > >               "Plain" for raw files.
> > >               "Compressed" for expanding disks.
> > > -    * File - path to image file. Path can be relative to DiskDecriptor.xml or
> > > +    * File - path to image file. Path can be relative to DiskDescriptor.xml or
> > >               absolute.
> > >  == Snapshots element ==
> > > diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
> > > index ad6e142f23..d1ed39dfa0 100644
> > > --- a/docs/interop/vhost-user.rst
> > > +++ b/docs/interop/vhost-user.rst
> > > @@ -989,7 +989,7 @@ When reconnecting:
> > >     #. If ``d.flags`` is not equal to the calculated flags value (means
> > >        back-end has submitted the buffer to guest driver before crash, so
> > > -      it has to commit the in-progres update), set ``old_free_head``,
> > > +      it has to commit the in-progress update), set ``old_free_head``,
> > >        ``old_used_idx``, ``old_used_wrap_counter`` to ``free_head``,
> > >        ``used_idx``, ``used_wrap_counter``
> > > diff --git a/docs/system/devices/canokey.rst b/docs/system/devices/canokey.rst
> > > index cfa6186e48..7f3664963f 100644
> > > --- a/docs/system/devices/canokey.rst
> > > +++ b/docs/system/devices/canokey.rst
> > > @@ -14,7 +14,7 @@ CanoKey [1]_ is an open-source secure key with supports of
> > >  All these platform-independent features are in canokey-core [3]_.
> > >  For different platforms, CanoKey has different implementations,
> > > -including both hardware implementions and virtual cards:
> > > +including both hardware implementations and virtual cards:
> > >  * CanoKey STM32 [4]_
> > >  * CanoKey Pigeon [5]_
> > > -- 
> > > γαῖα πυρί μιχθήτω
> >
Michael Tokarev Feb. 20, 2024, 5:22 p.m. UTC | #5
20.02.2024 13:42, Manos Pitsidianakis wrote:
..
>>>  Set this variable to 2 to create the pipelines and run all
>>> -the jobs immediately, as was historicaly behaviour
>>> +the jobs immediately, as was historically behaviour
>>
>> as long as we do this let's fix grammar too?
>>
>> as was historically the behaviour
> 
> After the fact, I think it should be "as was historical behaviour".

That's exactly what I suggested on IRC right after you sent this patch.
Plus "the", so the final version reads

  the jobs immediately, as was the historical behaviour

> I will re-spin with only this change, and keep the Acks/RoBs if that is okay with everyone.

If that's the only change, let me just pick it all with the above fix,
to avoid additional SPAM :)

Either way, I'm picking up this series to trivial-patches@, please
resend just the "changed changes" if needs to be.

Thanks,

/mjt
diff mbox series

Patch

diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/ci-jobs.rst.inc
index 4c39cdb2d9..6678b4f4ef 100644
--- a/docs/devel/ci-jobs.rst.inc
+++ b/docs/devel/ci-jobs.rst.inc
@@ -147,7 +147,7 @@  Set this variable to 1 to create the pipelines, but leave all
 the jobs to be manually started from the UI
 
 Set this variable to 2 to create the pipelines and run all
-the jobs immediately, as was historicaly behaviour
+the jobs immediately, as was historically behaviour
 
 QEMU_CI_AVOCADO_TESTING
 ~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/devel/docs.rst b/docs/devel/docs.rst
index 50ff0d67f8..a7768b5311 100644
--- a/docs/devel/docs.rst
+++ b/docs/devel/docs.rst
@@ -21,7 +21,7 @@  are processed in two ways:
 
 The syntax of these ``.hx`` files is simple. It is broadly an
 alternation of C code put into the C output and rST format text
-put into the documention. A few special directives are recognised;
+put into the documentation. A few special directives are recognised;
 these are all-caps and must be at the beginning of the line.
 
 ``HXCOMM`` is the comment marker. The line, including any arbitrary
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index bd132306c1..aa96eacec5 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -728,7 +728,7 @@  For example to setup the HPPA ports builds of Debian::
     EXECUTABLE=(pwd)/qemu-hppa V=1
 
 The ``DEB_`` variables are substitutions used by
-``debian-boostrap.pre`` which is called to do the initial debootstrap
+``debian-bootstrap.pre`` which is called to do the initial debootstrap
 of the rootfs before it is copied into the container. The second stage
 is run as part of the build. The final image will be tagged as
 ``qemu/debian-sid-hppa``.
diff --git a/docs/interop/prl-xml.txt b/docs/interop/prl-xml.txt
index 7031f8752c..cf9b3fba26 100644
--- a/docs/interop/prl-xml.txt
+++ b/docs/interop/prl-xml.txt
@@ -122,7 +122,7 @@  Each Image element has following child elements:
     * Type - image type of the element. It can be:
              "Plain" for raw files.
              "Compressed" for expanding disks.
-    * File - path to image file. Path can be relative to DiskDecriptor.xml or
+    * File - path to image file. Path can be relative to DiskDescriptor.xml or
              absolute.
 
 == Snapshots element ==
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index ad6e142f23..d1ed39dfa0 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -989,7 +989,7 @@  When reconnecting:
 
    #. If ``d.flags`` is not equal to the calculated flags value (means
       back-end has submitted the buffer to guest driver before crash, so
-      it has to commit the in-progres update), set ``old_free_head``,
+      it has to commit the in-progress update), set ``old_free_head``,
       ``old_used_idx``, ``old_used_wrap_counter`` to ``free_head``,
       ``used_idx``, ``used_wrap_counter``
 
diff --git a/docs/system/devices/canokey.rst b/docs/system/devices/canokey.rst
index cfa6186e48..7f3664963f 100644
--- a/docs/system/devices/canokey.rst
+++ b/docs/system/devices/canokey.rst
@@ -14,7 +14,7 @@  CanoKey [1]_ is an open-source secure key with supports of
 All these platform-independent features are in canokey-core [3]_.
 
 For different platforms, CanoKey has different implementations,
-including both hardware implementions and virtual cards:
+including both hardware implementations and virtual cards:
 
 * CanoKey STM32 [4]_
 * CanoKey Pigeon [5]_