calamares/src/modules/contextualprocess/contextualprocess.conf

# Configuration for the contextual process job.
#
# Contextual processes are based on **global** configuration values.
# When a given global value (string) equals a given value, then
# the associated command is executed.
#
# The special configuration key *dontChroot* specifies whether
# the commands are run in the target system (default, value *false*),
# or in the host system. This key is not used for comparisons
# with global configuration values.
#
# Configuration consists of keys for global variable names (except
# *dontChroot*), and the sub-keys are strings to compare to the
# variable's value. If the variable has that particular value, the
# corresponding value (script) is executed.
#
# You can check for an empty value with "".
#
# Global configuration variables are not checked in a deterministic
# order, so do not rely on commands from one variable-check to
# always happen before (or after) checks on another
# variable. Similarly, the value-equality checks are not
# done in a deterministic order, but all of the value-checks
# for a given variable happen together.
#
# The values after a value sub-keys are the same kinds of values
# as can be given to the *script* key in the shellprocess module.
# See shellprocess.conf for documentation on valid values.
---
dontChroot: false
firmwareType:
    efi:
        -   "-pkg remove efi-firmware"
        -   "-mkinitramfsrd -abgn"
    bios:   "-pkg remove bios-firmware"
    "":     "/bin/false no-firmware-type-set"
[contextualprocess] Stub of a contextual-process job This is meant to run one or more jobs based on specific global configuration values; if could also be done by a Python module with just some if's, but this one can be used with just the config file and covers a bunch of use-cases. 2017-12-20 15:12:27 +01:00			`# Configuration for the contextual process job.`
			`#`
			`# Contextual processes are based on global configuration values.`
			`# When a given global value (string) equals a given value, then`
			`# the associated command is executed.`
			`#`
[contextualprocess] Implement contextual processes Allow running one or more commands based on the value of a global configuration variable. This could, of course, be done in a Python module with some custom code, but for simple cases this is more straightforward to configure through module instances. Uses the CommandList developed for the ShellProcess module to do the actual work. FIXES #874 2018-01-15 14:57:34 +01:00			`# The special configuration key dontChroot specifies whether`
			`# the commands are run in the target system (default, value false),`
			`# or in the host system. This key is not used for comparisons`
			`# with global configuration values.`
			`#`
[contextualprocess] Document command lists - Show that a command list is also allowed, not just a single command. Refer to shellprocess for more documentation. 2018-01-29 15:49:21 +01:00			`# Configuration consists of keys for global variable names (except`
			`# dontChroot), and the sub-keys are strings to compare to the`
			`# variable's value. If the variable has that particular value, the`
			`# corresponding value (script) is executed.`
			`#`
			`# You can check for an empty value with "".`
			`#`
[contextualprocess] Implement contextual processes Allow running one or more commands based on the value of a global configuration variable. This could, of course, be done in a Python module with some custom code, but for simple cases this is more straightforward to configure through module instances. Uses the CommandList developed for the ShellProcess module to do the actual work. FIXES #874 2018-01-15 14:57:34 +01:00			`# Global configuration variables are not checked in a deterministic`
			`# order, so do not rely on commands from one variable-check to`
			`# always happen before (or after) checks on another`
			`# variable. Similarly, the value-equality checks are not`
			`# done in a deterministic order, but all of the value-checks`
			`# for a given variable happen together.`
			`#`
FIXUP document 2018-01-29 20:59:58 +01:00			`# The values after a value sub-keys are the same kinds of values`
			`# as can be given to the script key in the shellprocess module.`
			`# See shellprocess.conf for documentation on valid values.`
[contextualprocess] Stub of a contextual-process job This is meant to run one or more jobs based on specific global configuration values; if could also be done by a Python module with just some if's, but this one can be used with just the config file and covers a bunch of use-cases. 2017-12-20 15:12:27 +01:00			`---`
[contextualprocess] Implement contextual processes Allow running one or more commands based on the value of a global configuration variable. This could, of course, be done in a Python module with some custom code, but for simple cases this is more straightforward to configure through module instances. Uses the CommandList developed for the ShellProcess module to do the actual work. FIXES #874 2018-01-15 14:57:34 +01:00			`dontChroot: false`
[contextualprocess] Stub of a contextual-process job This is meant to run one or more jobs based on specific global configuration values; if could also be done by a Python module with just some if's, but this one can be used with just the config file and covers a bunch of use-cases. 2017-12-20 15:12:27 +01:00			`firmwareType:`
[contextualprocess] Document command lists - Show that a command list is also allowed, not just a single command. Refer to shellprocess for more documentation. 2018-01-29 15:49:21 +01:00			`efi:`
			`- "-pkg remove efi-firmware"`
			`- "-mkinitramfsrd -abgn"`
[contextualprocess] Stub of a contextual-process job This is meant to run one or more jobs based on specific global configuration values; if could also be done by a Python module with just some if's, but this one can be used with just the config file and covers a bunch of use-cases. 2017-12-20 15:12:27 +01:00			`bios: "-pkg remove bios-firmware"`
[contextualprocess] Implement contextual processes Allow running one or more commands based on the value of a global configuration variable. This could, of course, be done in a Python module with some custom code, but for simple cases this is more straightforward to configure through module instances. Uses the CommandList developed for the ShellProcess module to do the actual work. FIXES #874 2018-01-15 14:57:34 +01:00			`"": "/bin/false no-firmware-type-set"`