Skip to content

Commit fd60907

Browse files
authored
Merge pull request #275 from lexming/exit-codes
add granular exit codes to the enhacements of easybuild v5
2 parents 013a817 + 28aa303 commit fd60907

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/easybuild-v5/enhancements.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,23 @@
55
Various significant enhancements are included in EasyBuild v5.0, including:
66

77
* [`run_shell_cmd` function][run_shell_cmd]
8+
* [Granular exit codes][granular_exit_codes]
89

910
---
1011

1112
## `run_shell_cmd` function { : #run_shell_cmd }
1213

1314
See dedicated page on the new [`run_shell_cmd` function](run_shell_cmd.md).
1415

16+
## Granular exit codes { : #granular_exit_codes }
17+
18+
EasyBuild v5 now uses a range of ~50 exit codes instead of just 0 for normal
19+
termination and 1 for unexpected termination. Each non-zero exit code
20+
correlates to the specific type of error or failure that caused the
21+
termination of the program. For instance, a missing easyconfig or a failed
22+
checksum check. The full list of exit codes is defined in the class
23+
[easybuild.tools.build_log.EasyBuildExit](https://github.com/easybuilders/easybuild-framework/blob/main/easybuild/tools/build_log.py#L74).
24+
25+
EasyBuild will always return its own exit codes on termination. Other exit
26+
codes from external processes executed through `run_shell_cmd` or HTTP response
27+
status codes are reported in the corresponding logs.

0 commit comments

Comments
 (0)