From 0f2bceb72f37eff9cdd90037f288cc15aa84fd22 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Mon, 26 Feb 2024 21:58:40 +0100 Subject: [PATCH] Docs: process jobmodules now expand variables --- src/modules/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/modules/README.md b/src/modules/README.md index bb2c9cc21..86aa4d726 100644 --- a/src/modules/README.md +++ b/src/modules/README.md @@ -497,7 +497,8 @@ LC_ALL and LANG to "C" for the called command. ## Process modules -Use of this kind of module is **not** recommended. +Use of this kind of module is **not** recommended. Use *shellprocess* +instead, which is more configurable. > Type: jobmodule > Interface: process @@ -506,10 +507,12 @@ A process jobmodule runs a (single) command. The interface is *process*, while the module type must be *job* or *jobmodule*. The module-descriptor key *command* should have a string as value, which is -passed to the shell -- remember to quote it properly. It is generally +passed to the shell -- remember to quote it properly in YAML. It is generally recommended to use a *shellprocess* job module instead (less configuration, easier to have multiple instances). There is no configuration outside -of the module-descriptor. +of the module-descriptor. The *command* undergoes Calamares variable- +expansion (e.g. replacing `${ROOT}` by the target of the installation). +See *shellprocess* documentation for details. Optional keys are *timeout* and *chroot*.