Skip to content

Commit 65cd2f0

Browse files
docs: fix markdown linting errors
- 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.
1 parent 59aa3b0 commit 65cd2f0

File tree

3 files changed

+18
-24
lines changed

3 files changed

+18
-24
lines changed

doc/validation_framework.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ The validation framework uses pytest to organize and execute tests across variou
1212

1313
The validation framework is organized into the following main components:
1414

15-
## Test Framework Structure
16-
17-
The validation framework is organized into the following main components:
18-
1915
- **common/**: Shared utilities for test functionality, including FFmpeg handlers, integrity verification tools, and network interface control
2016
- **configs/**: Configuration files for test environment and network topology
2117
- **mtl_engine/**: Core test framework components that manage test execution, application interfaces, and result reporting
@@ -70,13 +66,13 @@ Location: `tests/validation/configs/test_config.yaml`
7066
Defines the test execution environment:
7167

7268
**Key Parameters**:
73-
- **build**: Path to MTL build directory
74-
- **mtl_path**: Path to MTL installation directory
75-
- **media_path**: Path to test media files directory
76-
- **ramdisk.media.mountpoint**: Mount point for media RAM disk
77-
- **ramdisk.media.size_gib**: Size of media RAM disk in GiB
78-
- **ramdisk.pcap.mountpoint**: Mount point for packet capture RAM disk
79-
- **ramdisk.pcap.size_gib**: Size of packet capture RAM disk in GiB
69+
- **build**: Path to MTL build directory
70+
- **mtl_path**: Path to MTL installation directory
71+
- **media_path**: Path to test media files directory
72+
- **ramdisk.media.mountpoint**: Mount point for media RAM disk
73+
- **ramdisk.media.size_gib**: Size of media RAM disk in GiB
74+
- **ramdisk.pcap.mountpoint**: Mount point for packet capture RAM disk
75+
- **ramdisk.pcap.size_gib**: Size of packet capture RAM disk in GiB
8076

8177
#### [`topology_config.yaml`](../tests/validation/configs/topology_config.yaml)
8278

@@ -267,13 +263,11 @@ sudo ./script/nicctl.sh create_vf "0000:18:00.1" # Replace with your secondary
267263

268264
## Running Tests
269265

270-
> **⚠️ CRITICAL**: Tests must be run as **root user**, not regular user. MTL validation framework requires root privileges for network operations.
271-
272-
### Basic Test Execution
266+
> **⚠️ CRITICAL**: Tests must be run as **root user**, not regular user. MTL validation framework requires root privileges for network operations.### Basic Test Execution
273267

274268
**⚠️ CRITICAL**: All tests must be run as **root user**. Regular users will fail.
275269

276-
#### Run specific test with parameters:
270+
#### Run specific test with parameters
277271

278272
**Examples of running tests with specific parameters**:
279273
```bash

tests/validation/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The Media Transport Library (MTL) Validation Framework provides comprehensive testing capabilities for various aspects of the MTL, including protocol compliance, performance, and integration testing.
44

55
> **📖 For detailed documentation, please refer to [the main validation framework documentation](../../doc/validation_framework.md)**
6-
>
6+
>
77
> **🚀 Quick Start**: See [Validation Quick Start Guide](../../doc/validation_quickstart.md)
88
99
## Quick Setup

tests/validation/configs/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,21 @@ capture_cfg:
2525
capture_time: 5
2626
interface: null
2727
ramdisk:
28-
media:
28+
media:
2929
mountpoint: /mnt/ramdisk/media
3030
size_gib: 32
3131
pcap:
3232
mountpoint: /mnt/ramdisk/pcap
3333
size_gib: 768
3434
```
3535
36-
#### Key Parameters
36+
### Key Parameters
3737
3838
- **build**: Path to the Media Transport Library build directory
39-
- **mtl_path**: Path to the Media Transport Library installation
39+
- **mtl_path**: Path to the Media Transport Library installation
4040
- **media_path**: Path to the directory containing test media files
4141
42-
#### ⚠️ Setup Instructions
42+
### ⚠️ Setup Instructions
4343
4444
1. **Replace `MTL_PATH_PLACEHOLDER`** with your actual MTL installation path:
4545
```bash
@@ -56,7 +56,7 @@ ramdisk:
5656
ls /path/to/your/media/files/
5757
```
5858

59-
#### Other Parameters
59+
### Other Parameters
6060
- **capture_cfg**: Network packet capture configuration
6161
- **enable**: Enable/disable packet capture
6262
- **test_name**: Name prefix for capture files
@@ -96,7 +96,7 @@ hosts:
9696
key_path: KEY_PATH_PLACEHOLDER # ⚠️ UPDATE: Path to your SSH key
9797
```
9898

99-
#### ⚠️ Setup Instructions
99+
### Topology Setup Instructions
100100

101101
1. **Find your PCI device ID**:
102102
```bash
@@ -120,7 +120,7 @@ hosts:
120120
# If missing, generate one: ssh-keygen -t rsa -b 4096
121121
```
122122

123-
#### Topology Parameters
123+
### Topology Parameters
124124

125125
- **metadata.version**: Configuration format version
126126
- **hosts**: List of hosts in the test topology
@@ -166,7 +166,7 @@ def test_with_custom_config(config):
166166
# Override configuration for this test
167167
config.capture_cfg.enable = True
168168
config.capture_cfg.interface = "enp1s0f0"
169-
169+
170170
# Run test with modified configuration
171171
# ...
172172
```

0 commit comments

Comments
 (0)