[PATCH-for-5.2] docs/user: Display linux-user binaries nicely

Philippe Mathieu-Daudé posted 1 patch 4 days, 14 hours ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20201119160838.1981709-1-f4bug@amsat.org
docs/user/main.rst | 99 ++++++++++++++++++++++++++--------------------
1 file changed, 56 insertions(+), 43 deletions(-)

[PATCH-for-5.2] docs/user: Display linux-user binaries nicely

Posted by Philippe Mathieu-Daudé 4 days, 14 hours ago
linux-user binaries are displayed altogether. Use the '*'
character to force displaying them as bullet list (one list
per architecture).

Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 docs/user/main.rst | 99 ++++++++++++++++++++++++++--------------------
 1 file changed, 56 insertions(+), 43 deletions(-)

diff --git a/docs/user/main.rst b/docs/user/main.rst
index bd99b0fdbe9..8dfe232a3af 100644
--- a/docs/user/main.rst
+++ b/docs/user/main.rst
@@ -170,68 +170,81 @@ QEMU_STRACE
 Other binaries
 ~~~~~~~~~~~~~~
 
-user mode (Alpha)
-``qemu-alpha`` TODO.
+-  user mode (Alpha)
 
-user mode (Arm)
-``qemu-armeb`` TODO.
+   * ``qemu-alpha`` TODO.
 
-user mode (Arm)
-``qemu-arm`` is also capable of running Arm \"Angel\" semihosted ELF
-binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
-configurations), and arm-uclinux bFLT format binaries.
+-  user mode (Arm)
 
-user mode (ColdFire)
-user mode (M68K)
-``qemu-m68k`` is capable of running semihosted binaries using the BDM
-(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
-coldfire uClinux bFLT format binaries.
+   * ``qemu-armeb`` TODO.
 
-The binary format is detected automatically.
+   * ``qemu-arm`` is also capable of running Arm \"Angel\" semihosted ELF
+     binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
+     configurations), and arm-uclinux bFLT format binaries.
 
-user mode (Cris)
-``qemu-cris`` TODO.
+-  user mode (ColdFire)
 
-user mode (i386)
-``qemu-i386`` TODO. ``qemu-x86_64`` TODO.
+-  user mode (M68K)
 
