docs(env-macros): add an extra param for documentation

future-proof-iot · Feb 29, 2024 · e1f3e6a · e1f3e6a
1 parent f45f85a
commit e1f3e6a
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/src/riot-rs-embassy/src/lib.rs b/src/riot-rs-embassy/src/lib.rs
@@ -158,8 +158,11 @@ async fn init_task(mut peripherals: arch::OptionalPeripherals) {
         use crate::sendcell::SendCell;
         use embassy_net::{Stack, StackResources};
 
-        const STACK_RESOURCES: usize =
-            riot_rs_utils::usize_from_env_or!("CONFIG_STACK_RESOURCES", 4);
+        const MAX_CONCURRENT_SOCKETS: usize = riot_rs_utils::usize_from_env_or!(
+            "CONFIG_NETWORK_MAX_CONCURRENT_SOCKETS",
+            4,
+            "maximum number of concurrent sockets allowed by the network stack"
+        );
 
         let config = network::config();
 
@@ -174,7 +177,7 @@ async fn init_task(mut peripherals: arch::OptionalPeripherals) {
         let stack = &*make_static!(Stack::new(
             device,
             config,
-            make_static!(StackResources::<STACK_RESOURCES>::new()),
+            make_static!(StackResources::<MAX_CONCURRENT_SOCKETS>::new()),
             seed
         ));
 

diff --git a/src/riot-rs-embassy/src/wifi/cyw43.rs b/src/riot-rs-embassy/src/wifi/cyw43.rs
@@ -12,8 +12,13 @@ use riot_rs_utils::str_from_env_or;
 use self::rpi_pico_w::{Cyw43Periphs, CywSpi, Irqs, CYW43_PWR};
 use crate::{arch::OptionalPeripherals, make_static};
 
-const WIFI_NETWORK: &str = str_from_env_or!("CONFIG_WIFI_NETWORK", "test_network");
-const WIFI_PASSWORD: &str = str_from_env_or!("CONFIG_WIFI_PASSWORD", "test_password");
+const WIFI_NETWORK: &str = str_from_env_or!(
+    "CONFIG_WIFI_NETWORK",
+    "test_network",
+    "Wi-Fi SSID (network name)"
+);
+const WIFI_PASSWORD: &str =
+    str_from_env_or!("CONFIG_WIFI_PASSWORD", "test_password", "Wi-Fi password");
 
 pub type NetworkDevice = cyw43::NetDriver<'static>;
 

diff --git a/src/riot-rs-rt/src/lib.rs b/src/riot-rs-rt/src/lib.rs
@@ -40,7 +40,8 @@ cfg_if::cfg_if! {
 
 pub use arch::benchmark;
 
-const ISR_STACKSIZE: usize = riot_rs_utils::usize_from_env_or!("CONFIG_ISR_STACKSIZE", 8192);
+const ISR_STACKSIZE: usize =
+    riot_rs_utils::usize_from_env_or!("CONFIG_ISR_STACKSIZE", 8192, "ISR stack size (in bytes)");
 
 #[link_section = ".isr_stack"]
 #[used(linker)]

diff --git a/src/riot-rs-utils/src/env.rs b/src/riot-rs-utils/src/env.rs
@@ -4,7 +4,8 @@ macro_rules! define_env_with_default_macro {
     ($macro_name:ident, $parse_fn_name:ident, $output_type_name:literal) => {
         #[macro_export]
         macro_rules! $macro_name {
-            ($env_var:literal, $default:expr) => {
+            // $doc is currently unused
+            ($env_var:literal, $default:expr, $doc:literal) => {
                 if let Some(str_value) = option_env!($env_var) {
                     if let Ok(value) = $crate::env::konst::primitive::$parse_fn_name(str_value) {
                         value
@@ -30,7 +31,8 @@ define_env_with_default_macro!(usize_from_env_or, parse_usize, "a usize");
 
 #[macro_export]
 macro_rules! str_from_env_or {
-    ($env_var:literal, $default:expr) => {
+    // $doc is currently unused
+    ($env_var:literal, $default:expr, $doc:literal) => {
         if let Some(str_value) = option_env!($env_var) {
             str_value
         } else {