[Design] Update record parameters (#1483)

* [Design] Update record parameters Signed-off-by: Barry Xu <[email protected]> * Revise document regarding the misunderstood part. Signed-off-by: Barry Xu <[email protected]> --------- Signed-off-by: Barry Xu <[email protected]>
ros2 · Oct 18, 2023 · 8216ea2 · 8216ea2
1 parent a80adfd
commit 8216ea2
Showing 1 changed file with 11 additions and 6 deletions.
diff --git a/docs/design/rosbag2_record_replay_service.md b/docs/design/rosbag2_record_replay_service.md
@@ -32,7 +32,7 @@ The following criteria will be used to determine a service event topic:
 
 ### Expand the 'record' command
 
-Add 5 parameters.
+Added or changed parameters:
 
 - `--services ServiceName1 [ServiceName2 ...]`
 
@@ -46,13 +46,17 @@ Add 5 parameters.
 
     Record all service event topics.
 
+- `--exclude-regex`
+
+    Rename from `--exclude`.  Exclude topics and services containing provided regular expression.
+
 - `--exclude-topics`
 
-    Rename from `--exclude`. Exclude topics containing provided regular expression.
+    List of topics not being recorded.
 
 - `--exclude-services`
 
-    Exclude services containing provided regular expression.
+    List of services not being recorded.
 
 The description of the relevant parameter behavior.
 
@@ -63,9 +67,10 @@ The description of the relevant parameter behavior.
 | --all-topics | Record all topics. Hidden topics including service event topics are excluded. |
 | --all-services | Only record all service event topics. |
 | --include-hidden-topics | Record all hidden topics. Include service event topic. |
-| --exclude-topics | Exclude topics containing provided regular expression. |
-| --exclude-services | Exclude services containing provided regular expression. |
-| -e REGEX, --regex REGEX | Record only topics and service containing provided regular expression. |
+| --exclude-regex | Exclude topics and services containing provided regular expression. |
+| --exclude-topics | List of topics not being recorded. |
+| --exclude-services | List of services not being recorded. |
+| -e REGEX, --exclude-regex REGEX | Record only topics and service containing provided regular expression. |
 
 ### Change output of 'Info' command