Skip to content

Commit 01d14ee

Browse files
7903870: add info about return codes (exit codes) to man page
Reviewed-by: iris
1 parent de5bb5a commit 01d14ee

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/share/doc/apidiff.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,18 @@ pairwise, with each of the older instances being compared against the newest ins
240240
one or more files that contain arguments for the `apidiff` command. This lets you create
241241
`apidiff` commands of any length on any operating system.
242242

243+
## Exit Status
244+
245+
`apidiff` exits with one of the following values:
246+
247+
| Exit status | Description |
248+
|:-----------:|:-------------------------------------------------|
249+
| 0 | No differences were found |
250+
| 1 | Differences were found |
251+
| 2 | There was an error in the command-line arguments |
252+
| 3 | An error occurred |
253+
254+
The `--help` and `--version` options exit with a status of 0.
243255

244256
## The Current API
245257

0 commit comments

Comments
 (0)