diff --git a/CHANGES-3.3 b/CHANGES-3.3 index c0c6993a6..214c5b013 100644 --- a/CHANGES-3.3 +++ b/CHANGES-3.3 @@ -19,8 +19,11 @@ This release contains contributions from (alphabetically by first name): - nothing in particular ## Modules ## + - *contextualprocess* see *shellprocess*. - *mount* module now correctly mounts luks and luks2-encrypted swap. (thanks Victor) - *partition* avoids a crash with specific checkbox-presets. (thanks Evan) + - *shellprocess* now supports a *verbose* key (globally and per-command) which logs + command output line-by-line. - *users* module defaults password salt to *yescrypt*. (thanks Lorenzo) diff --git a/src/modules/shellprocess/shellprocess.conf b/src/modules/shellprocess/shellprocess.conf index 7c1cb8f53..97e662959 100644 --- a/src/modules/shellprocess/shellprocess.conf +++ b/src/modules/shellprocess/shellprocess.conf @@ -46,6 +46,12 @@ # - Setting a timeout of 3600 for a 1GB download is going to leave # the user in uncertainty for a loooong time. # +# The (global) verbosity of a command can be set to `true` or `false`. +# When set to `true`, command output is logged one line at a time. +# Otherwise the output is logged when the command completes. +# Line-at-a-time logging is appropriate for commands that take +# a long time to complete and produce their own (progress) output. +# # If a command starts with "-" (a single minus sign), then the # return value of the command following the - is ignored; otherwise, # a failing command will abort the installation. This is much like @@ -62,7 +68,8 @@ # a key *timeout* to set the timeout for this specific # command differently from the global setting. An optional # key *environment* is a list of strings to put into the -# environment of the command. +# environment of the command. An optional key *verbose* +# overrides the global *verbose* setting in this file. # # Using a single object is not generally useful because the same effect # can be obtained with a single string and a global timeout, except @@ -113,9 +120,11 @@ verbose: false # - "/bin/ls" # - "/usr/bin/true" -# Script may be a list of items (if the touch command fails, it is -# ignored; the slowloris command has a different timeout from the -# other commands in the list): +# Script may be a list of items +# - if the touch command fails, it is ignored +# - there is nothing special about the invocation of true +# - the slowloris command has a different timeout from the other commands +# - the echo command logs its output line-by-line script: - "-touch ${ROOT}/tmp/thingy" - "/usr/bin/true"