Skip to content
This repository was archived by the owner on May 23, 2024. It is now read-only.

Commit b1b1033

Browse files
committed
docs: Remove esp-backtrace section
1 parent 1f628e3 commit b1b1033

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,30 +71,19 @@ If this simple logger implementation isn't sufficient for your needs, you can im
7171

7272
## `defmt`
7373

74-
Using the `defmt-espflash` feature, esp-println will install a defmt global logger. The logger will
74+
Using the `defmt-espflash` feature, `esp-println` will install a `defmt` global logger. The logger will
7575
output to the same data stream as `println!()`, and adds framing bytes so it can be used even with
76-
other, non-defmt output. Using the `defmt-espflash` feature automatically uses the Rzcobs encoding and does
76+
other, non-`defmt` output. Using the `defmt-espflash` feature automatically uses the [rzCOBS] encoding and does
7777
not allow changing the encoding.
7878

7979
Follow the [`defmt` book's setup instructions] on how to
8080
set up `defmt`. Remember, the global logger is already installed for you by `esp-println`!
8181

82-
# `esp-backtrace`
83-
84-
`esp-println` is usually used alongside [`esp-backtrace`]. When using this
85-
two crates together, make sure to use the same communication methods for
86-
both dependencies. Table matching features:
87-
| `esp-println` | `esp-backtrace` |
88-
| ------------- | ------------------- |
89-
| `uart` | `print-uart` |
90-
| `jtag-serial` | `print-jtag-serial` |
91-
9282
[`defmt`]: https://github.com/knurling-rs/defmt
9383
[`log` crate]: https://github.com/rust-lang/log
9484
[rzCOBS]: https://github.com/Dirbaio/rzcobs
9585
[`espflash`]: https://github.com/esp-rs/espflash
9686
[disable the default features]: https://doc.rust-lang.org/cargo/reference/features.html#the-default-feature
97-
[`esp-backtrace`]: https://github.com/esp-rs/esp-backtrace
9887
[Implementing a Logger section log documentaion]: https://docs.rs/log/0.4.17/log/#implementing-a-logger
9988
[`defmt` book's setup instructions]: https://defmt.ferrous-systems.com/setup
10089

0 commit comments

Comments
 (0)