diff options
| author | pennae <github@quasiparticle.net> | 2022-08-29 21:48:56 +0200 |
|---|---|---|
| committer | pennae <github@quasiparticle.net> | 2022-08-31 16:32:14 +0200 |
| commit | 1013069f52123135cc1d96b2b7d77606a22d3b33 (patch) | |
| tree | f985c37e7b051d769aefbaf179bbd5bcbb7e507d /nixos/modules/services/system | |
| parent | 7d102d113abd84dd29bed71cd589f1c68a7f7f3d (diff) | |
nixos/*: convert more partially-md option descriptions
this mostly means marking options that use markdown already appropriately and making a few adjustments so they still render correctly. notable for nftables we have to transform the md links because the manpage would not render them correctly otherwise.
Diffstat (limited to 'nixos/modules/services/system')
| -rw-r--r-- | nixos/modules/services/system/earlyoom.nix | 8 | ||||
| -rw-r--r-- | nixos/modules/services/system/systembus-notify.nix | 4 |
2 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/services/system/earlyoom.nix b/nixos/modules/services/system/earlyoom.nix index b2e2d21002ce1..7d9c58e540348 100644 --- a/nixos/modules/services/system/earlyoom.nix +++ b/nixos/modules/services/system/earlyoom.nix @@ -72,7 +72,7 @@ in enableNotifications = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Send notifications about killed processes via the system d-bus. WARNING: enabling this option (while convenient) should *not* be done on a @@ -80,10 +80,10 @@ in local user to DoS your session by spamming notifications. To actually see the notifications in your GUI session, you need to have - <literal>systembus-notify</literal> running as your user, which this - option handles by enabling <option>services.systembus-notify</option>. + `systembus-notify` running as your user, which this + option handles by enabling {option}`services.systembus-notify`. - See <link xlink:href="https://github.com/rfjakob/earlyoom#notifications">README</link> for details. + See [README](https://github.com/rfjakob/earlyoom#notifications) for details. ''; }; diff --git a/nixos/modules/services/system/systembus-notify.nix b/nixos/modules/services/system/systembus-notify.nix index e918bc552ece9..269197b3997e3 100644 --- a/nixos/modules/services/system/systembus-notify.nix +++ b/nixos/modules/services/system/systembus-notify.nix @@ -8,13 +8,13 @@ let in { options.services.systembus-notify = { - enable = mkEnableOption '' + enable = mkEnableOption (lib.mdDoc '' System bus notification support WARNING: enabling this option (while convenient) should *not* be done on a machine where you do not trust the other users as it allows any other local user to DoS your session by spamming notifications. - ''; + ''); }; config = mkIf cfg.enable { |