Add --only-config option, document default values in --help, add FAQ to README.md #4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request primarily improves usability and documentation for the
rmp-evaltool, 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-configmode and validates option combinations to prevent user error.Documentation improvements:
README.mdwith 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.README.mdto include default values and clarify the behavior of each option, including the new--only-configflag.README.md.Command-line interface enhancements:
--only-config(-oc) option to the argument parser insource/main.cpp, allowing users to run only system configuration checks without performing timing tests.source/main.cppto include default values for greater clarity.Robustness and error handling:
source/main.cppto prevent using--no-configand--only-configtogether, displaying an error and exiting if both are specified. Also, the program now exits immediately after configuration checks when--only-configis used.Version update:
include/version.hto reflect these feature and documentation improvements.