aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jonas Schievink <jonasschievink@gmail.com> 2020-08-23 22:13:32 +0200
committerGravatar Jonas Schievink <jonasschievink@gmail.com> 2020-08-23 22:13:32 +0200
commitc3851d8928c1f0b402a2144a157081a6e2c7dc5b (patch)
tree0eb74c75c75c801014079f2f35a0d21e38a10a02
parent7d19e64be310c7c91e9e3773ef0ddf155a93959f (diff)
downloadcortex-m-c3851d8928c1f0b402a2144a157081a6e2c7dc5b.tar.gz
cortex-m-c3851d8928c1f0b402a2144a157081a6e2c7dc5b.tar.zst
cortex-m-c3851d8928c1f0b402a2144a157081a6e2c7dc5b.zip
Remove broken doctest/example
This is unsound unless you control the panic handler implementation.
-rw-r--r--cortex-m-rt/src/lib.rs18
1 files changed, 1 insertions, 17 deletions
diff --git a/cortex-m-rt/src/lib.rs b/cortex-m-rt/src/lib.rs
index fe56477..65dee34 100644
--- a/cortex-m-rt/src/lib.rs
+++ b/cortex-m-rt/src/lib.rs
@@ -657,29 +657,13 @@ pub use macros::entry;
///
/// # Examples
///
-/// - Setting the `HardFault` handler
-///
-/// ```
-/// # extern crate cortex_m_rt;
-/// # extern crate cortex_m_rt_macros;
-/// use cortex_m_rt::{ExceptionFrame, exception};
-///
-/// #[exception]
-/// fn HardFault(ef: &ExceptionFrame) -> ! {
-/// // prints the exception frame as a panic message
-/// panic!("{:#?}", ef);
-/// }
-///
-/// # fn main() {}
-/// ```
-///
/// - Setting the default handler
///
/// ```
/// use cortex_m_rt::exception;
///
/// #[exception]
-/// fn DefaultHandler(irqn: i16) {
+/// unsafe fn DefaultHandler(irqn: i16) {
/// println!("IRQn = {}", irqn);
/// }
///