1
0
Fork 0
mirror of https://github.com/LnL7/nix-darwin.git synced 2025-03-05 08:17:01 +00:00

Merge pull request #743 from emilazy/fix-enable-option-docs

treewide: fix `mkEnableOption` docs
This commit is contained in:
Emily 2023-07-23 04:50:08 +01:00 committed by GitHub
commit ced9f58f87
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 14 deletions

View file

@ -536,8 +536,7 @@ in
[](#opt-homebrew.onActivation). [](#opt-homebrew.onActivation).
This module also provides a few options for modifying how Homebrew commands behave when 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 { brewPrefix = mkOption {
type = types.str; type = types.str;

View file

@ -39,17 +39,24 @@ in
{ {
options = { options = {
security.pam.enableSudoTouchIdAuth = mkEnableOption (lib.mdDoc '' security.pam.enableSudoTouchIdAuth = mkEnableOption "" // {
Enable sudo authentication with Touch ID 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 ::: {.note}
authentication with Touch ID won't work after a system update until the nix-darwin macOS resets this file when doing a system update. As such, sudo
configuration is reapplied.) authentication with Touch ID won't work after a system update
''); until the nix-darwin configuration is reapplied.
:::
'';
};
}; };
config = { config = {

View file

@ -54,8 +54,7 @@ in
Using this requires a TLS certificate that can be Using this requires a TLS certificate that can be
generated by starting the Synergy GUI once and entering generated by starting the Synergy GUI once and entering
a valid product key. a valid product key'');
'');
cert = mkOption { cert = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
@ -102,8 +101,7 @@ in
Using this requires a TLS certificate that can be Using this requires a TLS certificate that can be
generated by starting the Synergy GUI once and entering generated by starting the Synergy GUI once and entering
a valid product key. a valid product key'');
'');
cert = mkOption { cert = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;