Update outdated qemu documentation#403
Open
crespum wants to merge 2 commits intorust-embedded:masterfrom
Open
Conversation
eldruin
reviewed
Jan 28, 2026
src/start/qemu.md
Outdated
|
|
||
| Next, let's see how to run an embedded program on QEMU! This time we'll use the | ||
| `hello` example which actually does something. | ||
| `hello` example which actually does something. By default, this example uses [defmt] |
Member
There was a problem hiding this comment.
Suggested change
| `hello` example which actually does something. By default, this example uses [defmt] | |
| `hello` example which actually does something. By default, this example uses `[defmt]` |
src/start/qemu.md
Outdated
|
|
||
| ```rust,ignore | ||
| //! Prints "Hello, world!" on the host console using semihosting | ||
| In order to read and decode the messages produced by defmt in the host, we need to |
Member
There was a problem hiding this comment.
Suggested change
| In order to read and decode the messages produced by defmt in the host, we need to | |
| In order to read and decode the messages produced by `defmt` in the host, we need to |
src/start/qemu.md
Outdated
| -kernel target/thumbv7m-none-eabi/debug/hello | ||
| ``` | ||
|
|
||
| In our case, since we use defmt, the host will not be able to decode the output. Instead, we |
Member
There was a problem hiding this comment.
Suggested change
| In our case, since we use defmt, the host will not be able to decode the output. Instead, we | |
| In our case, since we use `defmt`, the host will not be able to decode the output. Instead, we |
Author
|
I've added a note about |
Member
|
Thanks! Do you have an opinion on this PR @adamgreig ? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I've seen #400 PR but I went ahead and modified the docs to use the new suggested template (https://github.com/knurling-rs/app-template).
The tricky part is that the new template uses
defmt, so theqemu-system-armbinary is not enough but Ferrous System'sqemu-runtool is required to decode the output properly.I'm not a big fan of third-party dependencies in the official docs, but feedback is welcome.