Document exit codes in man page.

This commit is contained in:
Vidar Holen 2015-10-10 19:19:38 -07:00
parent 55692926b9
commit 3b36c2c820
2 changed files with 10 additions and 2 deletions

View File

@ -159,6 +159,16 @@ The environment variable `SHELLCHECK_OPTS` can be set with default flags:
Its value will be split on spaces and prepended to the command line on each Its value will be split on spaces and prepended to the command line on each
invocation. invocation.
# RETURN VALUES
ShellCheck uses the follow exit codes:
+ 0: All files successfully scanned with no issues.
+ 1: All files successfully scanned with some issues.
+ 2: Some files could not be processed (e.g. file not found).
+ 3: ShellCheck was invoked with bad syntax (e.g. unknown flag).
+ 4: ShellCheck was invoked with bad options (e.g. unknown formatter).
# AUTHOR # AUTHOR
ShellCheck is written and maintained by Vidar Holen. ShellCheck is written and maintained by Vidar Holen.

View File

@ -48,7 +48,6 @@ data Flag = Flag String String
data Status = data Status =
NoProblems NoProblems
| SomeProblems | SomeProblems
| BadInput
| SupportFailure | SupportFailure
| SyntaxFailure | SyntaxFailure
| RuntimeException | RuntimeException
@ -144,7 +143,6 @@ statusToCode status =
case status of case status of
NoProblems -> ExitSuccess NoProblems -> ExitSuccess
SomeProblems -> ExitFailure 1 SomeProblems -> ExitFailure 1
BadInput -> ExitFailure 5
SyntaxFailure -> ExitFailure 3 SyntaxFailure -> ExitFailure 3
SupportFailure -> ExitFailure 4 SupportFailure -> ExitFailure 4
RuntimeException -> ExitFailure 2 RuntimeException -> ExitFailure 2