Skip to content

Commit 873c57d

Browse files
Adjust documentation
Signed-off-by: ClemensLinnhoff <[email protected]>
1 parent ff35ca2 commit 873c57d

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

doc/usage.adoc

+8-3
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,16 @@ python rules2yml.py # Generates the rule directory
5959
osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi --rules rules -p
6060
----
6161

62-
The rules2yml.py generates yml files for all OSI proto files containing the rules specified in OSI.
63-
It also generated respective yml schema files to validate the rule yml files.
64-
The schema files are located in <rules_folder>/schema.
62+
The rules2yml.py generates a yml file for each OSI proto file containing the rules specified in OSI.
63+
The yml files are located in the specified rules folder given as an input parameter.
64+
Additionally, the script generates respective yml schema files to validate the rule yml files in <rules_folder>/schema.
65+
The schema files contain the message names of the original OSI proto file and a list of applicable rules.
66+
If a rule has an associated value, e.g. a string or a number, the type of the value is also checked.
6567
When executing osivalidator, all rule files are validated against their respective schema.
6668

69+
If needed, the rules folder can be copied and modified for specific use cases, e.g. by adding or removing certain rules.
70+
This way, osivalidation can be used with different sets of rules.
71+
6772
After successfully running the validation the following output is
6873
generated:
6974

osivalidator/osi_general_validator.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def command_line_arguments():
4646
parser.add_argument(
4747
"--rules",
4848
"-r",
49-
help="Directory with text files containig rules. ",
49+
help="Directory with yml files containing rules. ",
5050
default=os.path.join(dir_path, "rules"),
5151
type=str,
5252
)

0 commit comments

Comments
 (0)