rosbag2
rosbag2 copied to clipboard
Make `ros2bag` CLI help text and descriptions plugin-agnostic
Description
Right now the help text for several arguments refers directly to sqlite3
-specific features, for example:
- This description of storage preset profiles: https://github.com/ros2/rosbag2/blob/rolling/ros2bag/ros2bag/verb/record.py#L151
- This description of storage options: https://github.com/ros2/rosbag2/blob/rolling/ros2bag/ros2bag/verb/record.py#L170
- This set of choices for storage preset profile: https://github.com/ros2/rosbag2/blob/19158f6debe25640507881f9a2c01cdb1fe4741b/ros2bag/ros2bag/verb/record.py#L149
This leads to an awkward experience for anyone using a non-SQLite3 storage plugin. The most pressing issue is that the storage profile preset validation in record.py
precludes any plugin author from creating storage preset profiles with names other than resilient
and none
.
Related Issues
Relates to #1116
Completion Criteria
Complete when:
- the
ros2 bag
CLI help text output either depends on the storage plugin selected, or points the user towards documentation specific to their storage plugin. - Plugin authors can define storage preset profiles other than "none" and "resilient".
Implementation Notes / Suggestions
Testing Notes / Suggestions
Manual testing should be sufficient for this change.
Might want to apply this to README as well, providing a sub-README in the storage plugin with its details - removing anything sqlite specific from main README
@james-rms @emersonknapp Can we close this issue as resolved in #1209 ?
Yes, resolved in #1209