Skip to content

Conversation

@scottbooker
Copy link
Collaborator

This pull request primarily improves usability and documentation for the rmp-eval tool, clarifies command-line options, and adds new functionality for configuration-only checks. The README has been expanded with a comprehensive FAQ and updated option descriptions, while the main program now supports a new --only-config mode and validates option combinations to prevent user error.

Documentation improvements:

  • Expanded the README.md with a detailed FAQ section explaining the sender/receiver threads, recommended CPU configuration, latency categories, PREEMPT_RT requirements, and more, making it easier for users to understand and correctly use the tool.
  • Updated command-line option descriptions in README.md to include default values and clarify the behavior of each option, including the new --only-config flag.
  • Added usage instructions for the new configuration-only mode to the README.md.

Command-line interface enhancements:

  • Added the --only-config (-oc) option to the argument parser in source/main.cpp, allowing users to run only system configuration checks without performing timing tests.
  • Updated argument descriptions in source/main.cpp to include default values for greater clarity.

Robustness and error handling:

  • Implemented validation in source/main.cpp to prevent using --no-config and --only-config together, displaying an error and exiting if both are specified. Also, the program now exits immediately after configuration checks when --only-config is used.

Version update:

  • Bumped the micro version from 0.0.2 to 0.0.3 in include/version.h to reflect these feature and documentation improvements.

@scottbooker scottbooker requested a review from Copilot November 4, 2025 18:33
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new --only-config command-line option to allow users to run system configuration checks without starting timing tests, and enhances help text for existing options to document default values. It also bumps the version to 0.0.3.

  • Added --only-config flag to run configuration checks only and exit
  • Enhanced help text for all command-line options to show default values
  • Added extensive FAQ section in README documenting tool usage and RMP integration

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
source/main.cpp Implements --only-config flag, adds mutual exclusion check with --no-config, and enhances argument descriptions with default values
include/version.h Bumps version from 0.0.2 to 0.0.3
README.md Updates usage examples with new flag, adds default values to options list, and adds comprehensive FAQ section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

scottbooker and others added 2 commits November 4, 2025 13:39
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@scottbooker scottbooker requested a review from SRNemoto November 4, 2025 18:40
@scottbooker scottbooker merged commit 567faca into roboticsys:main Nov 4, 2025
8 checks passed
@scottbooker scottbooker deleted the only-config branch November 4, 2025 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants