From cbc44d68a75eb0273cd676728ef7989c70307c6b Mon Sep 17 00:00:00 2001 From: pennae Date: Wed, 20 Jul 2022 12:32:04 +0200 Subject: [PATCH] nixos/security: invariant option docs MD conversions --- nixos/modules/security/lock-kernel-modules.nix | 4 ++-- nixos/modules/security/polkit.nix | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/nixos/modules/security/lock-kernel-modules.nix b/nixos/modules/security/lock-kernel-modules.nix index 065587bc286e..674ba857818c 100644 --- a/nixos/modules/security/lock-kernel-modules.nix +++ b/nixos/modules/security/lock-kernel-modules.nix @@ -11,11 +11,11 @@ with lib; security.lockKernelModules = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Disable kernel module loading once the system is fully initialised. Module loading is disabled until the next reboot. Problems caused by delayed module loading can be fixed by adding the module(s) in - question to . + question to {option}`boot.kernelModules`. ''; }; }; diff --git a/nixos/modules/security/polkit.nix b/nixos/modules/security/polkit.nix index 1ba149745c65..0a2d81445ba5 100644 --- a/nixos/modules/security/polkit.nix +++ b/nixos/modules/security/polkit.nix @@ -29,7 +29,7 @@ in if (subject.local) return "yes"; }); ''; - description = + description = lib.mdDoc '' Any polkit rules to be added to config (in JavaScript ;-). See: http://www.freedesktop.org/software/polkit/docs/latest/polkit.8.html#polkit-rules @@ -40,12 +40,12 @@ in type = types.listOf types.str; default = [ "unix-group:wheel" ]; example = [ "unix-user:alice" "unix-group:admin" ]; - description = + description = lib.mdDoc '' Specifies which users are considered “administrators”, for those actions that require the user to authenticate as an - administrator (i.e. have an auth_admin - value). By default, this is all users in the wheel group. + administrator (i.e. have an `auth_admin` + value). By default, this is all users in the `wheel` group. ''; };