diff options
| author | Emily <vcs@emily.moe> | 2023-07-23 04:50:08 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-23 04:50:08 +0100 |
| commit | ced9f58f874606f39a8dd301827e774e90707f10 (patch) | |
| tree | 5a89c5a5fd77d04c80b273a1642a8f7ed6a5a441 /modules | |
| parent | 531c3de7eccf95155828e0cd9f18c25e7f937777 (diff) | |
| parent | 5fd8914dac6ba43ea650fadec35344f20ce50544 (diff) | |
Merge pull request #743 from emilazy/fix-enable-option-docs
treewide: fix `mkEnableOption` docs
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/homebrew.nix | 3 | ||||
| -rw-r--r-- | modules/security/pam.nix | 23 | ||||
| -rw-r--r-- | modules/services/synergy/default.nix | 6 |
3 files changed, 18 insertions, 14 deletions
diff --git a/modules/homebrew.nix b/modules/homebrew.nix index 4951d7f..05d86b9 100644 --- a/modules/homebrew.nix +++ b/modules/homebrew.nix @@ -536,8 +536,7 @@ in [](#opt-homebrew.onActivation). This module also provides a few options for modifying how Homebrew commands behave when - you manually invoke them, under [](#opt-homebrew.global) - ''); + you manually invoke them, under [](#opt-homebrew.global)''); brewPrefix = mkOption { type = types.str; 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 = { diff --git a/modules/services/synergy/default.nix b/modules/services/synergy/default.nix index 95daf37..9933fe6 100644 --- a/modules/services/synergy/default.nix +++ b/modules/services/synergy/default.nix @@ -54,8 +54,7 @@ in Using this requires a TLS certificate that can be generated by starting the Synergy GUI once and entering - a valid product key. - ''); + a valid product key''); cert = mkOption { type = types.nullOr types.str; default = null; @@ -102,8 +101,7 @@ in Using this requires a TLS certificate that can be generated by starting the Synergy GUI once and entering - a valid product key. - ''); + a valid product key''); cert = mkOption { type = types.nullOr types.str; default = null; |