nix-community/nix-on-droid
1
0
Fork 0
mirror of https://github.com/nix-community/nix-on-droid.git synced 2025-12-03 15:41:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

activation: add VERBOSE env var in option description

Browse source
This commit is contained in:
Tobias Happ 2021-12-14 20:06:18 +01:00
parent b446b6572e
commit 38241f6363
1 changed files with 26 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

47
modules/build/activation.nix
View file

@ -46,6 +46,29 @@ let
${mkActivationCmds cfg.activation} ${mkActivationCmds cfg.activation}
${mkActivationCmds cfg.activationAfter} ${mkActivationCmds cfg.activationAfter}
''; '';
activationOptionDescriptionSuffix = ''
</para><para>
Any script should respect the <varname>DRY_RUN</varname>
variable, if it is set then no actual action should be taken.
The variable <varname>DRY_RUN_CMD</varname> is set to
<code>echo</code> if dry run is enabled. Thus, many cases you
can use the idiom <code>$DRY_RUN_CMD rm -rf /</code>.
</para><para>
Any script block should also respect the
<varname>VERBOSE</varname> variable, and if set print
information on standard out that may be useful for debugging
any issue that may arise. The variable
<varname>VERBOSE_ARG</varname> is set to
<option>--verbose</option> if verbose output is enabled.
The variable <varname>VERBOSE_ECHO</varname> is set to
<code>echo</code> if verbose output is enabled, otherwise
falling back to <code>true</code>. So it can be used like
<code>$VERBOSE_ECHO "any message"</code>.
'';
in in
{ {
@ -60,13 +83,7 @@ in
type = types.attrs; type = types.attrs;
description = '' description = ''
Activation scripts for the nix-on-droid environment. Activation scripts for the nix-on-droid environment.
</para><para> '' + activationOptionDescriptionSuffix;
Any script should respect the <varname>DRY_RUN</varname>
variable, if it is set then no actual action should be taken.
The variable <varname>DRY_RUN_CMD</varname> is set to
<code>echo</code> if dry run is enabled. Thus, many cases you
can use the idiom <code>$DRY_RUN_CMD rm -rf /</code>.
'';
}; };
activationBefore = mkOption { activationBefore = mkOption {
@ -75,13 +92,7 @@ in
description = '' description = ''
Activation scripts for the nix-on-droid environment that Activation scripts for the nix-on-droid environment that
need to be run first. need to be run first.
</para><para> '' + activationOptionDescriptionSuffix;
Any script should respect the <varname>DRY_RUN</varname>
variable, if it is set then no actual action should be taken.
The variable <varname>DRY_RUN_CMD</varname> is set to
<code>echo</code> if dry run is enabled. Thus, many cases you
can use the idiom <code>$DRY_RUN_CMD rm -rf /</code>.
'';
}; };
activationAfter = mkOption { activationAfter = mkOption {
@ -90,13 +101,7 @@ in
description = '' description = ''
Activation scripts for the nix-on-droid environment that Activation scripts for the nix-on-droid environment that
need to be run last. need to be run last.
</para><para> '' + activationOptionDescriptionSuffix;
Any script should respect the <varname>DRY_RUN</varname>
variable, if it is set then no actual action should be taken.
The variable <varname>DRY_RUN_CMD</varname> is set to
<code>echo</code> if dry run is enabled. Thus, many cases you
can use the idiom <code>$DRY_RUN_CMD rm -rf /</code>.
'';
}; };
activationPackage = mkOption { activationPackage = mkOption {