public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

systemd: better document enabled, wantedBy, and requiredBy (#29453)

Browse Source 
the systemd.unit(5) discussion of wantedBy and requiredBy is in the
[Install] section, and thus focused on stateful 'systemctl enable'.
so, clarify that in NixOS, wantedBy & requiredBy are still what most
users want, and not to be confused with enabled.
This commit is contained in:
Matt McHenry 2017-09-16 06:48:16 -04:00 committed by Aristid Breitkreuz
parent 03fa6965ad
commit cfbac1beb4
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
nixos/modules/system/boot/systemd-unit-options.nix
View File

@ -35,21 +35,40 @@ in rec {
description = '' description = ''
If set to false, this unit will be a symlink to If set to false, this unit will be a symlink to
/dev/null. This is primarily useful to prevent specific /dev/null. This is primarily useful to prevent specific
template instances (e.g. <literal>serial-getty@ttyS0</literal>) template instances
from being started. (e.g. <literal>serial-getty@ttyS0</literal>) from being
started. Note that <literal>enable=true</literal> does not
make a unit start by default at boot; if you want that, see
<literal>wantedBy</literal>.
''; '';
}; };
requiredBy = mkOption { requiredBy = mkOption {
default = []; default = [];
type = types.listOf types.str; type = types.listOf types.str;
description = "Units that require (i.e. depend on and need to go down with) this unit."; description = ''
Units that require (i.e. depend on and need to go down with)
this unit. The discussion under <literal>wantedBy</literal>
applies here as well: inverse <literal>.requires</literal>
symlinks are established.
'';
}; };
wantedBy = mkOption { wantedBy = mkOption {
default = []; default = [];
type = types.listOf types.str; type = types.listOf types.str;
description = "Units that want (i.e. depend on) this unit."; description = ''
Units that want (i.e. depend on) this unit. The standard way
to make a unit start by default at boot is to set this option
to <literal>[ "multi-user.target" ]</literal>. That's despite
the fact that the systemd.unit(5) manpage says this option
goes in the <literal>[Install]</literal> section that controls
the behaviour of <literal>systemctl enable</literal>. Since
such a process is stateful and thus contrary to the design of
NixOS, setting this option instead causes the equivalent
inverse <literal>.wants</literal> symlink to be present,
establishing the same desired relationship in a stateless way.
'';
}; };
aliases = mkOption { aliases = mkOption {