Skip to content
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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

KJ7LNW
Copy link
Contributor

@KJ7LNW KJ7LNW commented Dec 23, 2023

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.

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.
@CLAassistant
Copy link

CLAassistant commented Dec 23, 2023

CLA assistant check
All committers have signed the CLA.

Copy link

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "doc: qemu: link to qemu build instructions":
    • body's lines must not be longer than 100 characters
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert]

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 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 ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against a7345cf

@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 23, 2023
@github-actions github-actions bot changed the title doc: qemu: link to qemu build instructions doc: qemu: link to qemu build instructions (IDFGH-11765) Dec 23, 2023
@KJ7LNW
Copy link
Contributor Author

KJ7LNW commented Dec 23, 2023

See also: espressif/esp-toolchain-docs#4

Copy link
Member

@igrr igrr left a 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.
Copy link
Member

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.)

Copy link
Contributor Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants