diff options
| author | Emily <vcs@emily.moe> | 2023-07-21 09:15:33 +0100 |
|---|---|---|
| committer | Emily <vcs@emily.moe> | 2023-07-21 21:17:59 +0100 |
| commit | 5fd8914dac6ba43ea650fadec35344f20ce50544 (patch) | |
| tree | ae6981fa855940bb6ca0a38cd76f66840690f01e /modules/security | |
| parent | 61662a63bfe1726588c1da6b412df86d8ca94d63 (diff) | |
treewide: fix `mkEnableOption` docs
`mkEnableOption` wraps its argument in a complete sentence with a
terminating full stop; an additional newline will add an incorrect
space before the end of the sentence in the rendered documentation,
and any additional verbiage that doesn't fit into the form "Whether to
enable [...]." is also incorrect. In the latter case, the description
can be overridden manually.
Diffstat (limited to 'modules/security')
| -rw-r--r-- | modules/security/pam.nix | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/modules/security/pam.nix b/modules/security/pam.nix index 0061fba..f0c77dc 100644 --- a/modules/security/pam.nix +++ b/modules/security/pam.nix @@ -39,17 +39,24 @@ in { options = { - security.pam.enableSudoTouchIdAuth = mkEnableOption (lib.mdDoc '' - Enable sudo authentication with Touch ID + security.pam.enableSudoTouchIdAuth = mkEnableOption "" // { + description = lib.mdDoc '' + Enable sudo authentication with Touch ID. - When enabled, this option adds the following line to /etc/pam.d/sudo: + When enabled, this option adds the following line to + {file}`/etc/pam.d/sudo`: - auth sufficient pam_tid.so + ``` + auth sufficient pam_tid.so + ``` - (Note that macOS resets this file when doing a system update. As such, sudo - authentication with Touch ID won't work after a system update until the nix-darwin - configuration is reapplied.) - ''); + ::: {.note} + macOS resets this file when doing a system update. As such, sudo + authentication with Touch ID won't work after a system update + until the nix-darwin configuration is reapplied. + ::: + ''; + }; }; config = { |