Skip to content

Add ros-args help text #1587

@BlaineKTMO

Description

@BlaineKTMO

Description

A help flag to ros-args --ros-args --help / -h that prints out valid ros-args. This helps new + experienced users remember what the proper syntax is for remappings, parameters, etc!

Usage: ros2 <command> [options] [--ros-args <ROS args>]
Options:
  --help, -h                 Show this help message
  --param, -p NAME:=VALUE    Set parameter override
  --remap, -r FROM:=TO       Remap topic/service names
  --params-file FILE         Load parameters from file
  --log-level LEVEL          Set log verbosity
  --enclave NAME, -e NAME    Set security enclave
  --external-log-file PREFIX External log file name prefix

Motivation

When trying to use ros-args it can be hard to remember what the exact syntax/formatting is.

Design / Implementation Considerations

Argument parsing should be done in ros2/rcl. Rclpy and rclcpp will need to read the argument from the rcl api and handle printing the help text and proper termination.

Additional Information

This was mentioned in ros2/rcl#1270 and I'd be interested in tackling the issue as a new contributor.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions