[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] Fix some typos in documentation and comments
From: |
Peter Maydell |
Subject: |
Re: [PATCH] Fix some typos in documentation and comments |
Date: |
Sun, 30 Oct 2022 10:32:07 +0000 |
On Sat, 29 Oct 2022 at 18:25, Stefan Weil <sw@weilnetz.de> wrote:
>
> Most of them were found and fixed using codespell.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
>
> My focus was fixing typos which are relevant for the generated documentation.
>
> codespell finds many more typos in source code, and adding it to the
> continuous
> integration checks looks more and more like a good idea.
>
> Stefan
>
>
> docs/devel/qapi-code-gen.rst | 2 +-
> docs/devel/testing.rst | 2 +-
> docs/system/arm/cpu-features.rst | 2 +-
> docs/system/loongarch/loongson3.rst | 2 +-
> docs/tools/virtiofsd.rst | 2 +-
> include/exec/memory.h | 2 +-
> qapi/qom.json | 2 +-
> qemu-options.hx | 8 ++++----
> qga/qapi-schema.json | 2 +-
> tests/qtest/libqtest.h | 2 +-
> 10 files changed, 13 insertions(+), 13 deletions(-)
>
> diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
> index cd9b544376..c4c04bf755 100644
> --- a/docs/devel/qapi-code-gen.rst
> +++ b/docs/devel/qapi-code-gen.rst
> @@ -1313,7 +1313,7 @@ Removing "unreachable" stuff like events that can't be
> triggered
> anymore, optional return or event data members that can't be sent
> anymore, and return or event data member (enumeration) values that
> can't be sent anymore makes no difference to clients, except for
> -introspection. The latter can conceivably confuse clients, so tread
> +introspection. The latter can conceivably confuse clients, so treat
> carefully.
No, the current text is correct: "tread carefully" means "be cautious".
> --- a/docs/system/loongarch/loongson3.rst
> +++ b/docs/system/loongarch/loongson3.rst
> @@ -41,7 +41,7 @@ can be accessed by following steps.
>
> $ qemu-system-loongarch64 -machine virt -m 4G -cpu la464-loongarch-cpu \
> -smp 1 -bios QEMU_EFI.fd -kernel vmlinuz.efi -initrd initrd.img \
> - -append "root=/dev/ram rdinit=/sbin/init consol e=ttyS0,115200" \
> + -append "root=/dev/ram rdinit=/sbin/init console e=ttyS0,115200" \
> --nographic
This is an error, but the fix is wrong -- the space between 'l' and 'e'
should just be deleted.
> @@ -5248,7 +5248,7 @@ SRST
> read the colo-compare git log.
>
> ``-object cryptodev-backend-builtin,id=id[,queues=queues]``
> - Creates a cryptodev backend which executes crypto opreation from
> + Creates a cryptodev backend which executes crypto operation from
Should be "operations"
> the QEMU cipher APIS. The id parameter is a unique ID that will
This should be "APIs".
The other changes in the patch look good.
thanks
-- PMM