From d1f162f92afb93278ecf521707f2b0e24f757e5e Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Tue, 21 Jan 2020 18:31:13 +0100 Subject: [PATCH] Docs: describe *noconfig* module option --- src/modules/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/src/modules/README.md b/src/modules/README.md index 5a7a16f37..2a9ef64c7 100644 --- a/src/modules/README.md +++ b/src/modules/README.md @@ -54,10 +54,12 @@ Module descriptors for Python and PythonQt modules **must** have the following k - *script* (the name of the Python script to load, nearly always `main.py`) Module descriptors **may** have the following keys: -- *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) +- *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 + to operate properly) ### Required Modules @@ -96,6 +98,12 @@ 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. +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 +the default value is false) if there is no configuration file, +a warning is printed during Calamares start-up. + The sample configuration files may work and may be suitable for your distribution, but no guarantee is given about their stability beyond syntactic correctness. @@ -122,7 +130,8 @@ to provide jobs. To add a Qt plugin module, put it in a subdirectory and make sure it has a `CMakeLists.txt` with a `calamares_add_plugin` call. It will be picked -up automatically by our CMake magic. The `module.desc` file is optional. +up automatically by our CMake magic. The `module.desc` file is not recommended: +nearly all cases can be described in CMake.