Mark Z_FEATURE_LINK_SERIAL_USB as unstable

eclipse-zenoh · Dec 6, 2024 · 5ac4d38 · 5ac4d38
1 parent c8f24ec
commit 5ac4d38
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -247,6 +247,12 @@ if(Z_FEATURE_LIVELINESS AND NOT Z_FEATURE_UNSTABLE_API)
   set(Z_FEATURE_LIVELINESS 0 CACHE STRING "Toggle liveliness feature" FORCE)
 endif()
 
+# Add a warning message if someone tries to enable Z_FEATURE_LINK_SERIAL_USB directly
+if(Z_FEATURE_LINK_SERIAL_USB AND NOT Z_FEATURE_UNSTABLE_API)
+  message(WARNING "Z_FEATURE_LINK_SERIAL_USB can only be enabled when Z_FEATURE_UNSTABLE_API is also enabled. Disabling Z_FEATURE_LINK_SERIAL_USB.")
+  set(Z_FEATURE_LINK_SERIAL_USB 0 CACHE STRING "Toggle Serial USB links" FORCE)
+endif()
+
 add_compile_definitions("Z_BUILD_DEBUG=$<CONFIG:Debug>")
 message(STATUS "Building with feature confing:\n\
 * UNSTABLE_API: ${Z_FEATURE_UNSTABLE_API}\n\

diff --git a/README.md b/README.md
@@ -399,6 +399,9 @@ Valid PIN combinations and associated device names:
 
 **USB Serial connection (experemental)**:
 
+
+To enable this feature, zenoh-pico should be compiled with `Z_FEATURE_LINK_SERIAL_USB` and `Z_FEATURE_UNSTABLE_API` enabled.
+
 To connect via USB CDC, specify `usb` device:
 
 e.g.
-Original file line number
+Diff line change
@@ Expand Up / @@ -399,6 +399,9 @@ Valid PIN combinations and associated device names: @@
     **USB Serial connection (experemental)**:
+    To enable this feature, zenoh-pico should be compiled with `Z_FEATURE_LINK_SERIAL_USB` and `Z_FEATURE_UNSTABLE_API` enabled.
     To connect via USB CDC, specify `usb` device:
     e.g.
@@ Expand Down @@