napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: document the requiredModules descriptor key

Browse Source
This commit is contained in:
Adriaan de Groot 2019-03-11 16:59:00 -04:00
parent eab36a098f
commit 2fdf799ee1
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/modules/README.md
View File

@ -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