tweag/ormolu
1
1
Fork 0
mirror of https://github.com/tweag/ormolu.git synced 2024-09-11 21:27:46 +03:00
Code Issues Projects Releases Wiki Activity

Add explanations for the exit codes to the readme

Browse Source
This commit is contained in:
Mark Karpov 2020-11-14 16:51:34 +01:00
parent 93bef509ca
commit 90a894e19f
No known key found for this signature in database
GPG Key ID: 8564658B2889FF7C
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -119,6 +119,22 @@ source code must still be parseable even when the disabled regions are
omitted. Because of that the magic comments cannot be placed arbitrarily,
but rather must enclose independent top-level definitions.
## Exit codes
Exit code | Meaning
----------|-----------------------------------------------
0 | Success
1 | General problem
2 | CPP used (deprecated)
3 | Parsing of original input failed
4 | Parsing of formatted code failed
5 | AST of original and formatted code differs
6 | Formatting is not idempotent
7 | Unrecognized GHC options
100 | In checking mode: unformatted files
101 | Inplace and check modes do not work with stdin
102 | Other issue (with multiple input files)
## Current limitations
* CPP support is experimental. CPP is virtually impossible to handle