-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: qemu: link to qemu build instructions (IDFGH-11765) #12863
base: master
Are you sure you want to change the base?
Conversation
The build instructions for Espessif's qemu build are available but were not linked from this documentation. Add the link and extend the explanation about building QEMU for Xtensa and esp32c3.
👋 Hello KJ7LNW, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
See also: espressif/esp-toolchain-docs#4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fix, just one extra request.
@@ -16,7 +16,7 @@ To use QEMU with ``idf.py`` you first need to install the above-mentioned fork o | |||
|
|||
After installing QEMU, make sure it is added to PATH by running ``. ./export.sh`` in the IDF directory. | |||
|
|||
If you are using a different platform, you need to build QEMU from source. Refer to official QEMU documentation for instructions. | |||
If you are using a different platform, you need to build QEMU from source `for the Xtensa and RISC-V targets <https://github.com/espressif/esp-toolchain-docs/blob/main/qemu/esp32/README.md>`_ using the `Espressif QEMU work-in-progress fork <https://github.com/espressif/qemu>`_ containing ``xtensa-softmmu`` and ``riscv32-softmmu`` support. Ultimately, the Xtensa and ``esp32c3`` RISC-V targets are intended to be mainlined into QEMU upstream. Refer to official QEMU documentation for additional build instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please make the reference to the architecture conditional on the current chip target? Otherwise it would be odd to mention Xtensa when building docs for C3, and vice versa. (Docs)
(Or just let me know if you don't want to deal with this, I can fix up your commit before merging it.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Or just let me know if you don't want to deal with this, I can fix up your commit before merging it.)
Thanks, please do!
The build instructions for Espessif's qemu build are available but were not linked from this documentation. Add the link and extend the explanation about building QEMU for Xtensa and esp32c3.