Docs: Update README.md for validation #1258
Open
+1,280
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KarolinaPomian
requested review from
Sakoram,
DawidWesierski4 and
Falron98
as code owners
Sakoram
reviewed
Sep 5, 2025
tests/validation/README.md
Outdated
Comment on lines
49
to
54
| ### Prerequisites | ||
|
|
||
| - Python 3.9 or higher | ||
| - Media Transport Library built and installed | ||
| - Network interfaces configured for testing | ||
| - Sufficient permissions for network management |
There was a problem hiding this comment.
- It is also necessary to have the files used as input data. We currently have them on NFS.
- What does it mean to have "Network interfaces configured for testing"? I guess you need to have to have everything done form MTL's run.md, but VF are created automatically.
- by "Sufficient permissions for network management" you mean you have to be root user? Is there any other option?
There was a problem hiding this comment.
- you need to install ffmpeg and gstreamer plugins to run some of the tests.
Sakoram
reviewed
Sep 8, 2025
| - **name**: Host identifier | ||
| - **instantiate**: Whether to instantiate the host | ||
| - **role**: Host role (e.g., sut for System Under Test) | ||
| - **network_interfaces**: List of network interfaces |
There was a problem hiding this comment.
can I specify device differently? I think there was an option to provide system name. How to do it?
There was a problem hiding this comment.
For that please refer to mfd documentation, there are many ways of specifying the device.
|
I don't understand the point of the commit message All this information is in the documentation itself. Adding the boilerplate above is useless |
DawidWesierski4
requested changes
Sep 8, 2025
There was a problem hiding this comment.
I generally don't think this is a good approach of adding documentation
we have doc folder why not put the documentation there?
this is the approach we were doing till now
although inconsistently (we have a README for gstreamer in gstreamer)
i still would prefer to have those in doc
refactored so that tere is a
quickstart ->
Then more detailed info
I don't think this provides enough clarity which was the whole point as it is
|
|
||
| - Creates test patterns in various formats | ||
| - Supports different resolutions and frame rates | ||
| - Configurable color patterns and test signals |
There was a problem hiding this comment.
mby adding usage here would be good ?
KarolinaPomian
force-pushed
the
readme-update-validation
branch
2 times, most recently
from
65cd2f0 to
a1f759f
Compare
Address GitHub review comment by: 1. Moving detailed documentation to doc/validation_framework.md 2. Simplifying tests/validation/README.md to be a quickstart guide 3. Adding a clear reference to the main documentation This follows the project's approach of keeping detailed documentation in the doc/ directory while providing a concise quickstart guide in the component's README.md.
- Add missing MTL build prerequisite - tests fail without RxTxApp binary - Clarify virtual environment setup path discrepancy - Improve configuration file examples with realistic values - Add comprehensive troubleshooting section for common new developer issues - Update both main validation_framework.md and tests/validation/README.md Fixes issues identified during new developer testing of validation framework documentation.
- Add critical warnings about placeholder values that must be updated - Add step-by-step setup instructions for both config files - Include commands to find PCI device IDs and verify SSH keys - Highlight required updates with warning symbols Addresses configuration confusion identified during new developer testing.
- Add interactive paths and clear directory requirements for all commands - Create validation_quickstart.md for rapid setup with step-by-step guide - Enhance validation_framework.md with root user requirements and device options - Add gen_frames.sh usage documentation with supported formats - Include specific test parameter examples and VF creation instructions - Update tests/validation/README.md with clickable config file links - Add comprehensive troubleshooting and multiple device specification methods - Improve documentation hierarchy following repository standards Addresses developer feedback for clearer setup instructions and eliminates common configuration issues that block new developers.
KarolinaPomian
commented
Sep 24, 2025
- Fix directory specification: clarify tests/validation/ must be current dir for pip install - Add gen_frames.sh usage details: specify directory and supported formats - Add interactive paths for test_config.yaml and topology_config.yaml - Add device specification options including system name method - Add comprehensive pytest parameter execution examples - Emphasize root user requirement more clearly throughout - Clean up duplicated device specification sections - Add clearer file location information for both config files
- Add clickable markdown links to test_config.yaml and topology_config.yaml - Include clear file location paths for easy navigation - Improve accessibility for developers navigating configuration files
- Remove duplicate 'Test Framework Structure' heading - Fix list indentation (use 0 spaces instead of 2) - Remove trailing spaces throughout documentation - Fix trailing punctuation in heading (remove colon) - Rename duplicate 'Setup Instructions' heading to 'Topology Setup Instructions' - Ensure consistent markdown formatting across all documentation files Resolves all MD024, MD007, MD009, and MD026 linting issues.
KarolinaPomian
force-pushed
the
readme-update-validation
branch
2 times, most recently
from
f42a439 to
298c449
Compare
…build instructions and troubleshooting tips
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What was documented?
Documentation was added covering the setup and usage instructions for the validation. A quickstart section and detailed information were added.
Why was the markdown added to the smoke ignore now?
The markdown file was added to the smoke ignore to prevent it from being included in automated tests or checks, since it contains only documentation and not executable code.