mirrors/nix-darwin
1
0
Fork 0
mirror of https://github.com/LnL7/nix-darwin.git synced 2024-12-15 17:51:01 +00:00
Code Activity

treewide: fix mkEnableOption docs

Browse source 
`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.
This commit is contained in:
Emily 2023-07-21 09:15:33 +01:00
parent 61662a63bf
commit 5fd8914dac
3 changed files with 18 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
modules/homebrew.nix
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;

23
modules/security/pam.nix
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 = {

6
modules/services/synergy/default.nix
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;