package dkml-install

  1. Overview
  2. Docs
API and registry for DkML installation components

Install

Dune Dependency

Authors

Maintainers

Sources

dkml-install-0.5.2.tbz
md5=5b294da54e4474f8d260c7190fec8c85
sha512=33274eafb995b4ba9d1bdb05e63b466e621255155fe5c6df7f368b086e6658634eff07079a51c0501cd1ab6817ba637f3222a00e146b8c360e24b7488ca66b63

doc/dkml-install.api/Dkml_install_api/Forward_progress/Exit_code/index.html

Module Forward_progress.Exit_codeSource

A module for exit codes.

Sourcetype t =
  1. | Exit_transient_failure
  2. | Exit_unrecoverable_failure
  3. | Exit_restart_needed
  4. | Exit_reboot_needed
  5. | Exit_upgrade_required

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.

Sourceval show : t -> string

Pretty print as a string

Sourceval pp : Format.formatter -> t -> unit

Pretty print on the formatter

Sourceval values : t list

All the possible exit codes

Sourceval to_int_exitcode : t -> int

An exitcode that can be supplied to exit

Sourceval to_short_sentence : t -> string

A short sentence like "A transient failure occurred."

OCaml

Innovation. Community. Security.