Skip to content

Commit e460834

Browse files
committed
Document defmt feature
1 parent cf11d55 commit e460834

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/lib.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,22 @@
6868
### stm32-usbd
6969
7070
Enable USB peripherals on supported targets.
71+
72+
### `defmt`
73+
74+
Currently these are only used for panicking calls, like
75+
`assert!` `panic!` or `unwrap()`. These are enabled using the [defmt][]
76+
[filter][].
77+
For now [defmt][] is mostly intended for internal development and testing
78+
to further reduce panicking calls in this crate.
79+
The support of this feature is _subject to change_ as the development
80+
of [defmt][] is advancing.
81+
82+
To use this feature follow the [Application Setup][] of the `defmt-book`.
83+
84+
[Application Setup]: https://defmt.ferrous-systems.com/setup-app.html
85+
[defmt]: https://github.com/knurling-rs/defmt
86+
[filter]: https://defmt.ferrous-systems.com/filtering.html
7187
*/
7288
#![no_std]
7389
#![allow(non_camel_case_types)]

0 commit comments

Comments
 (0)