package dkml-install
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c975d7d8d193946e268722538621aa4f99acdfcd7ead6a72157a2db80b98cb28
sha512=f799d6f44486ca7a780bb8d9d976056548b37cdf5211dd7608c32d65e1766ae9f4e113c03cfcfb9d0ba546adaf20e1176bc5531f9a5ca8c6c04497e5c76ba991
doc/dkml-install.api/Dkml_install_api/Forward_progress/Exit_code/index.html
Module Forward_progress.Exit_code
Source
A module for exit codes.
The type of exit code.
Exit_unrecoverable_failure
is reserved for programmers error; basically assertions and unhandled exceptions that indicate the process cannot make forward progress, even if the process was restarted.
Exit_transient_failure
is for "normal" errors like I/O errors (not enough disk space, etc.), network errors, and the other errors that arise from Stdlib or 3rd party libraries giving a Result.t
or something similar.
Exit_restart_needed
is reserved for when a process requires itself to restart to make any forward progress. Typical use cases include re-initializing the process with updated configuration files.
Exit_reboot_needed
is reserved for when a process requires the machine to reboot to make any forward progress. Typical use cases include installations of system or widely-used shared libraries. You probably won't use it unless you write installers.
Exit_upgrade_required
is reserved for when a process or its dependencies (perhaps a kernel or system library) requires an upgrade to make any forward progress. Typical use cases include client software where old clients have been deprecated, and security-conscious software that requires patches to the machine before it will start up.
Pretty print on the formatter