update qemu doc for more detailed command line options #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fanghuaqi
requested changes
Jul 26, 2024
There was a problem hiding this comment.
@bigmagic123 请重新修改下文档再做提交。
格式需要做一些大规模的变更，介绍常见的裸机和Linux的命令行样例是什么样的，然后挨个选项进行详细的介绍，每个选项有哪些参数，什么含义都需要介绍下。
source/qemu/intro.rst
Outdated
| @@ -22,13 +26,13 @@ You can enter qemu-system-riscv32 --help to view the parameters that can be conf | |||
| :align: center | |||
| :alt: Nuclei QEMU CPUs Support | |||
|
|
|||
| * ``-M nuclei_evalsoc,download=ddr,soc-cfg=evalsoc.json``: | |||
| * ``-M nuclei_evalsoc,download=ddr,soc-cfg=evalsoc.json,debug=1``: | |||
|
|
|||
| ``-M`` represents ``machine``, which means selecting the type of machine. Currently, Nuclei QEMU has added "nuclei_demosoc" (which will be deprecated in future versions) and "nuclei_evalsoc" to the existing options. | |||
There was a problem hiding this comment.
这里重点提一下 nuclei_evalsoc, 就说 nuclei_demosoc 已经弃用了，后续不再维护。
| @@ -22,13 +26,13 @@ You can enter qemu-system-riscv32 --help to view the parameters that can be conf | |||
| :align: center | |||
| :alt: Nuclei QEMU CPUs Support | |||
|
|
|||
| * ``-M nuclei_evalsoc,download=ddr,soc-cfg=evalsoc.json``: | |||
| * ``-M nuclei_evalsoc,download=ddr,soc-cfg=evalsoc.json,debug=1``: | |||
There was a problem hiding this comment.
选项讲解的时候需要说一下哪些是可选的， 哪些是必要的。
例如 这个 -M nuclei_evalsoc,download=ddr 这个就是必须的，且这里的download=ddr里面的ddr有哪些参数可以配置，后面其他的可选项，有哪些参数。
类似的 -cpu也是这样介绍。
source/qemu/intro.rst
Outdated
| You can enter qemu-system-riscv32 --help to view the parameters that can be configured in Nuclei QEMU. Here are some commonly used parameters: | ||
| You can enter qemu-system-riscv32 --help to view the parameters that can be configured in Nuclei QEMU. | ||
|
|
||
| This is an example of a fully functional parameter for nuclei qemu: ``qemu-system-riscv32 -M nuclei_evalsoc,download=ddr,soc-cfg=evalsoc.json,debug=1 -cpu nuclei-n300fd,ext=_v_xxldsp,vlen=128,elen=64,s=true -m 512M -smp 1 -icount shift=0 -nodefaults -nographic -serial stdio -kernel dhrystone.elf``. |
There was a problem hiding this comment.
除了关键的 -M 和 -cpu 需要介绍，其他的选项例如 -m ， -smp , -icount shift=0 -nodefaults -nographic -serial stdio 这些选项都需要介绍下。
然后就是 我们处理 -kernel 和 -bios的区别，主要是一个针对 ECLIC中断模式，面向裸机，一个针对 PLIC中断模式 + CLINT Timer，面向Linux，这点需要写出来，并详细描述下。
最好整个文档重整下格式，不要修修补补
source/qemu/intro.rst
Outdated
| @@ -12,7 +12,11 @@ Design and Architecture | |||
| ======================= | |||
|
|
|||
| Nuclei QEMU has several types of parameters that can be configured. | |||
| You can enter qemu-system-riscv32 --help to view the parameters that can be configured in Nuclei QEMU. Here are some commonly used parameters: | |||
| You can enter qemu-system-riscv32 --help to view the parameters that can be configured in Nuclei QEMU. | |||
There was a problem hiding this comment.
qemu-system-riscv32 --help -> qemu-system-riscv32 --help
fanghuaqi
changed the title
|
@bigmagic123 更新下。 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add descriptions for some commonly used parameters