fixup! fixup! fixup! fixup! fixup! fixup! fixup! refactor(bench)!: mo…

…ve benchmarking facilities to their own crate

.github/workflows/main.yml

@@ -140,7 +140,7 @@ jobs:
 
       # TODO: we'll eventually want to enable relevant features
       - name: "rustdoc"
-        run: cargo rustdoc -p riot-rs --features no-boards -- -D warnings
+        run: cargo rustdoc -p riot-rs --features no-boards,bench -- -D warnings
 
       - name: rustfmt
         run: cargo fmt --check --all

examples/benchmark/Cargo.toml

@@ -7,5 +7,5 @@ edition = "2021"
 publish = false
 
 [dependencies]
-riot-rs = { path = "../../src/riot-rs", features = ["threading"] }
+riot-rs = { path = "../../src/riot-rs", features = ["bench", "threading"] }
 riot-rs-boards = { path = "../../src/riot-rs-boards" }

src/riot-rs-bench/src/lib.rs

@@ -10,7 +10,8 @@ cfg_if::cfg_if! {
         mod cortexm;
         use cortexm as bench;
     }
-    else if #[cfg(capability = "sw/benchmark")] {
+    else if #[cfg(context = "riot-rs")] {
+        // When run with laze but the architecture is not supported
         compile_error!("benchmarking is not supported for this architecture");
     } else {
         // Provide a default bench module, for arch-independent tooling

src/riot-rs/Cargo.toml

@@ -10,7 +10,7 @@ workspace = true
 [dependencies]
 document-features = { workspace = true }
 linkme = { workspace = true }
-riot-rs-bench = { workspace = true }
+riot-rs-bench = { workspace = true, optional = true }
 riot-rs-boards = { path = "../riot-rs-boards" }
 riot-rs-buildinfo = { path = "../riot-rs-buildinfo" }
 riot-rs-debug = { workspace = true }
@@ -75,6 +75,8 @@ wifi-esp = ["riot-rs-embassy/wifi-esp"]
 ## Enables the debug console, required to use
 ## [`println!`](riot_rs_debug::println).
 debug-console = ["riot-rs-rt/debug-console"]
+## Enables benchmarking facilities.
+bench = ["dep:riot-rs-bench"]
 ## Prints nothing in case of panics (may help reduce binary size).
 silent-panic = ["riot-rs-rt/silent-panic"]
 ## Allows to have no boards selected, useful to run target-independent tooling.

src/riot-rs/src/lib.rs

@@ -7,6 +7,8 @@
 #![no_std]
 #![feature(doc_cfg)]
 
+#[cfg(feature = "bench")]
+#[doc(cfg(feature = "bench"))]
 #[doc(inline)]
 pub use riot_rs_bench as bench;
 pub use riot_rs_buildinfo as buildinfo;

tests/benchmarks/bench_sched_yield/Cargo.toml

@@ -7,6 +7,7 @@ publish = false
 
 [dependencies]
 riot-rs = { workspace = true, default-features = true, features = [
+  "bench",
   "threading",
 ] }
 riot-rs-boards = { workspace = true }