Re: [RFC PATCH v4 01/30] target/loongarch: Update README

[WANG Xuerui <i.qemu@xen0n.name>]

On 1/8/22 17:13, Xiaojuan Yang wrote:
> Mainly introduce how to run the softmmu
This sentence serves little purpose and is broken English, so it is 
better removed.
> Signed-off-by: Xiaojuan Yang<yangxiaojuan@loongson.cn>
> Signed-off-by: Song Gao<gaosong@loongson.cn>
> ---
>   target/loongarch/README | 25 +++++++++++++++++++++++++
>   1 file changed, 25 insertions(+)
>
> diff --git a/target/loongarch/README b/target/loongarch/README
> index d5780c5918..337ba55f33 100644
> --- a/target/loongarch/README
> +++ b/target/loongarch/README
> @@ -72,6 +72,31 @@
>         ./qemu-loongarch64  /opt/clfs/usr/bin/pwd
>         ...
>   
> +- Softmmu emulation
You may mean "System emulation" instead?
> +
> +  Add support softmmu emulation support in the following series patches.
People don't care about patch series when they look at this file after 
everything is merged; they are NOT looking at Patchew or mailing lists 
when browsing code either locally or on GitLab/GitHub. You may just drop 
this sentence.
> +  Mainly emulate a virt 3A5000 board and ls7a bridge that is not exactly
> +  the same as the host. Kernel code and uefi code is on the github.
So what exactly is the difference? And does it affect general use?
> +  All required binaries can get from github for test.
English problem; "You can get all required binaries from GitHub for 
testing."
> +
> +  1.Download kernel and the cross-tools.(vmlinux)
> +
> +https://github.com/loongson/linux/tree/loongarch-next
> +https://github.com/loongson/build-tools/releases/latest/download/loongarch64-clfs-20211202-cross-tools.tar.xz
> +
> +  2.Download uefi code.(loongarch_bios.bin)
> +
> +https://github.com/loongson/edk2/tree/LoongArch
> +https://github.com/loongson/edk2-platforms
> +
> +  3.Download the clfs-system and make a ramdisk with busybox.(ramdisk)
How do we make the ramdisk, or is it prebuilt too? It's not clear from 
the description.
> +
> +  4.Run with command,eg:
> +
> +   ./build/qemu-system-loongarch64 -m 4G -smp 4 --cpu Loongson-3A5000 --machine loongson3-ls7a -kernel ./vmlinux -initrd ./ramdisk  -append "root=/dev/ram console=ttyS0,115200 rdinit=/sbin/init loglevel=8" -monitor tcp::4000,server,nowait -nographic
> +
> +The vmlinux, ramdisk and uefi binary loongarch_bios.bin can get from :
Broken English too.
> +    git clonehttps://github.com/yangxiaojuan-loongson/qemu-binary
>   
>   - Note.
>     We can get the latest LoongArch documents or LoongArch tools athttps://github.com/loongson/

Overall the English is so badly written that I cannot easily comprehend 
some of the sentences, even as a native Chinese speaker, familiar with 
common Chinglish patterns.

I suggest just rewriting the whole thing, possibly with help from 
someone else more familiar with technical English in your company. You'd 
want to check your other usages of English throughout the series, too.