Merge pull request #271 from Sh3Rm4n/usb

Rename stm32-usbd feature to usb

Author: Sh3Rm4n

CHANGELOG.md

@@ -62,7 +62,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - The `embedded-hal` Read implementation of `Serial` does now return `WoudBlock`
   if the peripheral is busy. Also if an `Overrun` occured the receive data
   register (RDR) is flushed to have a more consistent API. ([#253])
-- Remove `cargo-metadata` as a build dependency to cut down dependencies and 
+- Remove `cargo-metadata` as a build dependency to cut down dependencies and
   the reliance on `resolver = "2"`. ([#270])
 
 ### Fixed
@@ -115,6 +115,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Adc's `SampleTime` type has been reworked and is now a consistent wrapper around
   the underlying types for `stm32f3`'s `SMP9_A` and `SMP18_A` type. ([#266])
 - Rename `CkMode` to `ClockMode` ([#266])
+- Rename `stm32-usbd` feature to `usb`. `stm32-usbd` is still used as a
+  dependency. ([#271])
 
 ## [v0.7.0] - 2021-06-18
 
@@ -440,6 +442,7 @@ let clocks = rcc
 [defmt]: https://github.com/knurling-rs/defmt
 [filter]: https://defmt.ferrous-systems.com/filtering.html
 
+[#271]: https://github.com/stm32-rs/stm32f3xx-hal/pull/271
 [#270]: https://github.com/stm32-rs/stm32f3xx-hal/pull/270
 [#266]: https://github.com/stm32-rs/stm32f3xx-hal/pull/266
 [#265]: https://github.com/stm32-rs/stm32f3xx-hal/pull/265

Cargo.toml

@@ -28,15 +28,15 @@ members = [
 ]
 
 [package.metadata.docs.rs]
-features = ["stm32f303xc", "rt", "stm32-usbd", "can"]
+features = ["stm32f303xc", "rt", "usb", "can"]
 targets = ["thumbv7em-none-eabihf"]
 rustc-args = ["--cfg", "docsrs"]
 
 [dependencies]
 cfg-if = "1.0.0"
 cortex-m = "0.7.2"
 cortex-m-rt = "0.6.14"
-defmt = { version = "0.2.2", optional = true }
+defmt = { version = "0.2.3", optional = true }
 embedded-dma = "0.1.2"
 embedded-hal = { version = "0.2.5", features = ["unproven"] }
 embedded-time = "0.12.0"
@@ -73,6 +73,7 @@ direct-call-deprecated = []
 ld = []
 rt = ["stm32f3/rt"]
 can = ["bxcan"]
+usb = ["stm32-usbd"]
 
 svd-f301 = ["stm32f3/stm32f301"]
 svd-f302 = ["stm32f3/stm32f302"]
@@ -170,7 +171,7 @@ required-features = ["ld", "stm32f303xc"]
 
 [[example]]
 name = "usb_serial"
-required-features = ["ld", "stm32f303xc", "stm32-usbd"]
+required-features = ["ld", "stm32f303xc", "usb"]
 
 [[example]]
 name = "spi"

src/lib.rs

@@ -76,10 +76,11 @@
  ### `can`
 
  Enable CAN peripherals on supported targets.
+ The can implementation of the interface is backed by  [`bxcan`](https://crates.io/crates/bxcan)
 
- ### `stm32-usbd`
+ ### `usb`
 
- Enable USB peripherals on supported targets.
+ Enable USB peripherals on supported targets via the [`stm32-usbd`](https://crates.io/crates/sttm32-usbd) crate.
 
  ### `enumset`
 
@@ -184,15 +185,15 @@ pub mod spi;
 pub mod syscfg;
 pub mod timer;
 #[cfg(all(
-    feature = "stm32-usbd",
+    feature = "usb",
     any(
         feature = "stm32f303xb",
         feature = "stm32f303xc",
         feature = "stm32f303xd",
         feature = "stm32f303xe",
     ),
 ))]
-#[cfg_attr(docsrs, doc(cfg(feature = "stm32-usbd")))]
+#[cfg_attr(docsrs, doc(cfg(feature = "usb")))]
 pub mod usb;
 pub mod watchdog;