1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00

Make documentation more explicit

This commit is contained in:
koplas 2025-01-07 12:23:40 +01:00
parent bc5d149f74
commit 8fc7f5bfad
No known key found for this signature in database

View file

@ -3,9 +3,11 @@
is a tool to validate local advisories files against the JSON Schema and an optional remote validator. is a tool to validate local advisories files against the JSON Schema and an optional remote validator.
### Exit codes ### Exit codes
If no fatal error occurs the program will exit with an exit code `n` with the following conditions: If no fatal error occurs the program will exit with an exit code `n` with the following conditions:
- `n == 0`: all valid - `n == 0`: all valid
- `(n & 1) > 0`: general error, see logs - `(n & 1) > 0`: a general error occurred, all other flags are unset (see logs for more information)
- `(n & 2) > 0`: schema validation failed - `(n & 2) > 0`: schema validation failed
- `(n & 4) > 0`: no remote validator configured - `(n & 4) > 0`: no remote validator configured
- `(n & 8) > 0`: failure in remote validation - `(n & 8) > 0`: failure in remote validation