Mirrors/yamllint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Explain strict mode return codes

Browse Source
This commit is contained in:
Jonathan Sokolowski
2016-10-24 14:15:23 +11:00
parent 03e0f5aa6b
commit bf386b3c90
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/configuration.rst
View File

@@ -102,8 +102,15 @@ Errors and warnings
------------------- -------------------
Problems detected by yamllint can be raised either as errors or as warnings. Problems detected by yamllint can be raised either as errors or as warnings.
The CLI will output them (with different colors when using the ``standard``
output format).
In both cases, the script will output them (with different colors when using the By default the script will exit will a return code ``1`` *only when* there is one or
``standard`` output format), but the exit code can be different. More precisely, more error(s).
the script will exit will a failure code *only when* there is one or more
error(s). However if strict mode is enabled with the ``-s`` (or ``--strict``) option, the
return code will be:
* ``0`` if no errors or warnings occur
* ``1`` if one or more errors occur
* ``2`` if no errors occur, but one or more warnings occur