Put the panic handler behind a feature flag

tgross35 · tgross35 · commit 588c8ca19556 · 2023-02-23T22:35:32.000-05:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,5 +11,7 @@ description = "A crate to write CMSIS-DAP flash algorithms for flashing embedded
 [dependencies]
 
 [features]
-default = ["erase-chip"]
+default = ["erase-chip", "panic-handler"]
 erase-chip = []
+panic-handler = []
+
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,8 +1,18 @@
+//! Implement a [CMSIS-Pack] flash algorithm in Rust
+//! 
+//! [CMSIS-Pack]: https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/flashAlgorithm.html
+//! 
+//! # Feature flags
+//! 
+//! - `panic-handler` this is enabled by default and includes a simple abort-on-panic
+//!   panic handler. Disable this feature flag if you would prefer to use a different
+//!   handler.
+
 #![no_std]
 #![no_main]
 #![macro_use]
 
-#[cfg(not(test))]
+#[cfg(all(not(test), feature = "panic-handler"))]
 #[panic_handler]
 fn panic(_info: &core::panic::PanicInfo) -> ! {
     unsafe {
