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

Docs: process jobmodules now expand variables

Browse Source
This commit is contained in:
Adriaan de Groot 2024-02-26 21:58:40 +01:00
parent 2697c35fc7
commit 0f2bceb72f
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/modules/README.md
View File

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