-user mode (Microblaze)
-``qemu-microblaze`` TODO.
+   * ``qemu-m68k`` is capable of running semihosted binaries using the BDM
+     (m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
+     coldfire uClinux bFLT format binaries.
 
-user mode (MIPS)
-``qemu-mips`` executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
+   The binary format is detected automatically.
 
-``qemu-mipsel`` executes 32-bit little endian MIPS binaries (MIPS O32
-ABI).
+-  user mode (Cris)
 
-``qemu-mips64`` executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
+   * ``qemu-cris`` TODO.
 
-``qemu-mips64el`` executes 64-bit little endian MIPS binaries (MIPS N64
-ABI).
+-  user mode (i386)
 
-``qemu-mipsn32`` executes 32-bit big endian MIPS binaries (MIPS N32
-ABI).
+   * ``qemu-i386`` TODO.
+   * ``qemu-x86_64`` TODO.
 
-``qemu-mipsn32el`` executes 32-bit little endian MIPS binaries (MIPS N32
-ABI).
+-  user mode (Microblaze)
 
-user mode (NiosII)
-``qemu-nios2`` TODO.
+   * ``qemu-microblaze`` TODO.
 
-user mode (PowerPC)
-``qemu-ppc64abi32`` TODO. ``qemu-ppc64`` TODO. ``qemu-ppc`` TODO.
+-  user mode (MIPS)
 
-user mode (SH4)
-``qemu-sh4eb`` TODO. ``qemu-sh4`` TODO.
+   * ``qemu-mips`` executes 32-bit big endian MIPS binaries (MIPS O32 ABI).
 
-user mode (SPARC)
-``qemu-sparc`` can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
+   * ``qemu-mipsel`` executes 32-bit little endian MIPS binaries (MIPS O32 ABI).
 
-``qemu-sparc32plus`` can execute Sparc32 and SPARC32PLUS binaries
-(Sparc64 CPU, 32 bit ABI).
+   * ``qemu-mips64`` executes 64-bit big endian MIPS binaries (MIPS N64 ABI).
 
-``qemu-sparc64`` can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
-SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
+   * ``qemu-mips64el`` executes 64-bit little endian MIPS binaries (MIPS N64
+     ABI).
+
+   * ``qemu-mipsn32`` executes 32-bit big endian MIPS binaries (MIPS N32 ABI).
+
+   * ``qemu-mipsn32el`` executes 32-bit little endian MIPS binaries (MIPS N32
+     ABI).
+
+-  user mode (NiosII)
+
+   * ``qemu-nios2`` TODO.
+
+-  user mode (PowerPC)
+
+   * ``qemu-ppc64abi32`` TODO.
+   * ``qemu-ppc64`` TODO.
+   * ``qemu-ppc`` TODO.
+
+-  user mode (SH4)
+
+   * ``qemu-sh4eb`` TODO.
+   * ``qemu-sh4`` TODO.
+
+-  user mode (SPARC)
+
+   * ``qemu-sparc`` can execute Sparc32 binaries (Sparc32 CPU, 32 bit ABI).
+
+   * ``qemu-sparc32plus`` can execute Sparc32 and SPARC32PLUS binaries
+     (Sparc64 CPU, 32 bit ABI).
+
+   * ``qemu-sparc64`` can execute some Sparc64 (Sparc64 CPU, 64 bit ABI) and
+     SPARC32PLUS binaries (Sparc64 CPU, 32 bit ABI).
 
 BSD User space emulator
 -----------------------
-- 
2.26.2

Re: [PATCH-for-5.2] docs/user: Display linux-user binaries nicely

Posted by Philippe Mathieu-Daudé 4 days, 13 hours ago
On 11/19/20 5:08 PM, Philippe Mathieu-Daudé wrote:
> linux-user binaries are displayed altogether. Use the '*'
> character to force displaying them as bullet list (one list
> per architecture).
> 
> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> ---
>  docs/user/main.rst | 99 ++++++++++++++++++++++++++--------------------
>  1 file changed, 56 insertions(+), 43 deletions(-)

Patch easier to review using 'git-diff --word-diff=porcelain'.

> 
> diff --git a/docs/user/main.rst b/docs/user/main.rst
> index bd99b0fdbe9..8dfe232a3af 100644
> --- a/docs/user/main.rst
> +++ b/docs/user/main.rst
> @@ -170,68 +170,81 @@ QEMU_STRACE
>  Other binaries
>  ~~~~~~~~~~~~~~
>  
> -user mode (Alpha)
> -``qemu-alpha`` TODO.
> +-  user mode (Alpha)
>  
> -user mode (Arm)
> -``qemu-armeb`` TODO.
> +   * ``qemu-alpha`` TODO.
>  
> -user mode (Arm)
> -``qemu-arm`` is also capable of running Arm \"Angel\" semihosted ELF
> -binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
> -configurations), and arm-uclinux bFLT format binaries.
> +-  user mode (Arm)
>  
> -user mode (ColdFire)
> -user mode (M68K)
> -``qemu-m68k`` is capable of running semihosted binaries using the BDM
> -(m5xxx-ram-hosted.ld) or m68k-sim (sim.ld) syscall interfaces, and
> -coldfire uClinux bFLT format binaries.
> +   * ``qemu-armeb`` TODO.
>  
> -The binary format is detected automatically.
> +   * ``qemu-arm`` is also capable of running Arm \"Angel\" semihosted ELF
> +     binaries (as implemented by the arm-elf and arm-eabi Newlib/GDB
> +     configurations), and arm-uclinux bFLT format binaries.
>  
> -user mode (Cris)
> -``qemu-cris`` TODO.
> +-  user mode (ColdFire)
...

Re: [PATCH-for-5.2] docs/user: Display linux-user binaries nicely

Posted by Philippe Mathieu-Daudé 17 hours ago
ping?

On 11/19/20 5:21 PM, Philippe Mathieu-Daudé wrote:
> On 11/19/20 5:08 PM, Philippe Mathieu-Daudé wrote:
>> linux-user binaries are displayed altogether. Use the '*'
>> character to force displaying them as bullet list (one list
>> per architecture).
>>
>> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
>> ---
>>  docs/user/main.rst | 99 ++++++++++++++++++++++++++--------------------
>>  1 file changed, 56 insertions(+), 43 deletions(-)
> 
> Patch easier to review using 'git-diff --word-diff=porcelain'.