From 3b36c2c8208bd91ccd88eb872979e00f48dde27c Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Sat, 10 Oct 2015 19:19:38 -0700 Subject: [PATCH] Document exit codes in man page. --- shellcheck.1.md | 10 ++++++++++ shellcheck.hs | 2 -- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/shellcheck.1.md b/shellcheck.1.md index 22ac258..4d29c0e 100644 --- a/shellcheck.1.md +++ b/shellcheck.1.md @@ -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 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 ShellCheck is written and maintained by Vidar Holen. diff --git a/shellcheck.hs b/shellcheck.hs index 878e847..3f8888e 100644 --- a/shellcheck.hs +++ b/shellcheck.hs @@ -48,7 +48,6 @@ data Flag = Flag String String data Status = NoProblems | SomeProblems - | BadInput | SupportFailure | SyntaxFailure | RuntimeException @@ -144,7 +143,6 @@ statusToCode status = case status of NoProblems -> ExitSuccess SomeProblems -> ExitFailure 1 - BadInput -> ExitFailure 5 SyntaxFailure -> ExitFailure 3 SupportFailure -> ExitFailure 4 RuntimeException -> ExitFailure 2