Update versions for 0.5 (#20)

* Update versions for 0.5 Also fixes issue when embassy-executor/nightly features are active * Remove embassy-executor-nightly feature (#21) * Fixup docs links * Remove dead feature --------- Co-authored-by: Alexander van Saase <[email protected]>
jamesmunns · May 20, 2024 · a0f90f5 · a0f90f5
1 parent c5c5fb4
commit a0f90f5
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 20 deletions.
diff --git a/example/firmware/Cargo.lock b/example/firmware/Cargo.lock
diff --git a/example/firmware/Cargo.toml b/example/firmware/Cargo.toml
@@ -13,7 +13,7 @@ embassy-usb             = { version = "0.2.0", features = ["defmt"] }
 embedded-hal-bus        = { version = "0.1",   features = ["async"] }
 lis3dh-async            = { version = "0.9.2", features = ["defmt"] }
 panic-probe             = { version = "0.3",   features = ["print-defmt"] }
-postcard-rpc            = { version = "0.4",   features = ["embassy-usb-0_2-server"] }
+postcard-rpc            = { version = "0.5",   features = ["embassy-usb-0_2-server"] }
 postcard                = { version = "1.0.8", features = ["experimental-derive"] }
 portable-atomic         = { version = "1.6.0", features = ["critical-section"] }
 
@@ -38,6 +38,9 @@ codegen-units = 1
 incremental = false
 
 [patch.crates-io]
+# NOTE: Although embassy-usb has released 0.2, we still need to use patched deps for the other various crates
+# for now. See https://github.com/embassy-rs/embassy/issues/2936 for getting other min versions of these
+# crates published.
 embassy-embedded-hal = { git = "https://github.com/embassy-rs/embassy", rev = "763b57449fef31b2ca5205542e2c0a52e6b786c1" }
 embassy-executor     = { git = "https://github.com/embassy-rs/embassy", rev = "763b57449fef31b2ca5205542e2c0a52e6b786c1" }
 embassy-rp           = { git = "https://github.com/embassy-rs/embassy", rev = "763b57449fef31b2ca5205542e2c0a52e6b786c1" }

diff --git a/example/workbook-host/Cargo.lock b/example/workbook-host/Cargo.lock
diff --git a/example/workbook-host/Cargo.toml b/example/workbook-host/Cargo.toml
@@ -7,7 +7,7 @@ edition = "2021"
 path = "../workbook-icd"
 
 [dependencies.postcard-rpc]
-version = "0.4"
+version = "0.5"
 features = [
     "use-std",
     "raw-nusb",

diff --git a/example/workbook-icd/Cargo.lock b/example/workbook-icd/Cargo.lock
diff --git a/example/workbook-icd/Cargo.toml b/example/workbook-icd/Cargo.toml
@@ -13,7 +13,7 @@ version = "1.0"
 features = ["experimental-derive"]
 
 [dependencies.postcard-rpc]
-version = "0.4"
+version = "0.5"
 
 [patch.crates-io]
 postcard-rpc = { path = "../../source/postcard-rpc" }
diff --git a/source/postcard-rpc-test/Cargo.lock b/source/postcard-rpc-test/Cargo.lock
diff --git a/source/postcard-rpc/Cargo.toml b/source/postcard-rpc/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "postcard-rpc"
-version = "0.4.2"
+version = "0.5.0"
 authors = ["James Munns <[email protected]>"]
 edition = "2021"
 repository = "https://github.com/jamesmunns/postcard-rpc"
@@ -19,8 +19,15 @@ documentation = "https://docs.rs/postcard-rpc/"
 readme = "../../README.md"
 
 [package.metadata.docs.rs]
-all-features = true
 rustdoc-args = ["--cfg", "doc_cfg"]
+features = [
+    "test-utils",
+    "use-std",
+    "cobs-serial",
+    "raw-nusb",
+    "embassy-usb-0_2-server",
+    "_docs-fix",
+]
 
 [dependencies]
 cobs = { version = "0.2.3", optional = true, default-features = false }
@@ -78,6 +85,9 @@ optional = true
 version = "0.5"
 optional = true
 
+[dev-dependencies]
+postcard-rpc = { path = "../postcard-rpc", features = ["test-utils"] }
+
 #
 # Hack features (see below)
 #
@@ -87,9 +97,7 @@ optional = true
 features = ["std"]
 
 [features]
-default = [
-    # "embassy-usb-0_2-server",
-]
+default = []
 test-utils = [
     "use-std",
 ]
@@ -117,13 +125,9 @@ embassy-usb-0_2-server = [
 
 # NOTE: This exists because `embassy-usb` indirectly relies on ssmarshal
 # which doesn't work on `std` builds without the `std` feature. This causes
-# `cargo doc --all-features` (and docs.rs builds) to fail. Sneakily re-active
+# `cargo doc --all-features` (and docs.rs builds) to fail. Sneakily re-activate
 # that feature when `--all-features` is set. This feature is considered unstable
 # and should not be relied upon.
 _docs-fix = [
     "dep:ssmarshal",
 ]
-
-[patch.crates-io]
-embassy-usb = { git = "https://github.com/jamesmunns/embassy", rev = "0d0d8e14e2b0e81307ff70c5a31e300785da19f9" }
-embassy-usb-driver = { git = "https://github.com/jamesmunns/embassy", rev = "0d0d8e14e2b0e81307ff70c5a31e300785da19f9" }
diff --git a/source/postcard-rpc/src/accumulator.rs b/source/postcard-rpc/src/accumulator.rs
@@ -15,7 +15,6 @@ pub mod raw {
     }
 
     /// The result of feeding the accumulator.
-    #[cfg_attr(feature = "use-defmt", derive(defmt::Format))]
     pub enum FeedResult<'a, 'b> {
         /// Consumed all data, still pending.
         Consumed,

diff --git a/source/postcard-rpc/src/target_server/buffers.rs b/source/postcard-rpc/src/target_server/buffers.rs
@@ -16,7 +16,7 @@ impl<const EO: usize, const TX: usize, const RX: usize> AllBuffers<EO, TX, RX> {
     }
 }
 
-/// Buffers used by the [`UsbDevice`] of `embassy-usb`
+/// Buffers used by the [`UsbDevice`][embassy_usb::UsbDevice] of `embassy-usb`
 pub struct UsbDeviceBuffers {
     pub config_descriptor: [u8; 256],
     pub bos_descriptor: [u8; 256],

diff --git a/source/postcard-rpc/src/target_server/dispatch_macro.rs b/source/postcard-rpc/src/target_server/dispatch_macro.rs
@@ -195,6 +195,7 @@ macro_rules! define_dispatch {
 /// as well as provide impls for docs. Don't rely on any of this!
 #[doc(hidden)]
 #[allow(dead_code)]
+#[cfg(feature = "test-utils")]
 pub mod fake {
     use crate::target_server::SpawnContext;
     #[allow(unused_imports)]

diff --git a/source/postcard-rpc/src/target_server/mod.rs b/source/postcard-rpc/src/target_server/mod.rs
@@ -22,7 +22,7 @@ const DEVICE_INTERFACE_GUIDS: &[&str] = &["{AFB9A6FB-30BA-44BC-9232-806CFC875321
 
 /// A trait that defines the postcard-rpc message dispatching behavior
 ///
-/// This is normally generated automatically by the [`define_dispatch!()`]
+/// This is normally generated automatically by the [`define_dispatch!()`][crate::define_dispatch]
 /// macro.
 pub trait Dispatch {
     type Mutex: RawMutex;