docs/system/target-riscv.rst: tidy CPU firmware section
PATCH 1/1 docs/system/target-riscv.rst: tidy CPU firmware section
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.
--- docs/system/target-riscv.rst | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-)
docs/system/target-riscv.rst +16 -8
@@ -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.
Signature · 1 line
2.41.0
Quoted 11 lines · Daniel Henrique Barboza
This is how the content of the "RISC-V CPU firmware" section is displayed after the html is generated:
"When using the
sifive_uor 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.
Quoted 6 lines
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.
Signed-off-by Daniel Henrique Barboza <[email protected]>
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
AppliedQuoted 17 lines · Michael Tokarev
Quoted 15 lines · Daniel Henrique Barboza
This is how the content of the "RISC-V CPU firmware" section is displayed after the html is generated:
"When using the
sifive_uor 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.
Quoted 7 lines
Quoted 2 lines
Signed-off-by Daniel Henrique Barboza <[email protected]>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
Quoted 6 lines
Thanks,
/mjt
Quoted 12 lines · Daniel Henrique Barboza
This is how the content of the "RISC-V CPU firmware" section is displayed after the html is generated:
"When using the
sifive_uor 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.
Quoted 6 lines
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.
Signed-off-by Daniel Henrique Barboza <[email protected]>
Alistair
Quoted 40 lines
--- docs/system/target-riscv.rst | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-)docs/system/target-riscv.rst +16
-9@@ -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