Skip to content

Update printers.md #372

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.

Sign up for GitHub

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

Merged
bors merged 1 commit into from
Feb 9, 2021
Merged

Update printers.md #372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions book/src/printers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
*Printers* are *host* programs that receive log data, format it and display it.
The following printers are currently available:

- [`probe-run`], parses data sent over RTT (ARM Cortex-M only). NOTE: if you are using the git version of defmt, make sure you also install the tool from git (not crates.io).
- [`defmt-print`], a generic command-line tool that decodes defmt data passed into its standard input.
- [`qemu-run`], parses data sent by QEMU over semihosting (ARM Cortex-M only). NOTE: used for internal testing; won't be published to crates.io
- [`probe-run`], parses data sent over RTT (ARM Cortex-M only). NOTE: make sure you install the tool from git (not crates.io) and enable the "defmt" Cargo feature.

[`qemu-run`]: https://github.com/knurling-rs/defmt/tree/main/qemu-run
[`probe-run`]: https://github.com/knurling-rs/probe-run
[`defmt-print`]: https://github.com/knurling-rs/defmt/tree/main/print
[`qemu-run`]: https://github.com/knurling-rs/defmt/tree/main/qemu-run
⚡