diff options
author | Bjørn Forsman <bjorn.forsman@gmail.com> | 2023-10-18 14:08:30 +0200 |
---|---|---|
committer | Bjørn Forsman <bjorn.forsman@gmail.com> | 2024-04-09 07:10:17 +0200 |
commit | a29010fe79b07b603982d9e44c2a5face9dc9977 (patch) | |
tree | 41da467b5fd802349ea6ed927b7373b6606900f1 /nixos | |
parent | 34852ddf5e9203075805af70c3e556292c03ddb3 (diff) |
nixos: improve many 'enable' descriptions
Diffstat (limited to 'nixos')
108 files changed, 113 insertions, 111 deletions
diff --git a/nixos/modules/config/mysql.nix b/nixos/modules/config/mysql.nix index 4f72d22c4f0e..30741a9ad406 100644 --- a/nixos/modules/config/mysql.nix +++ b/nixos/modules/config/mysql.nix @@ -10,7 +10,7 @@ in options = { users.mysql = { - enable = mkEnableOption (lib.mdDoc "Authentication against a MySQL/MariaDB database"); + enable = mkEnableOption (lib.mdDoc "authentication against a MySQL/MariaDB database"); host = mkOption { type = types.str; example = "localhost"; diff --git a/nixos/modules/config/xdg/portals/wlr.nix b/nixos/modules/config/xdg/portals/wlr.nix index d84ae794e3bc..2274be9cc40a 100644 --- a/nixos/modules/config/xdg/portals/wlr.nix +++ b/nixos/modules/config/xdg/portals/wlr.nix @@ -15,7 +15,7 @@ in options.xdg.portal.wlr = { enable = mkEnableOption (lib.mdDoc '' - desktop portal for wlroots-based desktops + desktop portal for wlroots-based desktops. This will add the `xdg-desktop-portal-wlr` package into the {option}`xdg.portal.extraPortals` option, and provide the diff --git a/nixos/modules/hardware/ksm.nix b/nixos/modules/hardware/ksm.nix index 82d94e6ab57c..d3b2ae37f41b 100644 --- a/nixos/modules/hardware/ksm.nix +++ b/nixos/modules/hardware/ksm.nix @@ -11,7 +11,7 @@ in { ]; options.hardware.ksm = { - enable = mkEnableOption (lib.mdDoc "Kernel Same-Page Merging"); + enable = mkEnableOption (lib.mdDoc "Linux kernel Same-Page Merging"); sleep = mkOption { type = types.nullOr types.int; default = null; diff --git a/nixos/modules/hardware/logitech.nix b/nixos/modules/hardware/logitech.nix index 9b06eb8a8b01..cb1f9b585762 100644 --- a/nixos/modules/hardware/logitech.nix +++ b/nixos/modules/hardware/logitech.nix @@ -19,7 +19,7 @@ in options.hardware.logitech = { lcd = { - enable = mkEnableOption (lib.mdDoc "Logitech LCD Devices"); + enable = mkEnableOption (lib.mdDoc "support for Logitech LCD Devices"); startWhenNeeded = mkOption { type = types.bool; @@ -41,7 +41,7 @@ in }; wireless = { - enable = mkEnableOption (lib.mdDoc "Logitech Wireless Devices"); + enable = mkEnableOption (lib.mdDoc "support for Logitech Wireless Devices"); enableGraphical = mkOption { type = types.bool; diff --git a/nixos/modules/hardware/video/capture/mwprocapture.nix b/nixos/modules/hardware/video/capture/mwprocapture.nix index ddd3f3ec7f32..187f97c25d1b 100644 --- a/nixos/modules/hardware/video/capture/mwprocapture.nix +++ b/nixos/modules/hardware/video/capture/mwprocapture.nix @@ -12,7 +12,7 @@ in { - options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "Magewell Pro Capture family kernel module"); + options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "the Magewell Pro Capture family kernel module"); config = mkIf cfg.enable { diff --git a/nixos/modules/programs/appgate-sdp.nix b/nixos/modules/programs/appgate-sdp.nix index bdd538dc2f1f..5b958b686552 100644 --- a/nixos/modules/programs/appgate-sdp.nix +++ b/nixos/modules/programs/appgate-sdp.nix @@ -5,7 +5,7 @@ with lib; { options = { programs.appgate-sdp = { - enable = mkEnableOption (lib.mdDoc "AppGate SDP VPN client"); + enable = mkEnableOption (lib.mdDoc "the AppGate SDP VPN client"); }; }; diff --git a/nixos/modules/programs/atop.nix b/nixos/modules/programs/atop.nix index 003cfdbfc8fa..26bfc519934b 100644 --- a/nixos/modules/programs/atop.nix +++ b/nixos/modules/programs/atop.nix @@ -14,7 +14,7 @@ in programs.atop = rec { - enable = mkEnableOption (lib.mdDoc "Atop"); + enable = mkEnableOption (lib.mdDoc "Atop, a tool for monitoring system resources"); package = mkPackageOption pkgs "atop" { }; diff --git a/nixos/modules/programs/bash/blesh.nix b/nixos/modules/programs/bash/blesh.nix index 8fa51bef7744..f23dff1405e2 100644 --- a/nixos/modules/programs/bash/blesh.nix +++ b/nixos/modules/programs/bash/blesh.nix @@ -4,7 +4,7 @@ let cfg = config.programs.bash.blesh; in { options = { - programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh"); + programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh, a full-featured line editor written in pure Bash"); }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/bcc.nix b/nixos/modules/programs/bcc.nix index ff29d56bedb9..f425fd45232d 100644 --- a/nixos/modules/programs/bcc.nix +++ b/nixos/modules/programs/bcc.nix @@ -1,6 +1,6 @@ { config, pkgs, lib, ... }: { - options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc"); + options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc, tools for BPF-based Linux IO analysis, networking, monitoring, and more"); config = lib.mkIf config.programs.bcc.enable { environment.systemPackages = [ pkgs.bcc ]; diff --git a/nixos/modules/programs/captive-browser.nix b/nixos/modules/programs/captive-browser.nix index 1c3ee7638ee0..ae0040328410 100644 --- a/nixos/modules/programs/captive-browser.nix +++ b/nixos/modules/programs/captive-browser.nix @@ -49,7 +49,7 @@ in options = { programs.captive-browser = { - enable = mkEnableOption (lib.mdDoc "captive browser"); + ena |