diff mbox series

docs/system/target-riscv.rst: tidy CPU firmware section

Message ID 20230712143728.383528-1-dbarboza@ventanamicro.com
State New
Headers show
Series docs/system/target-riscv.rst: tidy CPU firmware section | expand

Commit Message

Daniel Henrique Barboza July 12, 2023, 2:37 p.m. UTC
This is how the content of the "RISC-V CPU firmware" section is
displayed after the html is generated:

"When using the sifive_u or virt machine there are three different
firmware boot options: 1. -bios default - This is the default behaviour
if no -bios option is included. (...) 3. -bios <file> - Tells QEMU to
load the specified file as the firmware."

It's all in the same paragraph, in a numbered list, and no special
formatting for the options.

Tidy it a bit by adding line breaks between items and its description.
Remove the numbered list. And apply formatting for the options cited in
the middle of the text.

Cc: qemu-trivial@nongnu.org
Signed-off-by: Daniel Henrique Barboza <dbarboza@ventanamicro.com>
---
 docs/system/target-riscv.rst | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

Comments

Michael Tokarev July 13, 2023, 6:46 a.m. UTC | #1
12.07.2023 17:37, Daniel Henrique Barboza wrote:
> This is how the content of the "RISC-V CPU firmware" section is
> displayed after the html is generated:
> 
> "When using the sifive_u or virt machine there are three different
> firmware boot options: 1. -bios default - This is the default behaviour
> if no -bios option is included. (...) 3. -bios <file> - Tells QEMU to
> load the specified file as the firmware."
> 
> It's all in the same paragraph, in a numbered list, and no special
> formatting for the options.
> 
> Tidy it a bit by adding line breaks between items and its description.
> Remove the numbered list. And apply formatting for the options cited in
> the middle of the text.
> 
> Cc: qemu-trivial@nongnu.org
> Signed-off-by: Daniel Henrique Barboza <dbarboza@ventanamicro.com>

I'll pick this up for trivial-patches, but since it's the only patch there
now, it's IMHO better to apply it together with other riscv changes if
there will be any for 8.1.  So let's pick it to both trees and the first
to apply wins.

Thanks,

/mjt
Alistair Francis July 14, 2023, 2:32 a.m. UTC | #2
On Thu, Jul 13, 2023 at 12:38 AM Daniel Henrique Barboza
<dbarboza@ventanamicro.com> wrote:
>
> This is how the content of the "RISC-V CPU firmware" section is
> displayed after the html is generated:
>
> "When using the sifive_u or virt machine there are three different
> firmware boot options: 1. -bios default - This is the default behaviour
> if no -bios option is included. (...) 3. -bios <file> - Tells QEMU to
> load the specified file as the firmware."
>
> It's all in the same paragraph, in a numbered list, and no special
> formatting for the options.
>
> Tidy it a bit by adding line breaks between items and its description.
> Remove the numbered list. And apply formatting for the options cited in
> the middle of the text.
>
> Cc: qemu-trivial@nongnu.org
> Signed-off-by: Daniel Henrique Barboza <dbarboza@ventanamicro.com>

Reviewed-by: Alistair Francis <alistair.francis@wdc.com>

Alistair

> ---
>  docs/system/target-riscv.rst | 24 ++++++++++++++++--------
>  1 file changed, 16 insertions(+), 8 deletions(-)
>
> diff --git a/docs/system/target-riscv.rst b/docs/system/target-riscv.rst
> index 89a866e4f4..ba195f1518 100644
> --- a/docs/system/target-riscv.rst
> +++ b/docs/system/target-riscv.rst
> @@ -76,11 +76,19 @@ RISC-V CPU firmware
>
>  When using the ``sifive_u`` or ``virt`` machine there are three different
>  firmware boot options:
> -1. ``-bios default`` - This is the default behaviour if no -bios option
> -is included. This option will load the default OpenSBI firmware automatically.
> -The firmware is included with the QEMU release and no user interaction is
> -required. All a user needs to do is specify the kernel they want to boot
> -with the -kernel option
> -2. ``-bios none`` - QEMU will not automatically load any firmware. It is up
> -to the user to load all the images they need.
> -3. ``-bios <file>`` - Tells QEMU to load the specified file as the firmware.
> +
> +* ``-bios default``
> +
> +This is the default behaviour if no ``-bios`` option is included. This option
> +will load the default OpenSBI firmware automatically. The firmware is included
> +with the QEMU release and no user interaction is required. All a user needs to
> +do is specify the kernel they want to boot with the ``-kernel`` option
> +
> +* ``-bios none``
> +
> +QEMU will not automatically load any firmware. It is up to the user to load all
> +the images they need.
> +
> +* ``-bios <file>``
> +
> +Tells QEMU to load the specified file as the firmware.
> --
> 2.41.0
>
>
Alistair Francis July 14, 2023, 2:33 a.m. UTC | #3
On Thu, Jul 13, 2023 at 4:47 PM Michael Tokarev <mjt@tls.msk.ru> wrote:
>
> 12.07.2023 17:37, Daniel Henrique Barboza wrote:
> > This is how the content of the "RISC-V CPU firmware" section is
> > displayed after the html is generated:
> >
> > "When using the sifive_u or virt machine there are three different
> > firmware boot options: 1. -bios default - This is the default behaviour
> > if no -bios option is included. (...) 3. -bios <file> - Tells QEMU to
> > load the specified file as the firmware."
> >
> > It's all in the same paragraph, in a numbered list, and no special
> > formatting for the options.
> >
> > Tidy it a bit by adding line breaks between items and its description.
> > Remove the numbered list. And apply formatting for the options cited in
> > the middle of the text.
> >
> > Cc: qemu-trivial@nongnu.org
> > Signed-off-by: Daniel Henrique Barboza <dbarboza@ventanamicro.com>
>
> I'll pick this up for trivial-patches, but since it's the only patch there
> now, it's IMHO better to apply it together with other riscv changes if
> there will be any for 8.1.  So let's pick it to both trees and the first
> to apply wins.

Sounds good to me!

Applied to riscv-to-apply.next

Alistair

>
> Thanks,
>
> /mjt
>
>
diff mbox series

Patch

diff --git a/docs/system/target-riscv.rst b/docs/system/target-riscv.rst
index 89a866e4f4..ba195f1518 100644
--- a/docs/system/target-riscv.rst
+++ b/docs/system/target-riscv.rst
@@ -76,11 +76,19 @@  RISC-V CPU firmware
 
 When using the ``sifive_u`` or ``virt`` machine there are three different
 firmware boot options:
-1. ``-bios default`` - This is the default behaviour if no -bios option
-is included. This option will load the default OpenSBI firmware automatically.
-The firmware is included with the QEMU release and no user interaction is
-required. All a user needs to do is specify the kernel they want to boot
-with the -kernel option
-2. ``-bios none`` - QEMU will not automatically load any firmware. It is up
-to the user to load all the images they need.
-3. ``-bios <file>`` - Tells QEMU to load the specified file as the firmware.
+
+* ``-bios default``
+
+This is the default behaviour if no ``-bios`` option is included. This option
+will load the default OpenSBI firmware automatically. The firmware is included
+with the QEMU release and no user interaction is required. All a user needs to
+do is specify the kernel they want to boot with the ``-kernel`` option
+
+* ``-bios none``
+
+QEMU will not automatically load any firmware. It is up to the user to load all
+the images they need.
+
+* ``-bios <file>``
+
+Tells QEMU to load the specified file as the firmware.