SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 11:55:40 +01:00
Code Issues Releases Activity Actions

Adds explanation of type returns of individual checkers to csaf_checker.md (#215)

Browse source 
Co-authored-by: Jan Höfelmeyer <Jan Höfelmeyer jhoefelmeyer@intevation.de>
This commit is contained in:
JanHoefelmeyer 2022-07-11 12:30:57 +02:00 • committed by GitHub
parent 73e216eccc
commit 15f05fc122
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/csaf_checker.md
View file

@ -22,3 +22,12 @@ Help Options:
Usage example:
` ./csaf_checker example.com -f html --rate=5.3 -o check-results.html`
Each performed check has a return type of either 0,1 or 2:
```
type 0: success
type 1: warning
type 2: error
```
The checker result is a success if no checks resulted in type 2, and a failure otherwise.