doc: Add documentation for exit codes

Fixes: #351
coala · Apr 18, 2015 · f85d57b · sils · Apr 18, 2015 · sils
1 parent 8d4164b
commit f85d57b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/doc/Getting_Involved/Exit_Codes.md b/doc/Getting_Involved/Exit_Codes.md
@@ -0,0 +1,15 @@
+# Exit Codes
+
+The following is a list of the exit codes and their meanings in the coala code:
+
+ * `0` - coala executed succesfully but yielded no results.
+ * `1` - coala executed succesfully but yielded results.
+ * `2` - Invalid arguments were passed to coala in the command line.
+ * `130` - A KeyboardInterrupt(Ctrl+C) was pressed during the execution of 
+   coala.
+ * `255` - The file collector exits with this code if an invalid patter is 
+   passed to it.
+ * `128` - Any other general errors.
+
+This list will be updated regularly as and when new exit codes are added to 
+coala.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -16,6 +16,7 @@ pages:
 - ['Getting_Involved/Writing_Commit_Messages.md',
    'Getting Involved',
    'Writing Commit Messages']
+- ['Getting_Involved/Exit_Codes.md', 'Getting Involved' ,'Exit Codes']
 - ['Getting_Involved/MAC_Hints.md', 'Getting Involved', 'MAC Hints']
 - ['General_Dev_Info/git_tutorial_1.md',
    'General Developer Information',