Commit b0b73b7e authored by Maxime Hubert's avatar Maxime Hubert
Browse files

Update documentation

parent bcea1fb2
Pipeline #138689 passed with stage
in 33 seconds
......@@ -2,9 +2,22 @@
## Description
Checks the structure of the directory after ActEV-system-setup is run. Checks for expected API contents, etc.
Checks the structure of the directory after ActEV-system-setup is run. Checks for global directory structure, expected API contents, and system outputs directory and integrity.
The `--strict` flag causes the command to throw an exception on an error. Otherwise only WARNING logs are displayed.
The command contains the following subcommands:
In order to succed:
* The repository contains the required sub-directories,
* The signatures of the .src.** functions have to remain unchanged,
* The container_outputs directory contains at least one system output,
* Each reported system output is different from the baseline's,
* Names of the directories inside `container_outputs/` start with a dataset name.
## Parameters
| Name | Id | Required | Definition |
|-----------|------------|---------|----------------------------|
| strict | --strict | False | Whether to throw an exception on an error. |
## Usage
......@@ -12,3 +25,8 @@ The command contains the following subcommands:
actev validate-system
```
Example:
```
actev validate-system --strict
```
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment