NAME¶

check_compat - detect incompatible configurations in conf2 module YAML files

SYNOPSIS¶

check_compat -o OUTPUT_FILE [-h]

DESCRIPTION¶

This program scans conf2 module YAML files to identify incompatible configurations. It performs validation checks against conf2 module specifications and outputs detected issues to the specified results file.

OPTIONS¶

-h, --help

Show help message and exit

-o OUTPUT_FILE, --output OUTPUT_FILE

Specify output file path for validation results (required)

OPERATION¶

The program:

1.

Scans the current working directory and relevant system paths

2.

Identifies conf2 module YAML configuration files

3.

Validates configurations against compatibility rules

4.

Writes detected issues to the specified output file

OUTPUT FORMAT¶

The output file contains:

• List of incompatible configurations
• File paths where issues were detected
• Specific configuration keys causing incompatibilities
• Severity level for each issue

EXIT STATUS¶

0

Success (no incompatible configurations found)

1

Validation errors detected

2

Execution error (invalid parameters or system issues)

EXAMPLES¶

Basic usage:

check_compat -o validation_results.txt

Check exit status:

$ check_compat -o report.log
$ echo $?
1 # indicates issues found

SEE ALSO¶

conf2(1), yamllint(1)

DIAGNOSTICS¶

Output file will contain:

AUTHOR¶

UKUI Quality Assurance Team