Add comment on why timestamping is enabled in zenoh configs

Signed-off-by: Yadunund <[email protected]>
ros2 · Jan 24, 2024 · 34f2623 · 34f2623
1 parent cd02957
commit 34f2623
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/rmw_zenoh_cpp/config/DEFAULT_RMW_ZENOH_ROUTER_CONFIG.json5 b/rmw_zenoh_cpp/config/DEFAULT_RMW_ZENOH_ROUTER_CONFIG.json5
@@ -69,6 +69,8 @@
   timestamping: {
     /// Whether data messages should be timestamped if not already.
     /// Accepts a single boolean value or different values for router, peer and client.
+    /// PublicationCache which is required for transient_local durability
+    /// only works when time-stamping is enabled.
     enabled: { router: true, peer: true, client: false },
     /// Whether data messages with timestamps in the future should be dropped or not.
     /// If set to false (default), messages with timestamps in the future are retimestamped.

diff --git a/rmw_zenoh_cpp/config/DEFAULT_RMW_ZENOH_SESSION_CONFIG.json5 b/rmw_zenoh_cpp/config/DEFAULT_RMW_ZENOH_SESSION_CONFIG.json5
@@ -69,6 +69,8 @@
   timestamping: {
     /// Whether data messages should be timestamped if not already.
     /// Accepts a single boolean value or different values for router, peer and client.
+    /// PublicationCache which is required for transient_local durability
+    /// only works when time-stamping is enabled.
     enabled: { router: true, peer: true, client: false },
     /// Whether data messages with timestamps in the future should be dropped or not.
     /// If set to false (default), messages with timestamps in the future are retimestamped.