Skip to content

Commit 5b530ed

Browse files
committed
docs: more details on exit codes
1 parent 63249e9 commit 5b530ed

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -154,15 +154,17 @@ Available formatting steps:
154154
155155
Possible exit codes:
156156
0 Successful formatting.
157-
In APPLY mode, this means all files were formatted.
158-
In CHECK mode, this means all files are already formatted properly.
159-
1 Some files need formatting.
157+
In APPLY mode, this means all files were formatted successfully.
158+
In CHECK mode, this means all files were already formatted properly.
159+
1 Some files need to be formatted.
160160
In APPLY mode, this means some files failed to be formatted (see output
161161
for details).
162-
In CHECK mode, this means some files are not formatted properly (and
163-
might be fixed in APPLY mode).
162+
In CHECK mode, this means some files are currently not formatted
163+
properly (and might be fixed in APPLY mode).
164164
-1 Some files did not converge. This can happen when one formatter does not
165165
converge on the file content.
166+
You can find more about this special case here:
167+
<https://github.com/diffplug/spotless/blob/main/PADDEDCELL.md>
166168
-2 An exception occurred during execution.
167169
```
168170

app/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,16 @@
7373
exitCodeList = {
7474
"""
7575
0:Successful formatting.
76-
In @|yellow APPLY|@ mode, this means all files were formatted.
77-
In @|yellow CHECK|@ mode, this means all files are already formatted properly.""",
76+
In @|yellow APPLY|@ mode, this means all files were formatted successfully.
77+
In @|yellow CHECK|@ mode, this means all files were already formatted properly.""",
7878
"""
79-
1:Some files need formatting.
79+
1:Some files need to be formatted.
8080
In @|yellow APPLY|@ mode, this means some files failed to be formatted (see output for details).
81-
In @|yellow CHECK|@ mode, this means some files are not formatted properly (and might be fixed in APPLY mode).""",
82-
"-1:Some files did not converge. This can happen when one formatter does not converge on the file content.",
81+
In @|yellow CHECK|@ mode, this means some files are currently not formatted properly (and might be fixed in APPLY mode).""",
82+
"""
83+
-1:Some files did not converge. This can happen when one formatter does not converge on the file content.
84+
You can find more about this special case here:
85+
<https://github.com/diffplug/spotless/blob/main/PADDEDCELL.md>""",
8386
"-2:An exception occurred during execution."
8487
},
8588
subcommandsRepeatable = true,

0 commit comments

Comments
 (0)