nixos/security: invariant option docs MD conversions

This commit is contained in:
pennae
2022-07-20 12:32:04 +02:00
parent da37ca6760
commit cbc44d68a7
2 changed files with 6 additions and 6 deletions

View File

@@ -11,11 +11,11 @@ with lib;
security.lockKernelModules = mkOption { security.lockKernelModules = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = '' description = lib.mdDoc ''
Disable kernel module loading once the system is fully initialised. Disable kernel module loading once the system is fully initialised.
Module loading is disabled until the next reboot. Problems caused Module loading is disabled until the next reboot. Problems caused
by delayed module loading can be fixed by adding the module(s) in by delayed module loading can be fixed by adding the module(s) in
question to <option>boot.kernelModules</option>. question to {option}`boot.kernelModules`.
''; '';
}; };
}; };

View File

@@ -29,7 +29,7 @@ in
if (subject.local) return "yes"; if (subject.local) return "yes";
}); });
''; '';
description = description = lib.mdDoc
'' ''
Any polkit rules to be added to config (in JavaScript ;-). See: Any polkit rules to be added to config (in JavaScript ;-). See:
http://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html#polkit-rules http://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html#polkit-rules
@@ -40,12 +40,12 @@ in
type = types.listOf types.str; type = types.listOf types.str;
default = [ "unix-group:wheel" ]; default = [ "unix-group:wheel" ];
example = [ "unix-user:alice" "unix-group:admin" ]; example = [ "unix-user:alice" "unix-group:admin" ];
description = description = lib.mdDoc
'' ''
Specifies which users are considered administrators, for those Specifies which users are considered administrators, for those
actions that require the user to authenticate as an actions that require the user to authenticate as an
administrator (i.e. have an <literal>auth_admin</literal> administrator (i.e. have an `auth_admin`
value). By default, this is all users in the <literal>wheel</literal> group. value). By default, this is all users in the `wheel` group.
''; '';
}; };