From 94bca61491e04645d5083fa7cce84100b0d15169 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Wed, 12 Jan 2022 11:16:42 +0100 Subject: [PATCH] Docs: be a little more explicit about emergency mode --- src/modules/README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/modules/README.md b/src/modules/README.md index 09696e66b..97a8556a1 100644 --- a/src/modules/README.md +++ b/src/modules/README.md @@ -67,7 +67,7 @@ Note that process modules are not recommended. Module descriptors **may** have the following keys: - *emergency* (a boolean value, set to true to mark the module - as an emergency module) + as an emergency module; see the section *Emergency Modules*, below) - *noconfig* (a boolean value, set to true to state that the module has no configuration file; defaults to false) - *requiredModules* (a list of modules which are required for this module @@ -102,8 +102,14 @@ to generate a suitable `module.desc`. For Python modules, manually add A module that is marked as an emergency module in its module.desc must **also** set the *emergency* key to *true* in its configuration file (see below). If it does not, the module is not considered to be an emergency -module after all (this is so that you can have modules that have several -instances, only some of which are actually needed for emergencies). +module after all. This is so that you can have modules that have several +instances, only some of which are actually needed for emergencies. + +In summary: +- in `module.desc`, write `emergency: true` to make it **possible** to + run the module in emergency mode, +- in `.conf`, write `emergency: true` to make that specific + module run in emergency mode. ### Module-specific configuration @@ -112,6 +118,10 @@ named `.conf`. If such a file is present in the module's directory, it can be shipped as a *default* configuration file. This only happens if the CMake-time option `INSTALL_CONFIG` is on. +The name of the configuration file for a given module can be +influenced by the `settings.conf` of the overall Calamares configuration. +By default, though, the module's own name is used. + Modules that have *noconfig* set to true will not attempt to read a configuration file, and will not warn that one is missing; conversely if *noconfig* is set to false (or is missing, since