refactor: remove -d for ros2 caret command

[bopeng-saitama]

Description

remove -d for ros2 caret command

Related links

Jira: https://tier4.atlassian.net/browse/RT2-975

Notes for reviewers

Pre-review checklist for the PR author

• I've confirmed the contribution guidelines.
• The PR is ready for review.

In-review checklist for the PR reviewers

The PR reviewers must check the checkboxes below before approval.

• The PR has been properly tested.
• The PR has been reviewed.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

• There are no open discussions or they are tracked via tickets.
• The PR is ready for merge.

After all checkboxes are checked, anyone who has write access can merge the PR.

[rokamu623]

LGTM

and it worked fine.

[xygyo77]

The following four commands were checked before and after the application of PR.

• ros2 caret check_ctf
• ros2 caret node_summary
• ros2 caret topic_summary
• ros2 caret trace_point_summary

pr129-result.tar.gz

[takeshi-iwanari]

According to the original discussion, any unnecessary -? should be removed.
So, I think -w in check_caret_rclcpp and -f in create_architecture_file should be also removed.

@nabetetsu
Could you confirm if we remove them or not?

[nabetetsu]

@takeshi-iwanari I agree with removing unnecessary options. But -f option in create_architecture_file should not be removed because it is used for overwriting the output file as optional action.

[takeshi-iwanari]

But -f option in create_architecture_file should not be removed because it is used for overwriting the output file as optional action.

Oops, it's my bad. I fixed my original comment.

[nabetetsu]

Here is the all list of caret command, and code blocks are options that should be removed.

$ ros2 caret check_caret_rclcpp --help
usage: ros2 caret check_caret_rclcpp [-h] -w WORKSPACE

options:
-h, --help show this help message and exit
-w WORKSPACE, --workspace WORKSPACE
the path to the workspace to be checked

$ ros2 caret check_ctf --help
usage: ros2 caret check_ctf [-h] -d TRACE_DIR

options:
-h, --help show this help message and exit
-d TRACE_DIR, --trace_dir TRACE_DIR
the path to the trace directory to be checked

$ ros2 caret create_architecture_file -h
usage: ros2 caret create_architecture_file [-h] [-o OUTPUT_PATH] [-f] trace_dir

positional arguments:
trace_dir the path to the main trace directory

options:
-h, --help show this help message and exit
-o OUTPUT_PATH, --output_path OUTPUT_PATH
the path to the output architecture file
-f, --force allow overwrite of architecture file

$ ros2 caret node_summary -h
usage: ros2 caret node_summary [-h] -d TRACE_DIR [--duration_filter D_FILTER_ARGS [D_FILTER_ARGS ...]] [--strip_filter S_FILTER_ARGS [S_FILTER_ARGS ...]] [-c]

options:
-h, --help show this help message and exit
-d TRACE_DIR, --trace_dir TRACE_DIR
the path to the trace directory
--duration_filter D_FILTER_ARGS [D_FILTER_ARGS ...]
Load only this duration from the offset. arg 1: duration [s], arg 2: offset [s].
--strip_filter S_FILTER_ARGS [S_FILTER_ARGS ...]
Ignore trace data for specified seconds from start/end. arg 1: left split [s], arg 2: right split [s].
-c, --display_check display the error checks to the trace results.

$ ros2 caret record -h
usage: ros2 caret record [-h] [-s SESSION_NAME] [-p PATH] [-l] [-v] [-f RECORDING_FREQUENCY] [--light] [--subbuffer-size-ust SUBBUFFER_SIZE_UST] [--subbuffer-size-kernel SUBBUFFER_SIZE_KERNEL] [--immediate] [-c]

options:
-h, --help show this help message and exit
-s SESSION_NAME, --session-name SESSION_NAME
the name of the tracing session (default: session-YYYYMMDDHHMMSS)
-p PATH, --path PATH path of the base directory for trace data (default: $ROS_TRACE_DIR if ROS_TRACE_DIR is set and not empty, or $ROS_HOME/tracing, using ~/.ros for ROS_HOME if not set or if empty)
-l, --list display lists of enabled events and context names (default: False)
-v, --verbose display status of recording
-f RECORDING_FREQUENCY, --recording-frequency RECORDING_FREQUENCY
recording frequency for Initialization-related trace points (default: 100Hz). Higher frequencies allow recording in a shorter time. However, the possibility of recording failure increases.
--light light mode (record high level events only)
--subbuffer-size-ust SUBBUFFER_SIZE_UST
the size of the subbuffers for userspace events(default: 84096). buffer size must be power of two. available in iron or rolling only.
--subbuffer-size-kernel SUBBUFFER_SIZE_KERNEL
the size of the subbuffers for kernel events(default: 324096). buffer size must be power of two. available in iron or rolling only.
--immediate record immediately.
-c, --record-clock launch the node where the /clock topic is stored to use ROS time.

$ ros2 caret topic_summary -h
usage: ros2 caret topic_summary [-h] -d TRACE_DIR [--duration_filter D_FILTER_ARGS [D_FILTER_ARGS ...]] [--strip_filter S_FILTER_ARGS [S_FILTER_ARGS ...]] [-c]

options:
-h, --help show this help message and exit
-d TRACE_DIR, --trace_dir TRACE_DIR
the path to the trace directory
--duration_filter D_FILTER_ARGS [D_FILTER_ARGS ...]
Load only this duration from the offset. arg 1: duration [s], arg 2: offset [s].
--strip_filter S_FILTER_ARGS [S_FILTER_ARGS ...]
Ignore trace data for specified seconds from start/end. arg 1: left split [s], arg 2: right split [s].
-c, --display_check display the error checks to the trace results.

$ ros2 caret trace_point_summary -h
usage: ros2 caret trace_point_summary [-h] -d TRACE_DIR [--duration_filter D_FILTER_ARGS [D_FILTER_ARGS ...]] [--strip_filter S_FILTER_ARGS [S_FILTER_ARGS ...]] [-c]

options:
-h, --help show this help message and exit
-d TRACE_DIR, --trace_dir TRACE_DIR
the path to the trace directory
--duration_filter D_FILTER_ARGS [D_FILTER_ARGS ...]
Load only this duration from the offset. arg 1: duration [s], arg 2: offset [s].
--strip_filter S_FILTER_ARGS [S_FILTER_ARGS ...]
Ignore trace data for specified seconds from start/end. arg 1: left split [s], arg 2: right split [s].
-c, --display_check display the error checks to the trace results.

$ ros2 caret verify_paths -h
usage: ros2 caret verify_paths [-h] [-p VERIFIED_PATH_NAMES [VERIFIED_PATH_NAMES ...]] arch_path

positional arguments:
arch_path the path to the architecture file

options:
-h, --help show this help message and exit
-p VERIFIED_PATH_NAMES [VERIFIED_PATH_NAMES ...], --verified_path_names VERIFIED_PATH_NAMES [VERIFIED_PATH_NAMES ...]
path names to be verified.

$ ros2 caret version
v0.4.18

[nabetetsu]

Sorry for too long list, but I think that if -w option in check_caret_rclcpp is removed as @takeshi-iwanari mentioned, all unnecessary option is removed.

[bopeng-saitama]

According to the original discussion, any unnecessary -? should be removed. So, I think -w in check_caret_rclcpp and -f in create_architecture_file should be also removed.

@nabetetsu Could you confirm if we remove them or not?

fixed in bf20e5e

[takeshi-iwanari]

Thank you for taking care of it!

[rokamu623]

LGTM!

and it works fine: