From 2fdf799ee1969b82c122761f5892404ca7a5a758 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Mon, 11 Mar 2019 16:59:00 -0400 Subject: [PATCH] Docs: document the requiredModules descriptor key --- src/modules/README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/modules/README.md b/src/modules/README.md index 2f0790863..cb5414a6e 100644 --- a/src/modules/README.md +++ b/src/modules/README.md @@ -51,11 +51,20 @@ Module descriptors **must** have the following keys: refer to the kinds of modules by their interface) Module descriptors **may** have the following keys: -- *required* **unimplemented** (a list of modules which are required for this module +- *requiredModules* (a list of modules which are required for this module to operate properly) - *emergency* (a boolean value, set to true to mark the module as an emergency module) +### Required Modules + +A module may list zero (if it has no requirements) or more modules +by name. As modules are loaded from the global sequence in `settings.conf`, +each module is checked that all of the modules it requires are +already loaded before it. This ensures that if a module needs +another one to fill in globalstorage keys, that happens before +it needs those keys. + ### Emergency Modules Only C++ modules and job modules may be emergency modules. If, during an