Merge #333

333: deprecate free in favour of release r=therealprof a=burrbull



Co-authored-by: Andrey Zgarbul <zgarbul.andrey@gmail.com>

Author: bors[bot]

CHANGELOG.md

@@ -39,6 +39,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+- Deprecate `free` in favour of `release`
 - Clean features in `serial`
 - Internal implementation of GPIO Pin API changed to use Const Generics
 - Update the sdio driver to match the changes in the PAC

src/crc32.rs

@@ -117,8 +117,12 @@ impl Crc32 {
         self.periph.dr.read().bits()
     }
 
-    /// Consume the HAL peripheral, returning the PAC peripheral
+    #[deprecated(since = "0.10.0", note = "Please use release instead")]
     pub fn free(self) -> CRC {
+        self.release()
+    }
+    /// Consume the HAL peripheral, returning the PAC peripheral
+    pub fn release(self) -> CRC {
         unsafe {
             // NOTE(unsafe) this reference will only be used for atomic writes with no side effects.
             let rcc = &(*RCC::ptr());

src/delay.rs

@@ -21,8 +21,13 @@ impl Delay {
         Delay { clocks, syst }
     }
 
-    /// Releases the system timer (SysTick) resource
+    #[deprecated(since = "0.10.0", note = "Please use release instead")]
     pub fn free(self) -> SYST {
+        self.release()
+    }
+
+    /// Releases the system timer (SysTick) resource
+    pub fn release(self) -> SYST {
         self.syst
     }
 }

src/dma/mod.rs

@@ -1301,8 +1301,12 @@ where
         self.stream.disable()
     }
 
+    #[deprecated(since = "0.10.0", note = "Please use release instead")]
+    pub fn free(self) -> (STREAM, PERIPHERAL, BUF, Option<BUF>) {
+        self.release()
+    }
     /// Stops the stream and returns the underlying resources.
-    pub fn free(mut self) -> (STREAM, PERIPHERAL, BUF, Option<BUF>) {
+    pub fn release(mut self) -> (STREAM, PERIPHERAL, BUF, Option<BUF>) {
         self.stream.disable();
         compiler_fence(Ordering::SeqCst);
         self.stream.clear_interrupts();

src/spi.rs

@@ -714,6 +714,11 @@ where
         self.spi.sr.read().ovr().bit_is_set()
     }
 
+    pub fn release(self) -> (SPI, PINS) {
+        (self.spi, self.pins)
+    }
+
+    #[deprecated(since = "0.10.0", note = "Please use release instead")]
     pub fn free(self) -> (SPI, PINS) {
         (self.spi, self.pins)
     }