diff options
author | pennae <github@quasiparticle.net> | 2022-08-05 19:39:00 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2022-08-06 20:39:12 +0200 |
commit | 087472b1e5230ffc8ba642b1e4f9218adf4634a2 (patch) | |
tree | ba5c8e457072dce9aa13a92f26bb7e6a47d45776 /nixos/modules/security | |
parent | 423545fe4865d126e86721ba30da116e29c65004 (diff) |
nixos/*: automatically convert option docs
Diffstat (limited to 'nixos/modules/security')
-rw-r--r-- | nixos/modules/security/acme/default.nix | 4 | ||||
-rw-r--r-- | nixos/modules/security/apparmor.nix | 10 | ||||
-rw-r--r-- | nixos/modules/security/pam.nix | 16 | ||||
-rw-r--r-- | nixos/modules/security/systemd-confinement.nix | 16 |
4 files changed, 23 insertions, 23 deletions
diff --git a/nixos/modules/security/acme/default.nix b/nixos/modules/security/acme/default.nix index f4f2a669ceb83..1df6d9eba9535 100644 --- a/nixos/modules/security/acme/default.nix +++ b/nixos/modules/security/acme/default.nix @@ -451,9 +451,9 @@ let renewInterval = mkOption { type = types.str; inherit (defaultAndText "renewInterval" "daily") default defaultText; - description = '' + description = lib.mdDoc '' Systemd calendar expression when to check for renewal. See - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>. + {manpage}`systemd.time(7)`. ''; }; diff --git a/nixos/modules/security/apparmor.nix b/nixos/modules/security/apparmor.nix index be1b0362fc131..c4eca45325452 100644 --- a/nixos/modules/security/apparmor.nix +++ b/nixos/modules/security/apparmor.nix @@ -42,7 +42,7 @@ in if you want this service to do such killing by sending a <literal>SIGTERM</literal> to those running processes''; policies = mkOption { - description = '' + description = lib.mdDoc '' AppArmor policies. ''; type = types.attrsOf (types.submodule ({ name, config, ... }: { @@ -50,7 +50,7 @@ in enable = mkDisableOption "loading of the profile into the kernel"; enforce = mkDisableOption "enforcing of the policy or only complain in the logs"; profile = mkOption { - description = "The policy of the profile."; + description = lib.mdDoc "The policy of the profile."; type = types.lines; apply = pkgs.writeText name; }; @@ -61,16 +61,16 @@ in includes = mkOption { type = types.attrsOf types.lines; default = {}; - description = '' + description = lib.mdDoc '' List of paths to be added to AppArmor's searched paths - when resolving <literal>include</literal> directives. + when resolving `include` directives. ''; apply = mapAttrs pkgs.writeText; }; packages = mkOption { type = types.listOf types.package; default = []; - description = "List of packages to be added to AppArmor's include path"; + description = lib.mdDoc "List of packages to be added to AppArmor's include path"; }; enableCache = mkEnableOption '' caching of AppArmor policies diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 86fa5db6ca50d..9a1acba00d0ea 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -836,14 +836,14 @@ in control = mkOption { default = "sufficient"; type = types.enum [ "required" "requisite" "sufficient" "optional" ]; - description = '' + description = lib.mdDoc '' This option sets pam "control". If you want to have multi factor authentication, use "required". If you want to use the PKCS#11 device instead of the regular password, use "sufficient". Read - <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`pam.conf(5)` for better understanding of this option. ''; }; @@ -924,13 +924,13 @@ in control = mkOption { default = "sufficient"; type = types.enum [ "required" "requisite" "sufficient" "optional" ]; - description = '' + description = lib.mdDoc '' This option sets pam "control". If you want to have multi factor authentication, use "required". If you want to use U2F device instead of regular password, use "sufficient". Read - <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`pam.conf(5)` for better understanding of this option. ''; }; @@ -1039,14 +1039,14 @@ in control = mkOption { default = "sufficient"; type = types.enum [ "required" "requisite" "sufficient" "optional" ]; - description = '' + description = lib.mdDoc '' This option sets pam "control". If you want to have multi factor authentication, use "required". If you want to use the SSH certificate instead of the regular password, use "sufficient". Read - <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`pam.conf(5)` for better understanding of this option. ''; }; @@ -1071,13 +1071,13 @@ in control = mkOption { default = "sufficient"; type = types.enum [ "required" "requisite" "sufficient" "optional" ]; - description = '' + description = lib.mdDoc '' This option sets pam "control". If you want to have multi factor authentication, use "required". If you want to use Yubikey instead of regular password, use "sufficient". Read - <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + {manpage}`pam.conf(5)` for better understanding of this option. ''; }; diff --git a/nixos/modules/security/systemd-confinement.nix b/nixos/modules/security/systemd-confinement.nix index b058eed42c4ba..f5ed3d281a5fb 100644 --- a/nixos/modules/security/systemd-confinement.nix +++ b/nixos/modules/security/systemd-confinement.nix @@ -10,10 +10,10 @@ in { options.confinement.enable = lib.mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If set, all the required runtime store paths for this service are - bind-mounted into a <literal>tmpfs</literal>-based - <citerefentry><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>. + bind-mounted into a `tmpfs`-based + {manpage}`chroot(2)`. ''; }; @@ -61,13 +61,13 @@ in { default = toplevelConfig.environment.binsh; defaultText = lib.literalExpression "config.environment.binsh"; example = lib.literalExpression ''"''${pkgs.dash}/bin/dash"''; - description = '' - The program to make available as <filename>/bin/sh</filename> inside - the chroot. If this is set to <literal>null</literal>, no - <filename>/bin/sh</filename> is provided at all. + description = lib.mdDoc '' + The program to make available as {file}`/bin/sh` inside + the chroot. If this is set to `null`, no + {file}`/bin/sh` is provided at all. This is useful for some applications, which for example use the - <citerefentry><refentrytitle>system</refentrytitle><manvolnum>3</manvolnum></citerefentry> library function to execute commands. + {manpage}`system(3)` library function to execute commands. ''; }; |