diff options
Diffstat (limited to 'nixos/modules/programs')
156 files changed, 508 insertions, 488 deletions
diff --git a/nixos/modules/programs/_1password-gui.nix b/nixos/modules/programs/_1password-gui.nix index eb2effee4326f..b21e8783f660e 100644 --- a/nixos/modules/programs/_1password-gui.nix +++ b/nixos/modules/programs/_1password-gui.nix @@ -16,13 +16,13 @@ in options = { programs._1password-gui = { - enable = mkEnableOption (lib.mdDoc "the 1Password GUI application"); + enable = mkEnableOption "the 1Password GUI application"; polkitPolicyOwners = mkOption { type = types.listOf types.str; default = [ ]; example = literalExpression ''["user1" "user2" "user3"]''; - description = lib.mdDoc '' + description = '' A list of users who should be able to integrate 1Password with polkit-based authentication mechanisms. ''; }; diff --git a/nixos/modules/programs/_1password.nix b/nixos/modules/programs/_1password.nix index 91246150755d5..b87e9b776e85b 100644 --- a/nixos/modules/programs/_1password.nix +++ b/nixos/modules/programs/_1password.nix @@ -16,7 +16,7 @@ in options = { programs._1password = { - enable = mkEnableOption (lib.mdDoc "the 1Password CLI tool"); + enable = mkEnableOption "the 1Password CLI tool"; package = mkPackageOption pkgs "1Password CLI" { default = [ "_1password" ]; diff --git a/nixos/modules/programs/adb.nix b/nixos/modules/programs/adb.nix index e5b0abd9fcfed..d8c700bc36b65 100644 --- a/nixos/modules/programs/adb.nix +++ b/nixos/modules/programs/adb.nix @@ -11,7 +11,7 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to configure system to use Android Debug Bridge (adb). To grant access to a user, it must be part of adbusers group: `users.users.alice.extraGroups = ["adbusers"];` diff --git a/nixos/modules/programs/alvr.nix b/nixos/modules/programs/alvr.nix index c01b74ad3a510..e5de06f1157ad 100644 --- a/nixos/modules/programs/alvr.nix +++ b/nixos/modules/programs/alvr.nix @@ -8,14 +8,14 @@ in { options = { programs.alvr = { - enable = mkEnableOption (lib.mdDoc "ALVR, the VR desktop streamer"); + enable = mkEnableOption "ALVR, the VR desktop streamer"; package = mkPackageOption pkgs "alvr" { }; openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to open the default ports in the firewall for the ALVR server. ''; }; diff --git a/nixos/modules/programs/appgate-sdp.nix b/nixos/modules/programs/appgate-sdp.nix index 5b958b686552e..6d61c87eeb612 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 "the AppGate SDP VPN client"); + enable = mkEnableOption "the AppGate SDP VPN client"; }; }; diff --git a/nixos/modules/programs/atop.nix b/nixos/modules/programs/atop.nix index 26bfc519934b3..618b641143590 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, a tool for monitoring system resources"); + enable = mkEnableOption "Atop, a tool for monitoring system resources"; package = mkPackageOption pkgs "atop" { }; @@ -22,7 +22,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to install and enable the netatop kernel module. Note: this sets the kernel taint flag "O" for loading out-of-tree modules. ''; @@ -31,7 +31,7 @@ in type = types.package; default = config.boot.kernelPackages.netatop; defaultText = literalExpression "config.boot.kernelPackages.netatop"; - description = lib.mdDoc '' + description = '' Which package to use for netatop. ''; }; @@ -40,7 +40,7 @@ in atopgpu.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to install and enable the atopgpud daemon to get information about NVIDIA gpus. ''; @@ -49,7 +49,7 @@ in setuidWrapper.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to install a setuid wrapper for Atop. This is required to use some of the features as non-root user (e.g.: ipc information, netatop, atopgpu). Atop tries to drop the root privileges shortly after starting. @@ -59,7 +59,7 @@ in atopService.enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable the atop service responsible for storing statistics for long-term analysis. ''; @@ -67,7 +67,7 @@ in atopRotateTimer.enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable the atop-rotate timer, which restarts the atop service daily to make sure the data files are rotate. ''; @@ -75,7 +75,7 @@ in atopacctService.enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable the atopacct service which manages process accounting. This allows Atop to gather data about processes that disappeared in between two refresh intervals. @@ -88,7 +88,7 @@ in flags = "a1f"; interval = 5; }; - description = lib.mdDoc '' + description = '' Parameters to be written to {file}`/etc/atoprc`. ''; }; diff --git a/nixos/modules/programs/ausweisapp.nix b/nixos/modules/programs/ausweisapp.nix index 91870df20246d..0359e58c554ca 100644 --- a/nixos/modules/programs/ausweisapp.nix +++ b/nixos/modules/programs/ausweisapp.nix @@ -7,10 +7,10 @@ let in { options.programs.ausweisapp = { - enable = mkEnableOption (lib.mdDoc "AusweisApp"); + enable = mkEnableOption "AusweisApp"; openFirewall = mkOption { - description = lib.mdDoc '' + description = '' Whether to open the required firewall ports for the Smartphone as Card Reader (SaC) functionality of AusweisApp. ''; default = false; diff --git a/nixos/modules/programs/autojump.nix b/nixos/modules/programs/autojump.nix index dde6870d98905..ecfc2f658079d 100644 --- a/nixos/modules/programs/autojump.nix +++ b/nixos/modules/programs/autojump.nix @@ -13,7 +13,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable autojump. ''; }; diff --git a/nixos/modules/programs/bandwhich.nix b/nixos/modules/programs/bandwhich.nix index aa6a0dfb6ffd1..2c78584f2d248 100644 --- a/nixos/modules/programs/bandwhich.nix +++ b/nixos/modules/programs/bandwhich.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to add bandwhich to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/bash-my-aws.nix b/nixos/modules/programs/bash-my-aws.nix index 10f16cae651b7..15e429a754976 100644 --- a/nixos/modules/programs/bash-my-aws.nix +++ b/nixos/modules/programs/bash-my-aws.nix @@ -13,7 +13,7 @@ in { options = { programs.bash-my-aws = { - enable = mkEnableOption (lib.mdDoc "bash-my-aws"); + enable = mkEnableOption "bash-my-aws"; }; }; diff --git a/nixos/modules/programs/bash/bash-completion.nix b/nixos/modules/programs/bash/bash-completion.nix index 96fbe0126d662..b8e5b1bfa336f 100644 --- a/nixos/modules/programs/bash/bash-completion.nix +++ b/nixos/modules/programs/bash/bash-completion.nix @@ -7,7 +7,7 @@ let in { options = { - programs.bash.enableCompletion = mkEnableOption (lib.mdDoc "Bash completion for all interactive bash shells") // { + programs.bash.enableCompletion = mkEnableOption "Bash completion for all interactive bash shells" // { default = true; }; }; diff --git a/nixos/modules/programs/bash/bash.nix b/nixos/modules/programs/bash/bash.nix index 7d3322ea5e50f..87fb29ed5bbe6 100644 --- a/nixos/modules/programs/bash/bash.nix +++ b/nixos/modules/programs/bash/bash.nix @@ -44,7 +44,7 @@ in shellAliases = mkOption { default = {}; - description = lib.mdDoc '' + description = '' Set of aliases for bash shell, which overrides {option}`environment.shellAliases`. See {option}`environment.shellAliases` for an option format description. ''; @@ -53,7 +53,7 @@ in shellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during bash shell initialisation. ''; type = types.lines; @@ -61,7 +61,7 @@ in loginShellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during login bash shell initialisation. ''; type = types.lines; @@ -69,7 +69,7 @@ in interactiveShellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during interactive bash shell initialisation. ''; type = types.lines; @@ -92,7 +92,7 @@ in fi fi ''; - description = lib.mdDoc '' + description = '' Shell script code used to initialise the bash prompt. ''; type = types.lines; @@ -100,7 +100,7 @@ in promptPluginInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code used to initialise bash prompt plugins. ''; type = types.lines; diff --git a/nixos/modules/programs/bash/blesh.nix b/nixos/modules/programs/bash/blesh.nix index f23dff1405e25..ea342b0ce3eec 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, a full-featured line editor written in pure Bash"); + programs.bash.blesh.enable = mkEnableOption "blesh, a full-featured line editor written in pure Bash"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/bash/ls-colors.nix b/nixos/modules/programs/bash/ls-colors.nix index 6a5253a3cca2e..254ee14c477d6 100644 --- a/nixos/modules/programs/bash/ls-colors.nix +++ b/nixos/modules/programs/bash/ls-colors.nix @@ -7,7 +7,7 @@ let in { options = { - programs.bash.enableLsColors = mkEnableOption (lib.mdDoc "extra colors in directory listings") // { + programs.bash.enableLsColors = mkEnableOption "extra colors in directory listings" // { default = true; }; }; diff --git a/nixos/modules/programs/bash/undistract-me.nix b/nixos/modules/programs/bash/undistract-me.nix index 587b649377df8..0e6465e048a10 100644 --- a/nixos/modules/programs/bash/undistract-me.nix +++ b/nixos/modules/programs/bash/undistract-me.nix @@ -8,13 +8,13 @@ in { options = { programs.bash.undistractMe = { - enable = mkEnableOption (lib.mdDoc "notifications when long-running terminal commands complete"); + enable = mkEnableOption "notifications when long-running terminal commands complete"; - playSound = mkEnableOption (lib.mdDoc "notification sounds when long-running terminal commands complete"); + playSound = mkEnableOption "notification sounds when long-running terminal commands complete"; timeout = mkOption { default = 10; - description = lib.mdDoc '' + description = '' Number of seconds it would take for a command to be considered long-running. ''; type = types.int; diff --git a/nixos/modules/programs/bcc.nix b/nixos/modules/programs/bcc.nix index f425fd45232dc..f799524b9c074 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, tools for BPF-based Linux IO analysis, networking, monitoring, and more"); + options.programs.bcc.enable = lib.mkEnableOption "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/browserpass.nix b/nixos/modules/programs/browserpass.nix index a9670a37e618c..2894e237e3d4a 100644 --- a/nixos/modules/programs/browserpass.nix +++ b/nixos/modules/programs/browserpass.nix @@ -4,7 +4,7 @@ with lib; { - options.programs.browserpass.enable = mkEnableOption (lib.mdDoc "Browserpass native messaging host"); + options.programs.browserpass.enable = mkEnableOption "Browserpass native messaging host"; config = mkIf config.programs.browserpass.enable { environment.etc = let diff --git a/nixos/modules/programs/calls.nix b/nixos/modules/programs/calls.nix index 3d757bc1fc320..0cf05f8a2ea0c 100644 --- a/nixos/modules/programs/calls.nix +++ b/nixos/modules/programs/calls.nix @@ -7,9 +7,9 @@ let in { options = { programs.calls = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' GNOME calls: a phone dialer and call handler - ''); + ''; }; }; diff --git a/nixos/modules/programs/captive-browser.nix b/nixos/modules/programs/captive-browser.nix index ae00403284105..8f0aa2fe1e6a0 100644 --- a/nixos/modules/programs/captive-browser.nix +++ b/nixos/modules/programs/captive-browser.nix @@ -49,13 +49,13 @@ in options = { programs.captive-browser = { - enable = mkEnableOption (lib.mdDoc "captive browser, a dedicated Chrome instance to log into captive portals without messing with DNS settings"); + enable = mkEnableOption "captive browser, a dedicated Chrome instance to log into captive portals without messing with DNS settings"; package = mkPackageOption pkgs "captive-browser" { }; interface = mkOption { type = types.str; - description = lib.mdDoc "your public network interface (wlp3s0, wlan0, eth0, ...)"; + description = "your public network interface (wlp3s0, wlan0, eth0, ...)"; }; # the options below are the same as in "captive-browser.toml" @@ -63,7 +63,7 @@ in type = types.str; default = browserDefault pkgs.chromium; defaultText = literalExpression (browserDefault "\${pkgs.chromium}"); - description = lib.mdDoc '' + description = '' The shell (/bin/sh) command executed once the proxy starts. When browser exits, the proxy exits. An extra env var PROXY is available. @@ -79,7 +79,7 @@ in dhcp-dns = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' The shell (/bin/sh) command executed to obtain the DHCP DNS server address. The first match of an IPv4 regex is used. IPv4 only, because let's be real, it's a captive portal. @@ -89,13 +89,13 @@ in socks5-addr = mkOption { type = types.str; default = "localhost:1666"; - description = lib.mdDoc "the listen address for the SOCKS5 proxy server"; + description = "the listen address for the SOCKS5 proxy server"; }; bindInterface = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Binds `captive-browser` to the network interface declared in `cfg.interface`. This can be used to avoid collisions with private subnets. diff --git a/nixos/modules/programs/ccache.nix b/nixos/modules/programs/ccache.nix index fbe8eb6c179e0..bfcbe39b3ff01 100644 --- a/nixos/modules/programs/ccache.nix +++ b/nixos/modules/programs/ccache.nix @@ -5,28 +5,28 @@ let in { options.programs.ccache = { # host configuration - enable = lib.mkEnableOption (lib.mdDoc "CCache, a compiler cache for fast recompilation of C/C++ code"); + enable = lib.mkEnableOption "CCache, a compiler cache for fast recompilation of C/C++ code"; cacheDir = lib.mkOption { type = lib.types.path; - description = lib.mdDoc "CCache directory"; + description = "CCache directory"; default = "/var/cache/ccache"; }; # target configuration packageNames = lib.mkOption { type = lib.types.listOf lib.types.str; - description = lib.mdDoc "Nix top-level packages to be compiled using CCache"; + description = "Nix top-level packages to be compiled using CCache"; default = []; example = [ "wxGTK32" "ffmpeg" "libav_all" ]; }; owner = lib.mkOption { type = lib.types.str; default = "root"; - description = lib.mdDoc "Owner of CCache directory"; + description = "Owner of CCache directory"; }; group = lib.mkOption { type = lib.types.str; default = "nixbld"; - description = lib.mdDoc "Group owner of CCache directory"; + description = "Group owner of CCache directory"; }; }; diff --git a/nixos/modules/programs/cdemu.nix b/nixos/modules/programs/cdemu.nix index 7eba4d29d83ba..3ee8b2d8fcd65 100644 --- a/nixos/modules/programs/cdemu.nix +++ b/nixos/modules/programs/cdemu.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' {command}`cdemu` for members of {option}`programs.cdemu.group`. ''; @@ -18,21 +18,21 @@ in { group = mkOption { type = types.str; default = "cdrom"; - description = lib.mdDoc '' + description = '' Group that users must be in to use {command}`cdemu`. ''; }; gui = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to install the {command}`cdemu` GUI (gCDEmu). ''; }; image-analyzer = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to install the image analyzer. ''; }; diff --git a/nixos/modules/programs/cfs-zen-tweaks.nix b/nixos/modules/programs/cfs-zen-tweaks.nix index fc05bcd11ecbb..28d1ef5992d7d 100644 --- a/nixos/modules/programs/cfs-zen-tweaks.nix +++ b/nixos/modules/programs/cfs-zen-tweaks.nix @@ -17,7 +17,7 @@ in }; options = { - programs.cfs-zen-tweaks.enable = mkEnableOption (lib.mdDoc "CFS Zen Tweaks"); + programs.cfs-zen-tweaks.enable = mkEnableOption "CFS Zen Tweaks"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/chromium.nix b/nixos/modules/programs/chromium.nix index 5e89837300489..fa5abe957a904 100644 --- a/nixos/modules/programs/chromium.nix +++ b/nixos/modules/programs/chromium.nix @@ -19,15 +19,15 @@ in options = { programs.chromium = { - enable = mkEnableOption (lib.mdDoc "{command}`chromium` policies"); + enable = mkEnableOption "{command}`chromium` policies"; - enablePlasmaBrowserIntegration = mkEnableOption (lib.mdDoc "Native Messaging Host for Plasma Browser Integration"); + enablePlasmaBrowserIntegration = mkEnableOption "Native Messaging Host for Plasma Browser Integration"; plasmaBrowserIntegrationPackage = mkPackageOption pkgs [ "plasma5Packages" "plasma-browser-integration" ] { }; extensions = mkOption { type = with types; nullOr (listOf str); - description = lib.mdDoc '' + description = '' List of chromium extensions to install. For list of plugins ids see id in url of extensions on [chrome web store](https://chrome.google.com/webstore/category/extensions) @@ -50,35 +50,35 @@ in homepageLocation = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Chromium default homepage"; + description = "Chromium default homepage"; default = null; example = "https://nixos.org"; }; defaultSearchProviderEnabled = mkOption { type = types.nullOr types.bool; - description = lib.mdDoc "Enable the default search provider."; + description = "Enable the default search provider."; default = null; example = true; }; defaultSearchProviderSearchURL = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Chromium default search provider url."; + description = "Chromium default search provider url."; default = null; example = "https://encrypted.google.com/search?q={searchTerms}&{google:RLZ}{google:originalQueryForSuggestion}{google:assistedQueryStats}{google:searchFieldtrialParameter}{google:searchClient}{google:sourceId}{google:instantExtendedEnabledParameter}ie={inputEncoding}"; }; defaultSearchProviderSuggestURL = mkOption { type = types.nullOr types.str; - description = lib.mdDoc "Chromium default search provider url for suggestions."; + description = "Chromium default search provider url for suggestions."; default = null; example = "https://encrypted.google.com/complete/search?output=chrome&q={searchTerms}"; }; extraOpts = mkOption { type = types.attrs; - description = lib.mdDoc '' + description = '' Extra chromium policy options. A list of available policies can be found in the Chrome Enterprise documentation: <https://cloud.google.com/docs/chrome-enterprise/policies/> @@ -101,7 +101,7 @@ in initialPrefs = mkOption { type = types.attrs; - description = lib.mdDoc '' + description = '' Initial preferences are used to configure the browser for the first run. Unlike {option}`programs.chromium.extraOpts`, initialPrefs can be changed by users in the browser settings. More information can be found in the Chromium documentation: diff --git a/nixos/modules/programs/clash-verge.nix b/nixos/modules/programs/clash-verge.nix index e1afafa7cadc3..4425fe1a9fe72 100644 --- a/nixos/modules/programs/clash-verge.nix +++ b/nixos/modules/programs/clash-verge.nix @@ -2,10 +2,10 @@ { options.programs.clash-verge = { - enable = lib.mkEnableOption (lib.mdDoc "Clash Verge"); + enable = lib.mkEnableOption "Clash Verge"; package = lib.mkPackageOption pkgs "clash-verge" {}; - autoStart = lib.mkEnableOption (lib.mdDoc "Clash Verge auto launch"); - tunMode = lib.mkEnableOption (lib.mdDoc "Clash Verge TUN mode"); + autoStart = lib.mkEnableOption "Clash Verge auto launch"; + tunMode = lib.mkEnableOption "Clash Verge TUN mode"; }; config = diff --git a/nixos/modules/programs/cnping.nix b/nixos/modules/programs/cnping.nix index 143267fc9a426..77cbf4d82086b 100644 --- a/nixos/modules/programs/cnping.nix +++ b/nixos/modules/programs/cnping.nix @@ -8,7 +8,7 @@ in { options = { programs.cnping = { - enable = mkEnableOption (lib.mdDoc "a setcap wrapper for cnping"); + enable = mkEnableOption "a setcap wrapper for cnping"; }; }; diff --git a/nixos/modules/programs/command-not-found/command-not-found.nix b/nixos/modules/programs/command-not-found/command-not-found.nix index b5c7626bd2075..4d2a89b515842 100644 --- a/nixos/modules/programs/command-not-found/command-not-found.nix +++ b/nixos/modules/programs/command-not-found/command-not-found.nix @@ -26,7 +26,7 @@ in enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether interactive shells should show which Nix package (if any) provides a missing command. ''; @@ -34,7 +34,7 @@ in dbPath = mkOption { default = "/nix/var/nix/profiles/per-user/root/channels/nixos/programs.sqlite" ; - description = lib.mdDoc '' + description = '' Absolute path to programs.sqlite. By default this file will be provided by your channel diff --git a/nixos/modules/programs/coolercontrol.nix b/nixos/modules/programs/coolercontrol.nix index 6e7299ad16b72..8c9a39d2eba99 100644 --- a/nixos/modules/programs/coolercontrol.nix +++ b/nixos/modules/programs/coolercontrol.nix @@ -10,28 +10,50 @@ in { ##### interface options = { - programs.coolercontrol.enable = lib.mkEnableOption (lib.mdDoc "CoolerControl GUI & its background services"); + programs.coolercontrol = { + enable = lib.mkEnableOption "CoolerControl GUI & its background services"; + + nvidiaSupport = lib.mkOption { + type = lib.types.bool; + default = lib.elem "nvidia" config.services.xserver.videoDrivers; + defaultText = lib.literalExpression "lib.elem \"nvidia\" config.services.xserver.videoDrivers"; + description = '' + Enable support for Nvidia GPUs. + ''; + }; + }; }; ##### implementation - config = lib.mkIf cfg.enable { - environment.systemPackages = with pkgs.coolercontrol; [ - coolercontrol-gui - ]; - - systemd = { - packages = with pkgs.coolercontrol; [ - coolercontrol-liqctld - coolercontrold + config = lib.mkIf cfg.enable (lib.mkMerge [ + # Common + ({ + environment.systemPackages = with pkgs.coolercontrol; [ + coolercontrol-gui ]; - # https://github.com/NixOS/nixpkgs/issues/81138 - services = { - coolercontrol-liqctld.wantedBy = [ "multi-user.target" ]; - coolercontrold.wantedBy = [ "multi-user.target" ]; + systemd = { + packages = with pkgs.coolercontrol; [ + coolercontrol-liqctld + coolercontrold + ]; + + # https://github.com/NixOS/nixpkgs/issues/81138 + services = { + coolercontrol-liqctld.wantedBy = [ "multi-user.target" ]; + coolercontrold.wantedBy = [ "multi-user.target" ]; + }; }; - }; - }; + }) + + # Nvidia support + (lib.mkIf cfg.nvidiaSupport { + systemd.services.coolercontrold.path = with config.boot.kernelPackages; [ + nvidia_x11 # nvidia-smi + nvidia_x11.settings # nvidia-settings + ]; + }) + ]); meta.maintainers = with lib.maintainers; [ OPNA2608 codifryed ]; } diff --git a/nixos/modules/programs/criu.nix b/nixos/modules/programs/criu.nix index 9f03b0c6431a9..9414d0b27f0d2 100644 --- a/nixos/modules/programs/criu.nix +++ b/nixos/modules/programs/criu.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Install {command}`criu` along with necessary kernel options. ''; }; diff --git a/nixos/modules/programs/darling.nix b/nixos/modules/programs/darling.nix index 589a9dd5d6037..194b1648b78f0 100644 --- a/nixos/modules/programs/darling.nix +++ b/nixos/modules/programs/darling.nix @@ -5,7 +5,7 @@ let in { options = { programs.darling = { - enable = lib.mkEnableOption (lib.mdDoc "Darling, a Darwin/macOS compatibility layer for Linux"); + enable = lib.mkEnableOption "Darling, a Darwin/macOS compatibility layer for Linux"; package = lib.mkPackageOption pkgs "darling" {}; }; }; diff --git a/nixos/modules/programs/dconf.nix b/nixos/modules/programs/dconf.nix index cf53658c4fada..e6738617c8e35 100644 --- a/nixos/modules/programs/dconf.nix +++ b/nixos/modules/programs/dconf.nix @@ -93,12 +93,12 @@ let keyfiles = lib.mkOption { type = listOf (oneOf [ path package ]); default = [ ]; - description = lib.mdDoc "A list of dconf keyfile directories."; + description = "A list of dconf keyfile directories."; }; settings = lib.mkOption { type = attrs; default = { }; - description = lib.mdDoc "An attrset used to generate dconf keyfile."; + description = "An attrset used to generate dconf keyfile."; example = literalExpression '' with lib.gvariant; { @@ -112,7 +112,7 @@ let locks = lib.mkOption { type = with lib.types; listOf str; default = [ ]; - description = lib.mdDoc '' + description = '' A list of dconf keys to be lockdown. This doesn't take effect if `lockAll` is set. ''; @@ -123,7 +123,7 @@ let lockAll = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc "Lockdown all dconf keys in `settings`."; + description = "Lockdown all dconf keys in `settings`."; }; }; }; @@ -133,7 +133,7 @@ let enableUserDb = lib.mkOption { type = bool; default = true; - description = lib.mdDoc "Add `user-db:user` at the beginning of the profile."; + description = "Add `user-db:user` at the beginning of the profile."; }; databases = lib.mkOption { @@ -143,7 +143,7 @@ let dconfDatabase ]); default = [ ]; - description = lib.mdDoc '' + description = '' List of data sources for the profile. An element can be an attrset, or the path of an already compiled database. Each element is converted to a file-db. @@ -161,7 +161,7 @@ in { options = { programs.dconf = { - enable = lib.mkEnableOption (lib.mdDoc "dconf"); + enable = lib.mkEnableOption "dconf"; profiles = lib.mkOption { type = with lib.types; attrsOf (oneOf [ @@ -170,7 +170,7 @@ in dconfProfile ]); default = { }; - description = lib.mdDoc '' + description = '' Attrset of dconf profiles. By default the `user` profile is used which ends up in `/etc/dconf/profile/user`. ''; @@ -193,7 +193,7 @@ in packages = lib.mkOption { type = lib.types.listOf lib.types.package; default = [ ]; - description = lib.mdDoc "A list of packages which provide dconf profiles and databases in {file}`/etc/dconf`."; + description = "A list of packages which provide dconf profiles and databases in {file}`/etc/dconf`."; }; }; }; diff --git a/nixos/modules/programs/digitalbitbox/default.nix b/nixos/modules/programs/digitalbitbox/default.nix index bdacbc010c410..10b5a88171fcd 100644 --- a/nixos/modules/programs/digitalbitbox/default.nix +++ b/nixos/modules/programs/digitalbitbox/default.nix @@ -11,7 +11,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Installs the Digital Bitbox application and enables the complementary hardware module. ''; }; diff --git a/nixos/modules/programs/direnv.nix b/nixos/modules/programs/direnv.nix index fdc646eb4b164..6061de58eb8e2 100644 --- a/nixos/modules/programs/direnv.nix +++ b/nixos/modules/programs/direnv.nix @@ -8,11 +8,11 @@ in { options.programs.direnv = { - enable = lib.mkEnableOption (lib.mdDoc '' + enable = lib.mkEnableOption '' direnv integration. Takes care of both installation and setting up the sourcing of the shell. Additionally enables nix-direnv integration. Note that you need to logout and login for this change to apply - ''); + ''; package = lib.mkPackageOption pkgs "direnv" {}; @@ -23,28 +23,28 @@ in { export FOO="foo" echo "loaded direnv!" ''; - description = lib.mdDoc '' + description = '' Extra lines to append to the sourced direnvrc ''; }; - silent = lib.mkEnableOption (lib.mdDoc '' + silent = lib.mkEnableOption '' the hiding of direnv logging - ''); + ''; loadInNixShell = - lib.mkEnableOption (lib.mdDoc '' + lib.mkEnableOption '' loading direnv in `nix-shell` `nix shell` or `nix develop` - '') + '' // { default = true; }; nix-direnv = { enable = - (lib.mkEnableOption (lib.mdDoc '' + (lib.mkEnableOption '' a faster, persistent implementation of use_nix and use_flake, to replace the built-in one - '')) + '') // { default = true; }; @@ -53,7 +53,7 @@ in { default = pkgs.nix-direnv.override { nix = config.nix.package; }; defaultText = "pkgs.nix-direnv"; type = lib.types.package; - description = lib.mdDoc '' + description = '' The nix-direnv package to use ''; }; diff --git a/nixos/modules/programs/dmrconfig.nix b/nixos/modules/programs/dmrconfig.nix index 29268cdfeb505..15338681e642a 100644 --- a/nixos/modules/programs/dmrconfig.nix +++ b/nixos/modules/programs/dmrconfig.nix @@ -14,7 +14,7 @@ in { enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to configure system to enable use of dmrconfig. This enables the required udev rules and installs the program. ''; diff --git a/nixos/modules/programs/droidcam.nix b/nixos/modules/programs/droidcam.nix index c9b4457d1d18d..9843a1f5be252 100644 --- a/nixos/modules/programs/droidcam.nix +++ b/nixos/modules/programs/droidcam.nix @@ -4,7 +4,7 @@ with lib; { options.programs.droidcam = { - enable = mkEnableOption (lib.mdDoc "DroidCam client"); + enable = mkEnableOption "DroidCam client"; }; config = lib.mkIf config.programs.droidcam.enable { diff --git a/nixos/modules/programs/dublin-traceroute.nix b/nixos/modules/programs/dublin-traceroute.nix index cfcd6e8308ff5..6ff8a5bdefc39 100644 --- a/nixos/modules/programs/dublin-traceroute.nix +++ b/nixos/modules/programs/dublin-traceroute.nix @@ -10,9 +10,9 @@ in { options = { programs.dublin-traceroute = { - enable = mkEnableOption (mdDoc '' + enable = mkEnableOption '' dublin-traceroute, add it to the global environment and configure a setcap wrapper for it. - ''); + ''; package = mkPackageOption pkgs "dublin-traceroute" { }; }; diff --git a/nixos/modules/programs/ecryptfs.nix b/nixos/modules/programs/ecryptfs.nix index 63c1a3ad44199..ced5eb26fb9a2 100644 --- a/nixos/modules/programs/ecryptfs.nix +++ b/nixos/modules/programs/ecryptfs.nix @@ -7,7 +7,7 @@ let in { options.programs.ecryptfs = { - enable = mkEnableOption (lib.mdDoc "ecryptfs setuid mount wrappers"); + enable = mkEnableOption "ecryptfs setuid mount wrappers"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/evince.nix b/nixos/modules/programs/evince.nix index ed543d35cc5e4..cffc5127f10a8 100644 --- a/nixos/modules/programs/evince.nix +++ b/nixos/modules/programs/evince.nix @@ -21,8 +21,7 @@ in { programs.evince = { - enable = mkEnableOption - (lib.mdDoc "Evince, the GNOME document viewer"); + enable = mkEnableOption "Evince, the GNOME document viewer"; package = mkPackageOption pkgs "evince" { }; diff --git a/nixos/modules/programs/extra-container.nix b/nixos/modules/programs/extra-container.nix index 5e717c4d82231..c10ccd7691688 100644 --- a/nixos/modules/programs/extra-container.nix +++ b/nixos/modules/programs/extra-container.nix @@ -5,10 +5,10 @@ let cfg = config.programs.extra-container; in { options = { - programs.extra-container.enable = mkEnableOption (lib.mdDoc '' + programs.extra-container.enable = mkEnableOption '' extra-container, a tool for running declarative NixOS containers without host system rebuilds - ''); + ''; }; config = mkIf cfg.enable { environment.systemPackages = [ pkgs.extra-container ]; diff --git a/nixos/modules/programs/feedbackd.nix b/nixos/modules/programs/feedbackd.nix index 010287e5cd565..9de604c34a7ea 100644 --- a/nixos/modules/programs/feedbackd.nix +++ b/nixos/modules/programs/feedbackd.nix @@ -7,11 +7,11 @@ let in { options = { programs.feedbackd = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' the feedbackd D-BUS service and udev rules. Your user needs to be in the `feedbackd` group to trigger effects - ''); + ''; package = mkPackageOption pkgs "feedbackd" { }; }; }; diff --git a/nixos/modules/programs/file-roller.nix b/nixos/modules/programs/file-roller.nix index a343d4a261c98..4799f42d630b1 100644 --- a/nixos/modules/programs/file-roller.nix +++ b/nixos/modules/programs/file-roller.nix @@ -21,7 +21,7 @@ in { programs.file-roller = { - enable = mkEnableOption (lib.mdDoc "File Roller, an archive manager for GNOME"); + enable = mkEnableOption "File Roller, an archive manager for GNOME"; package = mkPackageOption pkgs [ "gnome" "file-roller" ] { }; diff --git a/nixos/modules/programs/firefox.nix b/nixos/modules/programs/firefox.nix index 29c567783e27a..39b30be48de9d 100644 --- a/nixos/modules/programs/firefox.nix +++ b/nixos/modules/programs/firefox.nix @@ -62,12 +62,12 @@ let in { options.programs.firefox = { - enable = mkEnableOption (mdDoc "the Firefox web browser"); + enable = mkEnableOption "the Firefox web browser"; package = mkOption { type = types.package; default = pkgs.firefox; - description = mdDoc "Firefox package to use."; + description = "Firefox package to use."; defaultText = literalExpression "pkgs.firefox"; relatedPackages = [ "firefox" @@ -81,13 +81,13 @@ in wrapperConfig = mkOption { type = types.attrs; default = {}; - description = mdDoc "Arguments to pass to Firefox wrapper"; + description = "Arguments to pass to Firefox wrapper"; }; policies = mkOption { type = policyFormat.type; default = { }; - description = mdDoc '' + description = '' Group policies to install. See [Mozilla's documentation](https://mozilla.github.io/policy-templates/) @@ -103,7 +103,7 @@ in preferences = mkOption { type = with types; attrsOf (oneOf [ bool int str ]); default = { }; - description = mdDoc '' + description = '' Preferences to set from `about:config`. Some of these might be able to be configured more ergonomically @@ -116,7 +116,7 @@ in preferencesStatus = mkOption { type = types.enum [ "default" "locked" "user" "clear" ]; default = "locked"; - description = mdDoc '' + description = '' The status of `firefox.preferences`. `status` can assume the following values: @@ -230,7 +230,7 @@ in "zh-TW" ])); default = [ ]; - description = mdDoc '' + description = '' The language packs to install. ''; }; @@ -238,7 +238,7 @@ in autoConfig = mkOption { type = types.lines; default = ""; - description = mdDoc '' + description = '' AutoConfig files can be used to set and lock preferences that are not covered by the policies.json for Mac and Linux. This method can be used to automatically change user preferences or prevent the end user from modifiying specific @@ -250,11 +250,11 @@ in packages = mkOption { type = types.listOf types.package; default = []; - description = mdDoc '' + description = '' Additional packages containing native messaging hosts that should be made available to Firefox extensions. ''; }; - }) // (mapAttrs (k: v: mkEnableOption (mdDoc "${v.name} support")) nmhOptions); + }) // (mapAttrs (k: v: mkEnableOption "${v.name} support") nmhOptions); }; config = let diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix index 792ed9fe56807..0510cf8c610d4 100644 --- a/nixos/modules/programs/firejail.nix +++ b/nixos/modules/programs/firejail.nix @@ -40,32 +40,32 @@ let in { options.programs.firejail = { - enable = mkEnableOption (lib.mdDoc "firejail, a sandboxing tool for Linux"); + enable = mkEnableOption "firejail, a sandboxing tool for Linux"; wrappedBinaries = mkOption { type = types.attrsOf (types.either types.path (types.submodule { options = { executable = mkOption { type = types.path; - description = lib.mdDoc "Executable to run sandboxed"; + description = "Executable to run sandboxed"; example = literalExpression ''"''${lib.getBin pkgs.firefox}/bin/firefox"''; }; desktop = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc ".desktop file to modify. Only necessary if it uses the absolute path to the executable."; + description = ".desktop file to modify. Only necessary if it uses the absolute path to the executable."; example = literalExpression ''"''${pkgs.firefox}/share/applications/firefox.desktop"''; }; profile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc "Profile to use"; + description = "Profile to use"; example = literalExpression ''"''${pkgs.firejail}/etc/firejail/firefox.profile"''; }; extraArgs = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc "Extra arguments to pass to firejail"; + description = "Extra arguments to pass to firejail"; example = [ "--private=~/.firejail_home" ]; }; }; @@ -83,7 +83,7 @@ in { }; } ''; - description = lib.mdDoc '' + description = '' Wrap the binaries in firejail and place them in the global path. ''; }; diff --git a/nixos/modules/programs/fish.nix b/nixos/modules/programs/fish.nix index a4c20560bc9b6..2102a07cd0bca 100644 --- a/nixos/modules/programs/fish.nix +++ b/nixos/modules/programs/fish.nix @@ -49,7 +49,7 @@ in enable = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to configure fish as an interactive shell. ''; type = types.bool; @@ -58,7 +58,7 @@ in useBabelfish = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' If enabled, the configured environment will be translated to native fish using [babelfish](https://github.com/bouk/babelfish). Otherwise, [foreign-env](https://github.com/oh-my-fish/plugin-foreign-env) will be used. ''; @@ -67,7 +67,7 @@ in vendor.config.enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether fish should source configuration snippets provided by other packages. ''; }; @@ -75,7 +75,7 @@ in vendor.completions.enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether fish should use completion files provided by other packages. ''; }; @@ -83,7 +83,7 @@ in vendor.functions.enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether fish should autoload fish functions provided by other packages. ''; }; @@ -94,7 +94,7 @@ in gco = "git checkout"; npu = "nix-prefetch-url"; }; - description = lib.mdDoc '' + description = '' Set of fish abbreviations. ''; type = with types; attrsOf str; @@ -102,7 +102,7 @@ in shellAliases = mkOption { default = {}; - description = lib.mdDoc '' + description = '' Set of aliases for fish shell, which overrides {option}`environment.shellAliases`. See {option}`environment.shellAliases` for an option format description. ''; @@ -111,7 +111,7 @@ in shellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during fish shell initialisation. ''; type = types.lines; @@ -119,7 +119,7 @@ in loginShellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during fish login shell initialisation. ''; type = types.lines; @@ -127,7 +127,7 @@ in interactiveShellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during interactive fish shell initialisation. ''; type = types.lines; @@ -135,7 +135,7 @@ in promptInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code used to initialise fish prompt. ''; type = types.lines; diff --git a/nixos/modules/programs/flashrom.nix b/nixos/modules/programs/flashrom.nix index f954bc2197b17..1b9b4493ef201 100644 --- a/nixos/modules/programs/flashrom.nix +++ b/nixos/modules/programs/flashrom.nix @@ -10,7 +10,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Installs flashrom and configures udev rules for programmers used by flashrom. Grants access to users in the "flashrom" group. diff --git a/nixos/modules/programs/flexoptix-app.nix b/nixos/modules/programs/flexoptix-app.nix index 6f37fe54667c9..47a76da125f01 100644 --- a/nixos/modules/programs/flexoptix-app.nix +++ b/nixos/modules/programs/flexoptix-app.nix @@ -7,7 +7,7 @@ let in { options = { programs.flexoptix-app = { - enable = mkEnableOption (lib.mdDoc "FLEXOPTIX app + udev rules"); + enable = mkEnableOption "FLEXOPTIX app + udev rules"; package = mkPackageOption pkgs "flexoptix-app" { }; }; diff --git a/nixos/modules/programs/freetds.nix b/nixos/modules/programs/freetds.nix index 98274fa9b5626..8b52fc37c5e03 100644 --- a/nixos/modules/programs/freetds.nix +++ b/nixos/modules/programs/freetds.nix @@ -25,8 +25,7 @@ in '''; } ''; - description = - lib.mdDoc '' + description = '' Configure freetds database entries. Each attribute denotes a section within freetds.conf, and the value (a string) is the config content for that section. When at least one entry is configured diff --git a/nixos/modules/programs/fuse.nix b/nixos/modules/programs/fuse.nix index b82d37a051e75..c15896efbb51a 100644 --- a/nixos/modules/programs/fuse.nix +++ b/nixos/modules/programs/fuse.nix @@ -13,7 +13,7 @@ in { # negative numbers obviously make no sense: type = types.ints.between 0 32767; # 2^15 - 1 default = 1000; - description = lib.mdDoc '' + description = '' Set the maximum number of FUSE mounts allowed to non-root users. ''; }; @@ -21,7 +21,7 @@ in { userAllowOther = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Allow non-root users to specify the allow_other or allow_root mount options, see mount.fuse3(8). ''; diff --git a/nixos/modules/programs/fzf.nix b/nixos/modules/programs/fzf.nix index acc23d75df7b6..0e7e519f0436d 100644 --- a/nixos/modules/programs/fzf.nix +++ b/nixos/modules/programs/fzf.nix @@ -6,8 +6,8 @@ in { options = { programs.fzf = { - fuzzyCompletion = lib.mkEnableOption (lib.mdDoc "fuzzy completion with fzf"); - keybindings = lib.mkEnableOption (lib.mdDoc "fzf keybindings"); + fuzzyCompletion = lib.mkEnableOption "fuzzy completion with fzf"; + keybindings = lib.mkEnableOption "fzf keybindings"; }; }; diff --git a/nixos/modules/programs/gamemode.nix b/nixos/modules/programs/gamemode.nix index 2bb92ed8e0efd..878f785074f17 100644 --- a/nixos/modules/programs/gamemode.nix +++ b/nixos/modules/programs/gamemode.nix @@ -10,16 +10,16 @@ in { options = { programs.gamemode = { - enable = mkEnableOption (lib.mdDoc "GameMode to optimise system performance on demand"); + enable = mkEnableOption "GameMode to optimise system performance on demand"; - enableRenice = mkEnableOption (lib.mdDoc "CAP_SYS_NICE on gamemoded to support lowering process niceness") // { + enableRenice = mkEnableOption "CAP_SYS_NICE on gamemoded to support lowering process niceness" // { default = true; }; settings = mkOption { type = settingsFormat.type; default = { }; - description = lib.mdDoc '' + description = '' System-wide configuration for GameMode (/etc/gamemode.ini). See gamemoded(8) man page for available settings. ''; diff --git a/nixos/modules/programs/gamescope.nix b/nixos/modules/programs/gamescope.nix index 33ab16cc87078..af9ced4715391 100644 --- a/nixos/modules/programs/gamescope.nix +++ b/nixos/modules/programs/gamescope.nix @@ -21,14 +21,14 @@ with lib; let in { options.programs.gamescope = { - enable = mkEnableOption (mdDoc "gamescope, the SteamOS session compositing window manager"); + enable = mkEnableOption "gamescope, the SteamOS session compositing window manager"; package = mkPackageOption pkgs "gamescope" { }; capSysNice = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Add cap_sys_nice capability to the GameScope binary so that it may renice itself. ''; @@ -38,7 +38,7 @@ in type = types.listOf types.str; default = [ ]; example = [ "--rt" "--prefer-vk-device 8086:9bc4" ]; - description = mdDoc '' + description = '' Arguments passed to GameScope on startup. ''; }; @@ -55,7 +55,7 @@ in __GLX_VENDOR_LIBRARY_NAME = "nvidia"; } ''; - description = mdDoc '' + description = '' Default environment variables available to the GameScope process, overridable at runtime. ''; }; diff --git a/nixos/modules/programs/geary.nix b/nixos/modules/programs/geary.nix index 5aa71434090ed..6103ee7df8591 100644 --- a/nixos/modules/programs/geary.nix +++ b/nixos/modules/programs/geary.nix @@ -11,7 +11,7 @@ in { }; options = { - programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME"); + programs.geary.enable = mkEnableOption "Geary, a Mail client for GNOME"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/git.nix b/nixos/modules/programs/git.nix index 3029dd9e1bfd7..2a5d52f2d191f 100644 --- a/nixos/modules/programs/git.nix +++ b/nixos/modules/programs/git.nix @@ -9,7 +9,7 @@ in { options = { programs.git = { - enable = mkEnableOption (lib.mdDoc "git, a distributed version control system"); + enable = mkEnableOption "git, a distributed version control system"; package = mkPackageOption pkgs "git" { example = "gitFull"; @@ -43,7 +43,7 @@ in init.defaultBranch = "main"; url."https://github.com/".insteadOf = [ "gh:" "github:" ]; }; - description = lib.mdDoc '' + description = '' Configuration to write to /etc/gitconfig. A list can also be specified to keep the configuration in order. For example, setting `config` to `[ { foo.x = 42; } { bar.y = 42; }]` will put the `foo` @@ -59,7 +59,7 @@ in }; lfs = { - enable = mkEnableOption (lib.mdDoc "git-lfs (Large File Storage)"); + enable = mkEnableOption "git-lfs (Large File Storage)"; package = mkPackageOption pkgs "git-lfs" { }; }; diff --git a/nixos/modules/programs/gnome-disks.nix b/nixos/modules/programs/gnome-disks.nix index dcb20bd6037cd..4b128b4712650 100644 --- a/nixos/modules/programs/gnome-disks.nix +++ b/nixos/modules/programs/gnome-disks.nix @@ -26,7 +26,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable GNOME Disks daemon, a program designed to be a UDisks2 graphical front-end. ''; diff --git a/nixos/modules/programs/gnome-terminal.nix b/nixos/modules/programs/gnome-terminal.nix index a8d82e0b018c9..71a6b217880c5 100644 --- a/nixos/modules/programs/gnome-terminal.nix +++ b/nixos/modules/programs/gnome-terminal.nix @@ -24,7 +24,7 @@ in ]; options = { - programs.gnome-terminal.enable = mkEnableOption (lib.mdDoc "GNOME Terminal"); + programs.gnome-terminal.enable = mkEnableOption "GNOME Terminal"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/gnupg.nix b/nixos/modules/programs/gnupg.nix index 66be1f247fbde..c755d110170c6 100644 --- a/nixos/modules/programs/gnupg.nix +++ b/nixos/modules/programs/gnupg.nix @@ -36,7 +36,7 @@ in agent.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enables GnuPG agent with socket-activation for every user session. ''; }; @@ -44,7 +44,7 @@ in agent.enableSSHSupport = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable SSH agent support in GnuPG agent. Also sets SSH_AUTH_SOCK environment variable correctly. This will disable socket-activation and thus always start a GnuPG agent per user session. @@ -54,7 +54,7 @@ in agent.enableExtraSocket = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable extra socket for GnuPG agent. ''; }; @@ -62,7 +62,7 @@ in agent.enableBrowserSocket = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable browser socket for GnuPG agent. ''; }; @@ -72,7 +72,7 @@ in example = lib.literalMD "pkgs.pinentry-gnome3"; default = pkgs.pinentry-curses; defaultText = lib.literalMD "matching the configured desktop environment or `pkgs.pinentry-curses`"; - description = lib.mdDoc '' + description = '' Which pinentry package to use. The path to the mainProgram as defined in the package's meta attriutes will be set in /etc/gnupg/gpg-agent.conf. If not set by the user, it'll pick an appropriate flavor depending on the @@ -87,7 +87,7 @@ in example = { default-cache-ttl = 600; }; - description = lib.mdDoc '' + description = '' Configuration for /etc/gnupg/gpg-agent.conf. See {manpage}`gpg-agent(1)` for supported options. ''; @@ -96,7 +96,7 @@ in dirmngr.enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enables GnuPG network certificate management daemon with socket-activation for every user session. ''; }; diff --git a/nixos/modules/programs/gpaste.nix b/nixos/modules/programs/gpaste.nix index 37172c9583a37..1c34c86eb853f 100644 --- a/nixos/modules/programs/gpaste.nix +++ b/nixos/modules/programs/gpaste.nix @@ -18,7 +18,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable GPaste, a clipboard manager. ''; }; diff --git a/nixos/modules/programs/gphoto2.nix b/nixos/modules/programs/gphoto2.nix index f31b1863963d9..d99259b545825 100644 --- a/nixos/modules/programs/gphoto2.nix +++ b/nixos/modules/programs/gphoto2.nix @@ -11,7 +11,7 @@ with lib; enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to configure system to use gphoto2. To grant digital camera access to a user, the user must be part of the camera group: diff --git a/nixos/modules/programs/haguichi.nix b/nixos/modules/programs/haguichi.nix index 699327c28c61f..4f48551cf1dac 100644 --- a/nixos/modules/programs/haguichi.nix +++ b/nixos/modules/programs/haguichi.nix @@ -4,7 +4,7 @@ with lib; { options.programs.haguichi = { - enable = mkEnableOption (lib.mdDoc "Haguichi, a Linux GUI frontend to the proprietary LogMeIn Hamachi"); + enable = mkEnableOption "Haguichi, a Linux GUI frontend to the proprietary LogMeIn Hamachi"; }; config = mkIf config.programs.haguichi.enable { diff --git a/nixos/modules/programs/hamster.nix b/nixos/modules/programs/hamster.nix index f50438cc17047..0bb56ad7ff36a 100644 --- a/nixos/modules/programs/hamster.nix +++ b/nixos/modules/programs/hamster.nix @@ -6,7 +6,7 @@ with lib; meta.maintainers = pkgs.hamster.meta.maintainers; options.programs.hamster.enable = - mkEnableOption (lib.mdDoc "hamster, a time tracking program"); + mkEnableOption "hamster, a time tracking program"; config = lib.mkIf config.programs.hamster.enable { environment.systemPackages = [ pkgs.hamster ]; diff --git a/nixos/modules/programs/htop.nix b/nixos/modules/programs/htop.nix index 9dbab954b2bbb..bf3d851081706 100644 --- a/nixos/modules/programs/htop.nix +++ b/nixos/modules/programs/htop.nix @@ -20,7 +20,7 @@ in options.programs.htop = { package = mkPackageOption pkgs "htop" { }; - enable = mkEnableOption (lib.mdDoc "htop process monitor"); + enable = mkEnableOption "htop process monitor"; settings = mkOption { type = with types; attrsOf (oneOf [ str int bool (listOf (oneOf [ str int bool ])) ]); @@ -29,7 +29,7 @@ in hide_kernel_threads = true; hide_userland_threads = true; }; - description = lib.mdDoc '' + description = '' Extra global default configuration for htop which is read on first startup only. Htop subsequently uses ~/.config/htop/htoprc diff --git a/nixos/modules/programs/i3lock.nix b/nixos/modules/programs/i3lock.nix index 44e2e04c2799d..8068ecaf08ca7 100644 --- a/nixos/modules/programs/i3lock.nix +++ b/nixos/modules/programs/i3lock.nix @@ -12,7 +12,7 @@ in { options = { programs.i3lock = { - enable = mkEnableOption (mdDoc "i3lock"); + enable = mkEnableOption "i3lock"; package = mkPackageOption pkgs "i3lock" { example = "i3lock-color"; extraDescription = '' @@ -25,7 +25,7 @@ in { type = types.bool; default = false; example = true; - description = mdDoc '' + description = '' Whether to enable U2F support in the i3lock program. U2F enables authentication using a hardware device, such as a security key. When U2F support is enabled, the i3lock program will set the setuid bit on the i3lock binary and enable the pam u2fAuth service, diff --git a/nixos/modules/programs/iay.nix b/nixos/modules/programs/iay.nix index a27f2520fd6ac..bbd401144311c 100644 --- a/nixos/modules/programs/iay.nix +++ b/nixos/modules/programs/iay.nix @@ -5,13 +5,13 @@ let inherit (lib) mkEnableOption mkIf mkOption mkPackageOption optionalString types; in { options.programs.iay = { - enable = mkEnableOption (lib.mdDoc "iay, a minimalistic shell prompt"); + enable = mkEnableOption "iay, a minimalistic shell prompt"; package = mkPackageOption pkgs "iay" {}; minimalPrompt = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Use minimal one-liner prompt."; + description = "Use minimal one-liner prompt."; }; }; diff --git a/nixos/modules/programs/iftop.nix b/nixos/modules/programs/iftop.nix index 1db018858b65b..c74714a9a6d64 100644 --- a/nixos/modules/programs/iftop.nix +++ b/nixos/modules/programs/iftop.nix @@ -6,7 +6,7 @@ let cfg = config.programs.iftop; in { options = { - programs.iftop.enable = mkEnableOption (lib.mdDoc "iftop + setcap wrapper"); + programs.iftop.enable = mkEnableOption "iftop + setcap wrapper"; }; config = mkIf cfg.enable { environment.systemPackages = [ pkgs.iftop ]; diff --git a/nixos/modules/programs/iotop.nix b/nixos/modules/programs/iotop.nix index 0eb60b989eb3f..b7c1c69f9ddd0 100644 --- a/nixos/modules/programs/iotop.nix +++ b/nixos/modules/programs/iotop.nix @@ -6,7 +6,7 @@ let cfg = config.programs.iotop; in { options = { - programs.iotop.enable = mkEnableOption (lib.mdDoc "iotop + setcap wrapper"); + programs.iotop.enable = mkEnableOption "iotop + setcap wrapper"; }; config = mkIf cfg.enable { security.wrappers.iotop = { diff --git a/nixos/modules/programs/java.nix b/nixos/modules/programs/java.nix index 251192183ebf0..f201f67b42e46 100644 --- a/nixos/modules/programs/java.nix +++ b/nixos/modules/programs/java.nix @@ -14,8 +14,8 @@ in programs.java = { - enable = mkEnableOption (lib.mdDoc "java") // { - description = lib.mdDoc '' + enable = mkEnableOption "java" // { + description = '' Install and setup the Java development kit. ::: {.note} @@ -34,7 +34,7 @@ in example = "jre"; }; - binfmt = mkEnableOption (lib.mdDoc "binfmt to execute java jar's and classes"); + binfmt = mkEnableOption "binfmt to execute java jar's and classes"; }; diff --git a/nixos/modules/programs/joycond-cemuhook.nix b/nixos/modules/programs/joycond-cemuhook.nix index 7b129868db28c..ebb0198ee60c0 100644 --- a/nixos/modules/programs/joycond-cemuhook.nix +++ b/nixos/modules/programs/joycond-cemuhook.nix @@ -2,7 +2,7 @@ with lib; { options.programs.joycond-cemuhook = { - enable = mkEnableOption (lib.mdDoc "joycond-cemuhook, a program to enable support for cemuhook's UDP protocol for joycond devices."); + enable = mkEnableOption "joycond-cemuhook, a program to enable support for cemuhook's UDP protocol for joycond devices."; }; config = lib.mkIf config.programs.joycond-cemuhook.enable { diff --git a/nixos/modules/programs/k3b.nix b/nixos/modules/programs/k3b.nix index 5d19e4f1cc4fb..4d6385dab4f07 100644 --- a/nixos/modules/programs/k3b.nix +++ b/nixos/modules/programs/k3b.nix @@ -8,7 +8,7 @@ with lib; enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to enable k3b, the KDE disk burning application. Additionally to installing `k3b` enabling this will diff --git a/nixos/modules/programs/k40-whisperer.nix b/nixos/modules/programs/k40-whisperer.nix index 96cf159f2cf7d..156ded6c39fe8 100644 --- a/nixos/modules/programs/k40-whisperer.nix +++ b/nixos/modules/programs/k40-whisperer.nix @@ -10,11 +10,11 @@ let in { options.programs.k40-whisperer = { - enable = mkEnableOption (lib.mdDoc "K40-Whisperer"); + enable = mkEnableOption "K40-Whisperer"; group = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Group assigned to the device when connected. ''; default = "k40"; diff --git a/nixos/modules/programs/kbdlight.nix b/nixos/modules/programs/kbdlight.nix index 6c3c79ddb4aa9..8a2a0057cf2da 100644 --- a/nixos/modules/programs/kbdlight.nix +++ b/nixos/modules/programs/kbdlight.nix @@ -7,7 +7,7 @@ let in { - options.programs.kbdlight.enable = mkEnableOption (lib.mdDoc "kbdlight"); + options.programs.kbdlight.enable = mkEnableOption "kbdlight"; config = mkIf cfg.enable { environment.systemPackages = [ pkgs.kbdlight ]; diff --git a/nixos/modules/programs/kclock.nix b/nixos/modules/programs/kclock.nix index 63d6fb1e2d7fa..c2299a3f1b034 100644 --- a/nixos/modules/programs/kclock.nix +++ b/nixos/modules/programs/kclock.nix @@ -4,7 +4,7 @@ let cfg = config.programs.kclock; kclockPkg = pkgs.libsForQt5.kclock; in { - options.programs.kclock = { enable = mkEnableOption (lib.mdDoc "KClock"); }; + options.programs.kclock = { enable = mkEnableOption "KClock"; }; config = mkIf cfg.enable { services.dbus.packages = [ kclockPkg ]; diff --git a/nixos/modules/programs/kdeconnect.nix b/nixos/modules/programs/kdeconnect.nix index 8cdf1eb4e6452..1431281405968 100644 --- a/nixos/modules/programs/kdeconnect.nix +++ b/nixos/modules/programs/kdeconnect.nix @@ -2,7 +2,7 @@ with lib; { options.programs.kdeconnect = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' kdeconnect. Note that it will open the TCP and UDP port from @@ -10,7 +10,7 @@ with lib; You can use the {option}`package` to use `gnomeExtensions.gsconnect` as an alternative implementation if you use Gnome - ''); + ''; package = mkPackageOption pkgs [ "plasma5Packages" "kdeconnect-kde" ] { example = "gnomeExtensions.gsconnect"; }; diff --git a/nixos/modules/programs/kubeswitch.nix b/nixos/modules/programs/kubeswitch.nix index ba2d25fbeb455..304df48e3c11a 100644 --- a/nixos/modules/programs/kubeswitch.nix +++ b/nixos/modules/programs/kubeswitch.nix @@ -10,7 +10,7 @@ in { options = { programs.kubeswitch = { - enable = lib.mkEnableOption (lib.mdDoc "kubeswitch"); + enable = lib.mkEnableOption "kubeswitch"; commandName = lib.mkOption { type = lib.types.str; diff --git a/nixos/modules/programs/less.nix b/nixos/modules/programs/less.nix index 6aa08d136a113..2cb7620075118 100644 --- a/nixos/modules/programs/less.nix +++ b/nixos/modules/programs/less.nix @@ -35,13 +35,13 @@ in # note that environment.nix sets PAGER=less, and # therefore also enables this module - enable = mkEnableOption (lib.mdDoc "less, a file pager"); + enable = mkEnableOption "less, a file pager"; configFile = mkOption { type = types.nullOr types.path; default = null; example = literalExpression ''"''${pkgs.my-configs}/lesskey"''; - description = lib.mdDoc '' + description = '' Path to lesskey configuration file. {option}`configFile` takes precedence over {option}`commands`, @@ -57,13 +57,13 @@ in h = "noaction 5\\e("; l = "noaction 5\\e)"; }; - description = lib.mdDoc "Defines new command keys."; + description = "Defines new command keys."; }; clearDefaultCommands = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Clear all default commands. You should remember to set the quit key. Otherwise you will not be able to leave less without killing it. @@ -76,7 +76,7 @@ in example = { e = "abort"; }; - description = lib.mdDoc "Defines new line-editing keys."; + description = "Defines new line-editing keys."; }; envVariables = mkOption { @@ -87,14 +87,14 @@ in example = { LESS = "--quit-if-one-screen"; }; - description = lib.mdDoc "Defines environment variables."; + description = "Defines environment variables."; }; lessopen = mkOption { type = types.nullOr types.str; default = "|${pkgs.lesspipe}/bin/lesspipe.sh %s"; defaultText = literalExpression ''"|''${pkgs.lesspipe}/bin/lesspipe.sh %s"''; - description = lib.mdDoc '' + description = '' Before less opens a file, it first gives your input preprocessor a chance to modify the way the contents of the file are displayed. ''; }; @@ -102,7 +102,7 @@ in lessclose = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' When less closes a file opened in such a way, it will call another program, called the input postprocessor, which may perform any desired clean-up action (such as deleting the replacement file created by LESSOPEN). ''; diff --git a/nixos/modules/programs/liboping.nix b/nixos/modules/programs/liboping.nix index 39e75ba90c9d8..4433f9767d6ee 100644 --- a/nixos/modules/programs/liboping.nix +++ b/nixos/modules/programs/liboping.nix @@ -6,7 +6,7 @@ let cfg = config.programs.liboping; in { options.programs.liboping = { - enable = mkEnableOption (lib.mdDoc "liboping"); + enable = mkEnableOption "liboping"; }; config = mkIf cfg.enable { environment.systemPackages = with pkgs; [ liboping ]; diff --git a/nixos/modules/programs/light.nix b/nixos/modules/programs/light.nix index 1cdf22a7699da..b1584a1b3d28c 100644 --- a/nixos/modules/programs/light.nix +++ b/nixos/modules/programs/light.nix @@ -13,7 +13,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to install Light backlight control command and udev rules granting access to members of the "video" group. ''; diff --git a/nixos/modules/programs/mdevctl.nix b/nixos/modules/programs/mdevctl.nix index 2b72852333508..be33835639d2e 100644 --- a/nixos/modules/programs/mdevctl.nix +++ b/nixos/modules/programs/mdevctl.nix @@ -5,7 +5,7 @@ let cfg = config.programs.mdevctl; in { options.programs.mdevctl = { - enable = mkEnableOption (lib.mdDoc "Mediated Device Management"); + enable = mkEnableOption "Mediated Device Management"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/mepo.nix b/nixos/modules/programs/mepo.nix index 92ce6e5fa578a..22596892ff5dc 100644 --- a/nixos/modules/programs/mepo.nix +++ b/nixos/modules/programs/mepo.nix @@ -5,13 +5,13 @@ let in { options.programs.mepo = { - enable = mkEnableOption (mdDoc "Mepo, a fast, simple and hackable OSM map viewer"); + enable = mkEnableOption "Mepo, a fast, simple and hackable OSM map viewer"; locationBackends = { gpsd = mkOption { type = types.bool; default = false; - description = mdDoc '' + description = '' Whether to enable location detection via gpsd. This may require additional configuration of gpsd, see [here](#opt-services.gpsd.enable) ''; @@ -20,7 +20,7 @@ in geoclue = mkOption { type = types.bool; default = true; - description = mdDoc "Whether to enable location detection via geoclue"; + description = "Whether to enable location detection via geoclue"; }; }; }; diff --git a/nixos/modules/programs/mininet.nix b/nixos/modules/programs/mininet.nix index 128a9cd45320c..a9190ed989007 100644 --- a/nixos/modules/programs/mininet.nix +++ b/nixos/modules/programs/mininet.nix @@ -8,7 +8,7 @@ let cfg = config.programs.mininet; in { - options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet, an emulator for rapid prototyping of Software Defined Networks"); + options.programs.mininet.enable = mkEnableOption "Mininet, an emulator for rapid prototyping of Software Defined Networks"; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/minipro.nix b/nixos/modules/programs/minipro.nix index 56920656f23df..e5846d13fa40f 100644 --- a/nixos/modules/programs/minipro.nix +++ b/nixos/modules/programs/minipro.nix @@ -6,8 +6,8 @@ in { options = { programs.minipro = { - enable = lib.mkEnableOption (lib.mdDoc "minipro") // { - description = lib.mdDoc '' + enable = lib.mkEnableOption "minipro" // { + description = '' Whether to enable minipro and its udev rules. Users of the `plugdev` group can interact with connected MiniPRO chip programmers. ''; diff --git a/nixos/modules/programs/miriway.nix b/nixos/modules/programs/miriway.nix index 010ab984fc1b0..00c1356ab0836 100644 --- a/nixos/modules/programs/miriway.nix +++ b/nixos/modules/programs/miriway.nix @@ -4,12 +4,12 @@ let cfg = config.programs.miriway; in { options.programs.miriway = { - enable = lib.mkEnableOption (lib.mdDoc '' + enable = lib.mkEnableOption '' Miriway, a Mir based Wayland compositor. You can manually launch Miriway by executing "exec miriway" on a TTY, or launch it from a display manager. Copy /etc/xdg/xdg-miriway/miriway-shell.config to ~/.config/miriway-shell.config to modify the system-wide configuration on a per-user basis. See <https://github.com/Miriway/Miriway>, - and "miriway --help" for more information''); + and "miriway --help" for more information''; config = lib.mkOption { type = lib.types.lines; @@ -50,7 +50,7 @@ in { meta=Page_Down:@workspace-down ctrl-alt=BackSpace:@exit ''; - description = lib.mdDoc '' + description = '' Miriway's config. This will be installed system-wide. The default will install the miriway package's barebones example config. ''; diff --git a/nixos/modules/programs/mosh.nix b/nixos/modules/programs/mosh.nix index 593246ab6dcd1..897bcf941a5d0 100644 --- a/nixos/modules/programs/mosh.nix +++ b/nixos/modules/programs/mosh.nix @@ -13,7 +13,7 @@ in default = true; }; withUtempter = lib.mkEnableOption "" // { - description = lib.mdDoc '' + description = '' Whether to enable libutempter for mosh. This is required so that mosh can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions). diff --git a/nixos/modules/programs/msmtp.nix b/nixos/modules/programs/msmtp.nix index a9aed027bdb76..9c067bdc96957 100644 --- a/nixos/modules/programs/msmtp.nix +++ b/nixos/modules/programs/msmtp.nix @@ -10,12 +10,12 @@ in { options = { programs.msmtp = { - enable = mkEnableOption (lib.mdDoc "msmtp - an SMTP client"); + enable = mkEnableOption "msmtp - an SMTP client"; setSendmail = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to set the system sendmail to msmtp's. ''; }; @@ -28,7 +28,7 @@ in { port = 587; tls = true; }; - description = lib.mdDoc '' + description = '' Default values applied to all accounts. See msmtp(1) for the available options. ''; @@ -45,7 +45,7 @@ in { passwordeval = "cat /secrets/password.txt"; }; }; - description = lib.mdDoc '' + description = '' Named accounts and their respective configurations. The special name "default" allows a default account to be defined. See msmtp(1) for the available options. @@ -62,7 +62,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra lines to add to the msmtp configuration verbatim. See msmtp(1) for the syntax and available options. ''; diff --git a/nixos/modules/programs/mtr.nix b/nixos/modules/programs/mtr.nix index e247d645b8618..6a767df15f098 100644 --- a/nixos/modules/programs/mtr.nix +++ b/nixos/modules/programs/mtr.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to add mtr to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/nano.nix b/nixos/modules/programs/nano.nix index 225fa4f2568de..10fa2a0dfbcdf 100644 --- a/nixos/modules/programs/nano.nix +++ b/nixos/modules/programs/nano.nix @@ -7,7 +7,7 @@ in { options = { programs.nano = { - enable = lib.mkEnableOption (lib.mdDoc "nano, a small user-friendly console text editor") // { + enable = lib.mkEnableOption "nano, a small user-friendly console text editor" // { default = true; }; @@ -16,7 +16,7 @@ in nanorc = lib.mkOption { type = lib.types.lines; default = ""; - description = lib.mdDoc '' + description = '' The system-wide nano configuration. See {manpage}`nanorc(5)`. ''; @@ -30,7 +30,7 @@ in syntaxHighlight = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc "Whether to enable syntax highlight for various languages."; + description = "Whether to enable syntax highlight for various languages."; }; }; }; diff --git a/nixos/modules/programs/nautilus-open-any-terminal.nix b/nixos/modules/programs/nautilus-open-any-terminal.nix index d205fb3ec916f..8a38c4cb5e483 100644 --- a/nixos/modules/programs/nautilus-open-any-terminal.nix +++ b/nixos/modules/programs/nautilus-open-any-terminal.nix @@ -5,12 +5,12 @@ let in { options.programs.nautilus-open-any-terminal = { - enable = lib.mkEnableOption (lib.mdDoc "nautilus-open-any-terminal"); + enable = lib.mkEnableOption "nautilus-open-any-terminal"; terminal = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = lib.mdDoc '' + description = '' The terminal emulator to add to context-entry of nautilus. Supported terminal emulators are listed in https://github.com/Stunkymonkey/nautilus-open-any-terminal#supported-terminal-emulators. ''; diff --git a/nixos/modules/programs/nbd.nix b/nixos/modules/programs/nbd.nix index a44403021e352..fea9bc1ff71a1 100644 --- a/nixos/modules/programs/nbd.nix +++ b/nixos/modules/programs/nbd.nix @@ -8,7 +8,7 @@ in { options = { programs.nbd = { - enable = mkEnableOption (lib.mdDoc "Network Block Device (nbd) support"); + enable = mkEnableOption "Network Block Device (nbd) support"; }; }; diff --git a/nixos/modules/programs/neovim.nix b/nixos/modules/programs/neovim.nix index 77abec7ef7e90..6f6829444a641 100644 --- a/nixos/modules/programs/neovim.nix +++ b/nixos/modules/programs/neovim.nix @@ -11,7 +11,7 @@ in type = types.bool; default = false; example = true; - description = lib.mdDoc '' + description = '' Whether to enable Neovim. When enabled through this option, Neovim is wrapped to use a @@ -24,7 +24,7 @@ in defaultEditor = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' When enabled, installs neovim and configures neovim to be the default editor using the EDITOR environment variable. ''; @@ -33,7 +33,7 @@ in viAlias = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Symlink {command}`vi` to {command}`nvim` binary. ''; }; @@ -41,7 +41,7 @@ in vimAlias = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Symlink {command}`vim` to {command}`nvim` binary. ''; }; @@ -49,19 +49,19 @@ in withRuby = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Enable Ruby provider."; + description = "Enable Ruby provider."; }; withPython3 = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Enable Python 3 provider."; + description = "Enable Python 3 provider."; }; withNodeJs = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Enable Node provider."; + description = "Enable Node provider."; }; configure = mkOption { @@ -80,7 +80,7 @@ in }; } ''; - description = lib.mdDoc '' + description = '' Generate your init file from your list of plugins and custom commands. Neovim will then be wrapped to load {command}`nvim -u /nix/store/«hash»-vimrc` ''; @@ -92,7 +92,7 @@ in type = types.package; visible = false; readOnly = true; - description = lib.mdDoc "Resulting customized neovim package."; + description = "Resulting customized neovim package."; }; runtime = mkOption { @@ -100,7 +100,7 @@ in example = literalExpression '' { "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; } ''; - description = lib.mdDoc '' + description = '' Set of files that have to be linked in {file}`runtime`. ''; @@ -112,7 +112,7 @@ in enable = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether this runtime directory should be generated. This option allows specific runtime files to be disabled. ''; @@ -120,7 +120,7 @@ in target = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Name of symlink. Defaults to the attribute name. ''; @@ -129,13 +129,13 @@ in text = mkOption { default = null; type = types.nullOr types.lines; - description = lib.mdDoc "Text of the file."; + description = "Text of the file."; }; source = mkOption { default = null; type = types.nullOr types.path; - description = lib.mdDoc "Path of the source file."; + description = "Path of the source file."; }; }; diff --git a/nixos/modules/programs/nethoscope.nix b/nixos/modules/programs/nethoscope.nix index d8ece61c90a2b..495548e9c6561 100644 --- a/nixos/modules/programs/nethoscope.nix +++ b/nixos/modules/programs/nethoscope.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to add nethoscope to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/nexttrace.nix b/nixos/modules/programs/nexttrace.nix index 09143c5f861db..9380a988088bf 100644 --- a/nixos/modules/programs/nexttrace.nix +++ b/nixos/modules/programs/nexttrace.nix @@ -7,7 +7,7 @@ in { options = { programs.nexttrace = { - enable = lib.mkEnableOption (lib.mdDoc "Nexttrace to the global environment and configure a setcap wrapper for it"); + enable = lib.mkEnableOption "Nexttrace to the global environment and configure a setcap wrapper for it"; package = lib.mkPackageOption pkgs "nexttrace" { }; }; }; diff --git a/nixos/modules/programs/nix-index.nix b/nixos/modules/programs/nix-index.nix index f3e7d22737fa9..76d7c3d8c532a 100644 --- a/nixos/modules/programs/nix-index.nix +++ b/nixos/modules/programs/nix-index.nix @@ -3,19 +3,19 @@ let cfg = config.programs.nix-index; in { options.programs.nix-index = with lib; { - enable = mkEnableOption (lib.mdDoc "nix-index, a file database for nixpkgs"); + enable = mkEnableOption "nix-index, a file database for nixpkgs"; package = mkPackageOption pkgs "nix-index" { }; - enableBashIntegration = mkEnableOption (lib.mdDoc "Bash integration") // { + enableBashIntegration = mkEnableOption "Bash integration" // { default = true; }; - enableZshIntegration = mkEnableOption (lib.mdDoc "Zsh integration") // { + enableZshIntegration = mkEnableOption "Zsh integration" // { default = true; }; - enableFishIntegration = mkEnableOption (lib.mdDoc "Fish integration") // { + enableFishIntegration = mkEnableOption "Fish integration" // { default = true; }; }; diff --git a/nixos/modules/programs/nix-ld.nix b/nixos/modules/programs/nix-ld.nix index b095437733cce..770cccd13b504 100644 --- a/nixos/modules/programs/nix-ld.nix +++ b/nixos/modules/programs/nix-ld.nix @@ -17,11 +17,11 @@ in { meta.maintainers = [ lib.maintainers.mic92 ]; options.programs.nix-ld = { - enable = lib.mkEnableOption (lib.mdDoc ''nix-ld, Documentation: <https://github.com/Mic92/nix-ld>''); + enable = lib.mkEnableOption ''nix-ld, Documentation: <https://github.com/Mic92/nix-ld>''; package = lib.mkPackageOption pkgs "nix-ld" { }; libraries = lib.mkOption { type = lib.types.listOf lib.types.package; - description = lib.mdDoc "Libraries that automatically become available to all programs. The default set includes common libraries."; + description = "Libraries that automatically become available to all programs. The default set includes common libraries."; default = [ ]; defaultText = lib.literalExpression "baseLibraries derived from systemd and nix dependencies."; }; diff --git a/nixos/modules/programs/nm-applet.nix b/nixos/modules/programs/nm-applet.nix index 3ff27cd742771..ed048192e2e03 100644 --- a/nixos/modules/programs/nm-applet.nix +++ b/nixos/modules/programs/nm-applet.nix @@ -6,12 +6,12 @@ }; options.programs.nm-applet = { - enable = lib.mkEnableOption (lib.mdDoc "nm-applet, a NetworkManager control applet for GNOME"); + enable = lib.mkEnableOption "nm-applet, a NetworkManager control applet for GNOME"; indicator = lib.mkOption { type = lib.types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to use indicator instead of status icon. It is needed for Appindicator environments, like Enlightenment. ''; diff --git a/nixos/modules/programs/nncp.nix b/nixos/modules/programs/nncp.nix index e078b718410c5..aa2e7c7a6e5b5 100644 --- a/nixos/modules/programs/nncp.nix +++ b/nixos/modules/programs/nncp.nix @@ -11,12 +11,12 @@ in { options.programs.nncp = { enable = - mkEnableOption (lib.mdDoc "NNCP (Node to Node copy) utilities and configuration"); + mkEnableOption "NNCP (Node to Node copy) utilities and configuration"; group = mkOption { type = types.str; default = "uucp"; - description = lib.mdDoc '' + description = '' The group under which NNCP files shall be owned. Any member of this group may access the secret keys of this NNCP node. @@ -28,7 +28,7 @@ in { secrets = mkOption { type = with types; listOf str; example = [ "/run/keys/nncp.hjson" ]; - description = lib.mdDoc '' + description = '' A list of paths to NNCP configuration files that should not be in the Nix store. These files are layered on top of the values at [](#opt-programs.nncp.settings). @@ -37,7 +37,7 @@ in { settings = mkOption { type = settingsFormat.type; - description = lib.mdDoc '' + description = '' NNCP configuration, see <http://www.nncpgo.org/Configuration.html>. At runtime these settings will be overlayed by the contents of diff --git a/nixos/modules/programs/noisetorch.nix b/nixos/modules/programs/noisetorch.nix index 84bc78ce3839d..70a0441bd7677 100644 --- a/nixos/modules/programs/noisetorch.nix +++ b/nixos/modules/programs/noisetorch.nix @@ -6,7 +6,7 @@ let cfg = config.programs.noisetorch; in { options.programs.noisetorch = { - enable = mkEnableOption (lib.mdDoc "noisetorch (+ setcap wrapper), a virtual microphone device with noise suppression"); + enable = mkEnableOption "noisetorch (+ setcap wrapper), a virtual microphone device with noise suppression"; package = mkPackageOption pkgs "noisetorch" { }; }; diff --git a/nixos/modules/programs/npm.nix b/nixos/modules/programs/npm.nix index 8113ea1ba4ea6..b379f0165bfed 100644 --- a/nixos/modules/programs/npm.nix +++ b/nixos/modules/programs/npm.nix @@ -11,7 +11,7 @@ in options = { programs.npm = { - enable = mkEnableOption (lib.mdDoc "{command}`npm` global config"); + enable = mkEnableOption "{command}`npm` global config"; package = mkPackageOption pkgs [ "nodePackages" "npm" ] { example = "nodePackages_13_x.npm"; @@ -19,7 +19,7 @@ in npmrc = mkOption { type = lib.types.lines; - description = lib.mdDoc '' + description = '' The system-wide npm configuration. See <https://docs.npmjs.com/misc/config>. ''; diff --git a/nixos/modules/programs/ns-usbloader.nix b/nixos/modules/programs/ns-usbloader.nix index 8d0b698d6b4cc..1f4b931e1cc11 100644 --- a/nixos/modules/programs/ns-usbloader.nix +++ b/nixos/modules/programs/ns-usbloader.nix @@ -5,7 +5,7 @@ in { options = { programs.ns-usbloader = { - enable = lib.mkEnableOption (lib.mdDoc "ns-usbloader application with udev rules applied"); + enable = lib.mkEnableOption "ns-usbloader application with udev rules applied"; }; }; diff --git a/nixos/modules/programs/openvpn3.nix b/nixos/modules/programs/openvpn3.nix index 37a1bfeb0c3e6..6415cccecb4ff 100644 --- a/nixos/modules/programs/openvpn3.nix +++ b/nixos/modules/programs/openvpn3.nix @@ -7,7 +7,7 @@ let in { options.programs.openvpn3 = { - enable = mkEnableOption (lib.mdDoc "the openvpn3 client"); + enable = mkEnableOption "the openvpn3 client"; package = mkOption { type = types.package; default = pkgs.openvpn3.override { @@ -16,7 +16,7 @@ in defaultText = literalExpression ''pkgs.openvpn3.override { enableSystemdResolved = config.services.resolved.enable; }''; - description = lib.mdDoc '' + description = '' Which package to use for `openvpn3`. ''; }; diff --git a/nixos/modules/programs/pantheon-tweaks.nix b/nixos/modules/programs/pantheon-tweaks.nix index 82f93619db158..0b8a19ea22c01 100644 --- a/nixos/modules/programs/pantheon-tweaks.nix +++ b/nixos/modules/programs/pantheon-tweaks.nix @@ -9,7 +9,7 @@ with lib; ###### interface options = { - programs.pantheon-tweaks.enable = mkEnableOption (lib.mdDoc "Pantheon Tweaks, an unofficial system settings panel for Pantheon"); + programs.pantheon-tweaks.enable = mkEnableOption "Pantheon Tweaks, an unofficial system settings panel for Pantheon"; }; ###### implementation diff --git a/nixos/modules/programs/partition-manager.nix b/nixos/modules/programs/partition-manager.nix index 63b637f9952b8..1a66a3f04c41a 100644 --- a/nixos/modules/programs/partition-manager.nix +++ b/nixos/modules/programs/partition-manager.nix @@ -7,7 +7,7 @@ in { options = { programs.partition-manager = { - enable = lib.mkEnableOption (lib.mdDoc "KDE Partition Manager"); + enable = lib.mkEnableOption "KDE Partition Manager"; package = lib.mkPackageOption pkgs [ "libsForQt5" "partitionmanager" ] { }; }; diff --git a/nixos/modules/programs/plotinus.nix b/nixos/modules/programs/plotinus.nix index c2b6884d6490d..41c75b69a2d2f 100644 --- a/nixos/modules/programs/plotinus.nix +++ b/nixos/modules/programs/plotinus.nix @@ -17,7 +17,7 @@ in programs.plotinus = { enable = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to enable the Plotinus GTK 3 plugin. Plotinus provides a popup (triggered by Ctrl-Shift-P) to search the menus of a compatible application. diff --git a/nixos/modules/programs/projecteur.nix b/nixos/modules/programs/projecteur.nix index 8f7985a3750d2..af186e3d250bc 100644 --- a/nixos/modules/programs/projecteur.nix +++ b/nixos/modules/programs/projecteur.nix @@ -5,7 +5,7 @@ let in { options.programs.projecteur = { - enable = lib.mkEnableOption (lib.mdDoc "projecteur, an application for the Logitech Spotlight device (and similar)"); + enable = lib.mkEnableOption "projecteur, an application for the Logitech Spotlight device (and similar)"; package = lib.mkPackageOption pkgs "projecteur" { }; }; diff --git a/nixos/modules/programs/proxychains.nix b/nixos/modules/programs/proxychains.nix index db693cd83b8f2..b15475dac075b 100644 --- a/nixos/modules/programs/proxychains.nix +++ b/nixos/modules/programs/proxychains.nix @@ -22,21 +22,21 @@ let proxyOptions = { options = { - enable = mkEnableOption (lib.mdDoc "this proxy"); + enable = mkEnableOption "this proxy"; type = mkOption { type = types.enum [ "http" "socks4" "socks5" ]; - description = lib.mdDoc "Proxy type."; + description = "Proxy type."; }; host = mkOption { type = types.str; - description = lib.mdDoc "Proxy host or IP address."; + description = "Proxy host or IP address."; }; port = mkOption { type = types.port; - description = lib.mdDoc "Proxy port"; + description = "Proxy port"; }; }; }; @@ -49,7 +49,7 @@ in { programs.proxychains = { - enable = mkEnableOption (lib.mdDoc "proxychains configuration"); + enable = mkEnableOption "proxychains configuration"; package = mkPackageOption pkgs "proxychains" { example = "proxychains-ng"; @@ -59,7 +59,7 @@ in { type = mkOption { type = types.enum [ "dynamic" "strict" "random" ]; default = "strict"; - description = lib.mdDoc '' + description = '' `dynamic` - Each connection will be done via chained proxies all proxies chained in the order as they appear in the list at least one proxy must be online to play in chain @@ -78,7 +78,7 @@ in { length = mkOption { type = types.nullOr types.int; default = null; - description = lib.mdDoc '' + description = '' Chain length for random chain. ''; }; @@ -87,15 +87,15 @@ in { proxyDNS = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Proxy DNS requests - no leak for DNS data."; + description = "Proxy DNS requests - no leak for DNS data."; }; - quietMode = mkEnableOption (lib.mdDoc "Quiet mode (no output from the library)"); + quietMode = mkEnableOption "Quiet mode (no output from the library)"; remoteDNSSubnet = mkOption { type = types.enum [ 10 127 224 ]; default = 224; - description = lib.mdDoc '' + description = '' Set the class A subnet number to use for the internal remote DNS mapping, uses the reserved 224.x.x.x range by default. ''; }; @@ -103,24 +103,24 @@ in { tcpReadTimeOut = mkOption { type = types.int; default = 15000; - description = lib.mdDoc "Connection read time-out in milliseconds."; + description = "Connection read time-out in milliseconds."; }; tcpConnectTimeOut = mkOption { type = types.int; default = 8000; - description = lib.mdDoc "Connection time-out in milliseconds."; + description = "Connection time-out in milliseconds."; }; localnet = mkOption { type = types.str; default = "127.0.0.0/255.0.0.0"; - description = lib.mdDoc "By default enable localnet for loopback address ranges."; + description = "By default enable localnet for loopback address ranges."; }; proxies = mkOption { type = types.attrsOf (types.submodule proxyOptions); - description = lib.mdDoc '' + description = '' Proxies to be used by proxychains. ''; diff --git a/nixos/modules/programs/qdmr.nix b/nixos/modules/programs/qdmr.nix index 03ad4d008873c..efd0e1fc98859 100644 --- a/nixos/modules/programs/qdmr.nix +++ b/nixos/modules/programs/qdmr.nix @@ -12,7 +12,7 @@ in { options = { programs.qdmr = { - enable = lib.mkEnableOption (lib.mdDoc "QDMR - a GUI application and command line tool for programming DMR radios"); + enable = lib.mkEnableOption "QDMR - a GUI application and command line tool for programming DMR radios"; package = lib.mkPackageOption pkgs "qdmr" { }; }; }; diff --git a/nixos/modules/programs/regreet.nix b/nixos/modules/programs/regreet.nix index 55d0c11781ab2..0db1f59e59121 100644 --- a/nixos/modules/programs/regreet.nix +++ b/nixos/modules/programs/regreet.nix @@ -10,7 +10,7 @@ in { options.programs.regreet = { enable = lib.mkEnableOption null // { - description = lib.mdDoc '' + description = '' Enable ReGreet, a clean and customizable greeter for greetd. To use ReGreet, {option}`services.greetd` has to be enabled and @@ -29,7 +29,7 @@ in settings = lib.mkOption { type = lib.types.either lib.types.path settingsFormat.type; default = { }; - description = lib.mdDoc '' + description = '' ReGreet configuration file. Refer <https://github.com/rharish101/ReGreet/blob/main/regreet.sample.toml> for options. @@ -43,7 +43,7 @@ in '' [ "-s" "-m" "last" ] ''; - description = lib.mdDoc '' + description = '' Additional arguments to be passed to [cage](https://github.com/cage-kiosk/cage). ''; @@ -52,7 +52,7 @@ in extraCss = lib.mkOption { type = lib.types.either lib.types.path lib.types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra CSS rules to apply on top of the GTK theme. Refer to [GTK CSS Properties](https://docs.gtk.org/gtk4/css-properties.html) for modifiable properties. diff --git a/nixos/modules/programs/rog-control-center.nix b/nixos/modules/programs/rog-control-center.nix index 4aef5143ac7ff..7413ca3daf05d 100644 --- a/nixos/modules/programs/rog-control-center.nix +++ b/nixos/modules/programs/rog-control-center.nix @@ -6,12 +6,12 @@ in { options = { programs.rog-control-center = { - enable = lib.mkEnableOption (lib.mdDoc "the rog-control-center application"); + enable = lib.mkEnableOption "the rog-control-center application"; autoStart = lib.mkOption { default = false; type = lib.types.bool; - description = lib.mdDoc "Whether rog-control-center should be started automatically."; + description = "Whether rog-control-center should be started automatically."; }; }; }; diff --git a/nixos/modules/programs/rust-motd.nix b/nixos/modules/programs/rust-motd.nix index 49f834596b67e..93240fcdd85ee 100644 --- a/nixos/modules/programs/rust-motd.nix +++ b/nixos/modules/programs/rust-motd.nix @@ -24,11 +24,11 @@ let ''; in { options.programs.rust-motd = { - enable = mkEnableOption (lib.mdDoc "rust-motd, a Message Of The Day (MOTD) generator"); + enable = mkEnableOption "rust-motd, a Message Of The Day (MOTD) generator"; enableMotdInSSHD = mkOption { default = true; type = types.bool; - description = mdDoc '' + description = '' Whether to let `openssh` print the result when entering a new `ssh`-session. By default either nothing or a static file defined via @@ -39,7 +39,7 @@ in { refreshInterval = mkOption { default = "*:0/5"; type = types.str; - description = mdDoc '' + description = '' Interval in which the {manpage}`motd(5)` file is refreshed. For possible formats, please refer to {manpage}`systemd.time(7)`. ''; @@ -48,7 +48,7 @@ in { type = types.listOf types.str; default = attrNames cfg.settings; defaultText = literalExpression "attrNames cfg.settings"; - description = mdDoc '' + description = '' The order of the sections in [](#opt-programs.rust-motd.settings). By default they are ordered alphabetically. @@ -81,7 +81,7 @@ in { }; settings = mkOption { type = types.attrsOf format.type; - description = mdDoc '' + description = '' Settings on what to generate. Please read the [upstream documentation](https://github.com/rust-motd/rust-motd/blob/main/README.md#configuration) for further information. diff --git a/nixos/modules/programs/screen.nix b/nixos/modules/programs/screen.nix index 41bfb5d7809af..01af5b4c9597a 100644 --- a/nixos/modules/programs/screen.nix +++ b/nixos/modules/programs/screen.nix @@ -7,7 +7,7 @@ in { options = { programs.screen = { - enable = lib.mkEnableOption (lib.mdDoc "screen, a basic terminal multiplexer"); + enable = lib.mkEnableOption "screen, a basic terminal multiplexer"; package = lib.mkPackageOptionMD pkgs "screen" { }; @@ -17,7 +17,7 @@ in defscrollback 10000 startup_message off ''; - description = lib.mdDoc "The contents of {file}`/etc/screenrc` file"; + description = "The contents of {file}`/etc/screenrc` file"; }; }; }; diff --git a/nixos/modules/programs/seahorse.nix b/nixos/modules/programs/seahorse.nix index 5e179c1446ed1..c0a356bff57c1 100644 --- a/nixos/modules/programs/seahorse.nix +++ b/nixos/modules/programs/seahorse.nix @@ -20,7 +20,7 @@ with lib; programs.seahorse = { - enable = mkEnableOption (lib.mdDoc "Seahorse, a GNOME application for managing encryption keys and passwords in the GNOME Keyring"); + enable = mkEnableOption "Seahorse, a GNOME application for managing encryption keys and passwords in the GNOME Keyring"; }; diff --git a/nixos/modules/programs/sedutil.nix b/nixos/modules/programs/sedutil.nix index 0ef2472667cbd..c62ca24eaa012 100644 --- a/nixos/modules/programs/sedutil.nix +++ b/nixos/modules/programs/sedutil.nix @@ -6,7 +6,7 @@ let cfg = config.programs.sedutil; in { - options.programs.sedutil.enable = mkEnableOption (lib.mdDoc "sedutil, to manage self encrypting drives that conform to the Trusted Computing Group OPAL 2.0 SSC specification"); + options.programs.sedutil.enable = mkEnableOption "sedutil, to manage self encrypting drives that conform to the Trusted Computing Group OPAL 2.0 SSC specification"; config = mkIf cfg.enable { boot.kernelParams = [ diff --git a/nixos/modules/programs/shadow.nix b/nixos/modules/programs/shadow.nix index b232767385c59..2d20644ec51ed 100644 --- a/nixos/modules/programs/shadow.nix +++ b/nixos/modules/programs/shadow.nix @@ -10,7 +10,7 @@ in package = mkPackageOption pkgs "shadow" { }; chfnRestrict = mkOption { - description = mdDoc '' + description = '' Use chfn SUID to allow non-root users to change their account GECOS information. ''; type = nullOr str; @@ -18,7 +18,7 @@ in }; settings = mkOption { - description = mdDoc '' + description = '' Config options for the /etc/login.defs file, that defines the site-specific configuration for the shadow password suite. See login.defs(5) man page for available options. @@ -36,68 +36,68 @@ in */ options = { DEFAULT_HOME = mkOption { - description = mdDoc "Indicate if login is allowed if we can't cd to the home directory."; + description = "Indicate if login is allowed if we can't cd to the home directory."; default = "yes"; type = enum [ "yes" "no" ]; }; ENCRYPT_METHOD = mkOption { - description = mdDoc "This defines the system default encryption algorithm for encrypting passwords."; + description = "This defines the system default encryption algorithm for encrypting passwords."; # The default crypt() method, keep in sync with the PAM default default = "YESCRYPT"; type = enum [ "YESCRYPT" "SHA512" "SHA256" "MD5" "DES"]; }; SYS_UID_MIN = mkOption { - description = mdDoc "Range of user IDs used for the creation of system users by useradd or newusers."; + description = "Range of user IDs used for the creation of system users by useradd or newusers."; default = 400; type = int; }; SYS_UID_MAX = mkOption { - description = mdDoc "Range of user IDs used for the creation of system users by useradd or newusers."; + description = "Range of user IDs used for the creation of system users by useradd or newusers."; default = 999; type = int; }; UID_MIN = mkOption { - description = mdDoc "Range of user IDs used for the creation of regular users by useradd or newusers."; + description = "Range of user IDs used for the creation of regular users by useradd or newusers."; default = 1000; type = int; }; UID_MAX = mkOption { - description = mdDoc "Range of user IDs used for the creation of regular users by useradd or newusers."; + description = "Range of user IDs used for the creation of regular users by useradd or newusers."; default = 29999; type = int; }; SYS_GID_MIN = mkOption { - description = mdDoc "Range of group IDs used for the creation of system groups by useradd, groupadd, or newusers"; + description = "Range of group IDs used for the creation of system groups by useradd, groupadd, or newusers"; default = 400; type = int; }; SYS_GID_MAX = mkOption { - description = mdDoc "Range of group IDs used for the creation of system groups by useradd, groupadd, or newusers"; + description = "Range of group IDs used for the creation of system groups by useradd, groupadd, or newusers"; default = 999; type = int; }; GID_MIN = mkOption { - description = mdDoc "Range of group IDs used for the creation of regular groups by useradd, groupadd, or newusers."; + description = "Range of group IDs used for the creation of regular groups by useradd, groupadd, or newusers."; default = 1000; type = int; }; GID_MAX = mkOption { - description = mdDoc "Range of group IDs used for the creation of regular groups by useradd, groupadd, or newusers."; + description = "Range of group IDs used for the creation of regular groups by useradd, groupadd, or newusers."; default = 29999; type = int; }; TTYGROUP = mkOption { - description = mdDoc '' + description = '' The terminal permissions: the login tty will be owned by the TTYGROUP group, and the permissions will be set to TTYPERM''; default = "tty"; @@ -105,7 +105,7 @@ in }; TTYPERM = mkOption { - description = mdDoc '' + description = '' The terminal permissions: the login tty will be owned by the TTYGROUP group, and the permissions will be set to TTYPERM''; default = "0620"; @@ -114,7 +114,7 @@ in # Ensure privacy for newly created home directories. UMASK = mkOption { - description = mdDoc "The file mode creation mask is initialized to this value."; + description = "The file mode creation mask is initialized to this value."; default = "077"; type = str; }; @@ -125,7 +125,7 @@ in }; users.defaultUserShell = mkOption { - description = mdDoc '' + description = '' This option defines the default shell assigned to user accounts. This can be either a full system path or a shell package. diff --git a/nixos/modules/programs/sharing.nix b/nixos/modules/programs/sharing.nix index 9ab51859dc51d..211dc9815166e 100644 --- a/nixos/modules/programs/sharing.nix +++ b/nixos/modules/programs/sharing.nix @@ -2,11 +2,11 @@ with lib; { options.programs.sharing = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' sharing, a CLI tool for sharing files. Note that it will opens the 7478 port for TCP in the firewall, which is needed for it to function properly - ''); + ''; }; config = let diff --git a/nixos/modules/programs/singularity.nix b/nixos/modules/programs/singularity.nix index 7f285ab05537a..981417389eb22 100644 --- a/nixos/modules/programs/singularity.nix +++ b/nixos/modules/programs/singularity.nix @@ -7,8 +7,8 @@ in { options.programs.singularity = { - enable = mkEnableOption (mdDoc "singularity") // { - description = mdDoc '' + enable = mkEnableOption "singularity" // { + description = '' Whether to install Singularity/Apptainer with system-level overriding such as SUID support. ''; }; @@ -18,7 +18,7 @@ in packageOverriden = mkOption { type = types.nullOr types.package; default = null; - description = mdDoc '' + description = '' This option provides access to the overridden result of `programs.singularity.package`. For example, the following configuration makes all the Nixpkgs packages use the overridden `singularity`: @@ -43,7 +43,7 @@ in type = types.bool; default = true; example = false; - description = mdDoc '' + description = '' Whether to use top-level directories as LOCALSTATEDIR instead of the store path ones. This affects the SESSIONDIR of Apptainer/Singularity. @@ -55,7 +55,7 @@ in type = types.bool; default = true; example = false; - description = mdDoc '' + description = '' Whether to enable the `--fakeroot` support of Singularity/Apptainer. ''; }; @@ -68,7 +68,7 @@ in default = cfg.package.projectName != "apptainer"; defaultText = literalExpression ''config.services.singularity.package.projectName != "apptainer"''; example = false; - description = mdDoc '' + description = '' Whether to enable the SUID support of Singularity/Apptainer. ''; }; diff --git a/nixos/modules/programs/skim.nix b/nixos/modules/programs/skim.nix index 57a5d68ec3d5a..9c573b39bbbc7 100644 --- a/nixos/modules/programs/skim.nix +++ b/nixos/modules/programs/skim.nix @@ -1,13 +1,13 @@ { pkgs, config, lib, ... }: let - inherit (lib) mdDoc mkEnableOption mkPackageOption optional optionalString; + inherit (lib) mkEnableOption mkPackageOption optional optionalString; cfg = config.programs.skim; in { options = { programs.skim = { - fuzzyCompletion = mkEnableOption (mdDoc "fuzzy completion with skim"); - keybindings = mkEnableOption (mdDoc "skim keybindings"); + fuzzyCompletion = mkEnableOption "fuzzy completion with skim"; + keybindings = mkEnableOption "skim keybindings"; package = mkPackageOption pkgs "skim" {}; }; }; diff --git a/nixos/modules/programs/slock.nix b/nixos/modules/programs/slock.nix index 3db9866d9f1c3..ce80fcc5d4a8a 100644 --- a/nixos/modules/programs/slock.nix +++ b/nixos/modules/programs/slock.nix @@ -12,7 +12,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to install slock screen locker with setuid wrapper. ''; }; diff --git a/nixos/modules/programs/sniffnet.nix b/nixos/modules/programs/sniffnet.nix index 5f6f2042d3fe5..631a155e35b56 100644 --- a/nixos/modules/programs/sniffnet.nix +++ b/nixos/modules/programs/sniffnet.nix @@ -7,7 +7,7 @@ in { options = { programs.sniffnet = { - enable = lib.mkEnableOption (lib.mdDoc "sniffnet, a network traffic monitor application"); + enable = lib.mkEnableOption "sniffnet, a network traffic monitor application"; }; }; diff --git a/nixos/modules/programs/spacefm.nix b/nixos/modules/programs/spacefm.nix index b4ba9dcdea567..fec14fca48e1e 100644 --- a/nixos/modules/programs/spacefm.nix +++ b/nixos/modules/programs/spacefm.nix @@ -17,7 +17,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to install SpaceFM and create {file}`/etc/spacefm/spacefm.conf`. ''; }; @@ -34,7 +34,7 @@ in terminal_su = "''${pkgs.sudo}/bin/sudo"; } ''; - description = lib.mdDoc '' + description = '' The system-wide spacefm configuration. Parameters to be written to {file}`/etc/spacefm/spacefm.conf`. Refer to the [relevant entry](https://ignorantguru.github.io/spacefm/spacefm-manual-en.html#programfiles-etc) in the SpaceFM manual. diff --git a/nixos/modules/programs/ssh.nix b/nixos/modules/programs/ssh.nix index 0c1461709c22b..2d25c7a936623 100644 --- a/nixos/modules/programs/ssh.nix +++ b/nixos/modules/programs/ssh.nix @@ -40,20 +40,20 @@ in type = types.bool; default = config.services.xserver.enable; defaultText = literalExpression "config.services.xserver.enable"; - description = lib.mdDoc "Whether to configure SSH_ASKPASS in the environment."; + description = "Whether to configure SSH_ASKPASS in the environment."; }; askPassword = mkOption { type = types.str; default = "${pkgs.x11_ssh_askpass}/libexec/x11-ssh-askpass"; defaultText = literalExpression ''"''${pkgs.x11_ssh_askpass}/libexec/x11-ssh-askpass"''; - description = lib.mdDoc "Program used by SSH to ask for passwords."; + description = "Program used by SSH to ask for passwords."; }; forwardX11 = mkOption { type = with lib.types; nullOr bool; default = false; - description = lib.mdDoc '' + description = '' Whether to request X11 forwarding on outgoing connections by default. If set to null, the option is not set at all. This is useful for running graphical programs on the remote machine and have them display to your local X11 server. @@ -67,7 +67,7 @@ in setXAuthLocation = mkOption { type = types.bool; - description = lib.mdDoc '' + description = '' Whether to set the path to {command}`xauth` for X11-forwarded connections. This causes a dependency on X11 packages. ''; @@ -77,7 +77,7 @@ in type = types.listOf types.str; default = []; example = [ "ssh-ed25519" "ssh-rsa" ]; - description = lib.mdDoc '' + description = '' Specifies the key types that will be used for public key authentication. ''; }; @@ -86,7 +86,7 @@ in type = types.listOf types.str; default = []; example = [ "ssh-ed25519" "ssh-rsa" ]; - description = lib.mdDoc '' + description = '' Specifies the host key algorithms that the client wants to use in order of preference. ''; }; @@ -94,7 +94,7 @@ in extraConfig = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' Extra configuration text prepended to {file}`ssh_config`. Other generated options will be added after a `Host *` pattern. See {manpage}`ssh_config(5)` @@ -105,7 +105,7 @@ in startAgent = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to start the OpenSSH agent when you log in. The OpenSSH agent remembers private keys for you so that you don't have to type in passphrases every time you make an SSH connection. Use @@ -117,7 +117,7 @@ in type = types.nullOr types.str; default = null; example = "1h"; - description = lib.mdDoc '' + description = '' How long to keep the private keys in memory. Use null to keep them forever. ''; }; @@ -126,7 +126,7 @@ in type = types.nullOr types.str; default = null; example = literalExpression ''"''${pkgs.opensc}/lib/opensc-pkcs11.so"''; - description = lib.mdDoc '' + description = '' A pattern-list of acceptable paths for PKCS#11 shared libraries that may be used with the -s option to ssh-add. ''; @@ -141,7 +141,7 @@ in certAuthority = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' This public key is an SSH certificate authority, rather than an individual host's key. ''; @@ -150,7 +150,7 @@ in type = types.listOf types.str; default = [ name ] ++ config.extraHostNames; defaultText = literalExpression "[ ${name} ] ++ config.${options.extraHostNames}"; - description = lib.mdDoc '' + description = '' A list of host names and/or IP numbers used for accessing the host's ssh service. This list includes the name of the containing `knownHosts` attribute by default @@ -163,7 +163,7 @@ in extraHostNames = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' A list of additional host names and/or IP numbers used for accessing the host's ssh service. This list is ignored if `hostNames` is set explicitly. @@ -173,7 +173,7 @@ in default = null; type = types.nullOr types.str; example = "ecdsa-sha2-nistp521 AAAAE2VjZHN...UEPg=="; - description = lib.mdDoc '' + description = '' The public key data for the host. You can fetch a public key from a running SSH server with the {command}`ssh-keyscan` command. The public key should not include any host names, only @@ -183,7 +183,7 @@ in publicKeyFile = mkOption { default = null; type = types.nullOr types.path; - description = lib.mdDoc '' + description = '' The path to the public key file for the host. The public key file is read at build time and saved in the Nix store. You can fetch a public key file from a running SSH server @@ -196,7 +196,7 @@ in }; }; })); - description = lib.mdDoc '' + description = '' The set of system-wide known SSH hosts. To make simple setups more convenient the name of an attribute in this set is used as a host name for the entry. This behaviour can be disabled by setting @@ -222,7 +222,7 @@ in knownHostsFiles = mkOption { default = []; type = with types; listOf path; - description = lib.mdDoc '' + description = '' Files containing SSH host keys to set as global known hosts. `/etc/ssh/ssh_known_hosts` (which is generated by {option}`programs.ssh.knownHosts`) is @@ -244,7 +244,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "curve25519-sha256@libssh.org" "diffie-hellman-group-exchange-sha256" ]; - description = lib.mdDoc '' + description = '' Specifies the available KEX (Key Exchange) algorithms. ''; }; @@ -253,7 +253,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "chacha20-poly1305@openssh.com" "aes256-gcm@openssh.com" ]; - description = lib.mdDoc '' + description = '' Specifies the ciphers allowed and their order of preference. ''; }; @@ -262,7 +262,7 @@ in type = types.nullOr (types.listOf types.str); default = null; example = [ "hmac-sha2-512-etm@openssh.com" "hmac-sha1" ]; - description = lib.mdDoc '' + description = '' Specifies the MAC (message authentication code) algorithms in order of preference. The MAC algorithm is used for data integrity protection. ''; diff --git a/nixos/modules/programs/steam.nix b/nixos/modules/programs/steam.nix index 0fa6b90cfff2a..58aa0aa25b082 100644 --- a/nixos/modules/programs/steam.nix +++ b/nixos/modules/programs/steam.nix @@ -24,7 +24,7 @@ let '').overrideAttrs (_: { passthru.providedSessions = [ "steam" ]; }); in { options.programs.steam = { - enable = mkEnableOption (lib.mdDoc "steam"); + enable = mkEnableOption "steam"; package = mkOption { type = types.package; @@ -62,7 +62,7 @@ in { bubblewrap = "${config.security.wrapperDir}/.."; }; }); - description = lib.mdDoc '' + description = '' The Steam package to use. Additional libraries are added from the system configuration to ensure graphics work properly. @@ -79,7 +79,7 @@ in { proton-ge-bin ] ''; - description = lib.mdDoc '' + description = '' Extra packages to be used as compatibility tools for Steam on Linux. Packages will be included in the `STEAM_EXTRA_COMPAT_TOOLS_PATHS` environmental variable. For more information see https://github.com/ValveSoftware/steam-for-linux/issues/6310. @@ -91,7 +91,7 @@ in { remotePlay.openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for Steam Remote Play. ''; }; @@ -99,7 +99,7 @@ in { dedicatedServer.openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for Source Dedicated Server. ''; }; @@ -107,21 +107,21 @@ in { localNetworkGameTransfers.openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for Steam Local Network Game Transfers. ''; }; gamescopeSession = mkOption { - description = mdDoc "Run a GameScope driven Steam session from your display-manager"; + description = "Run a GameScope driven Steam session from your display-manager"; default = {}; type = types.submodule { options = { - enable = mkEnableOption (mdDoc "GameScope Session"); + enable = mkEnableOption "GameScope Session"; args = mkOption { type = types.listOf types.str; default = [ ]; - description = mdDoc '' + description = '' Arguments to be passed to GameScope for the session. ''; }; @@ -129,7 +129,7 @@ in { env = mkOption { type = types.attrsOf types.str; default = { }; - description = mdDoc '' + description = '' Environmental variables to be passed to GameScope for the session. ''; }; @@ -137,10 +137,10 @@ in { }; }; - extest.enable = mkEnableOption (lib.mdDoc '' + extest.enable = mkEnableOption '' Load the extest library into Steam, to translate X11 input events to uinput events (e.g. for using Steam Input on Wayland) - ''); + ''; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/streamdeck-ui.nix b/nixos/modules/programs/streamdeck-ui.nix index 47b1681cd6344..6bec2abdfbec6 100644 --- a/nixos/modules/programs/streamdeck-ui.nix +++ b/nixos/modules/programs/streamdeck-ui.nix @@ -7,12 +7,12 @@ let in { options.programs.streamdeck-ui = { - enable = mkEnableOption (lib.mdDoc "streamdeck-ui"); + enable = mkEnableOption "streamdeck-ui"; autoStart = mkOption { default = true; type = types.bool; - description = lib.mdDoc "Whether streamdeck-ui should be started automatically."; + description = "Whether streamdeck-ui should be started automatically."; }; package = mkPackageOption pkgs "streamdeck-ui" { diff --git a/nixos/modules/programs/sysdig.nix b/nixos/modules/programs/sysdig.nix index 19cd6f26bae45..cf2cbab5cf6e5 100644 --- a/nixos/modules/programs/sysdig.nix +++ b/nixos/modules/programs/sysdig.nix @@ -5,7 +5,7 @@ with lib; let cfg = config.programs.sysdig; in { - options.programs.sysdig.enable = mkEnableOption (lib.mdDoc "sysdig, a tracing tool"); + options.programs.sysdig.enable = mkEnableOption "sysdig, a tracing tool"; config = mkIf cfg.enable { environment.systemPackages = [ pkgs.sysdig ]; diff --git a/nixos/modules/programs/system-config-printer.nix b/nixos/modules/programs/system-config-printer.nix index 7c7eea5805459..34592dd7064b4 100644 --- a/nixos/modules/programs/system-config-printer.nix +++ b/nixos/modules/programs/system-config-printer.nix @@ -10,7 +10,7 @@ with lib; programs.system-config-printer = { - enable = mkEnableOption (lib.mdDoc "system-config-printer, a Graphical user interface for CUPS administration"); + enable = mkEnableOption "system-config-printer, a Graphical user interface for CUPS administration"; }; diff --git a/nixos/modules/programs/systemtap.nix b/nixos/modules/programs/systemtap.nix index cbb9ec164c6ca..d23bd13fdd85d 100644 --- a/nixos/modules/programs/systemtap.nix +++ b/nixos/modules/programs/systemtap.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Install {command}`systemtap` along with necessary kernel options. ''; }; diff --git a/nixos/modules/programs/thefuck.nix b/nixos/modules/programs/thefuck.nix index 60b341638a0f8..ba2e39c013aeb 100644 --- a/nixos/modules/programs/thefuck.nix +++ b/nixos/modules/programs/thefuck.nix @@ -16,13 +16,13 @@ in { options = { programs.thefuck = { - enable = mkEnableOption (lib.mdDoc "thefuck, an app which corrects your previous console command"); + enable = mkEnableOption "thefuck, an app which corrects your previous console command"; alias = mkOption { default = "fuck"; type = types.str; - description = lib.mdDoc '' + description = '' `thefuck` needs an alias to be configured. The default value is `fuck`, but you can use anything else as well. ''; diff --git a/nixos/modules/programs/thunar.nix b/nixos/modules/programs/thunar.nix index cb85b3886c134..5ea2982dd93cf 100644 --- a/nixos/modules/programs/thunar.nix +++ b/nixos/modules/programs/thunar.nix @@ -11,12 +11,12 @@ in { options = { programs.thunar = { - enable = mkEnableOption (lib.mdDoc "Thunar, the Xfce file manager"); + enable = mkEnableOption "Thunar, the Xfce file manager"; plugins = mkOption { default = []; type = types.listOf types.package; - description = lib.mdDoc "List of thunar plugins to install."; + description = "List of thunar plugins to install."; example = literalExpression "with pkgs.xfce; [ thunar-archive-plugin thunar-volman ]"; }; diff --git a/nixos/modules/programs/tmux.nix b/nixos/modules/programs/tmux.nix index 0d1c7c9cdf0f4..b4b476a801ddf 100644 --- a/nixos/modules/programs/tmux.nix +++ b/nixos/modules/programs/tmux.nix @@ -72,14 +72,14 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Whenever to configure {command}`tmux` system-wide."; + description = "Whenever to configure {command}`tmux` system-wide."; relatedPackages = [ "tmux" ]; }; aggressiveResize = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Resize the window to the size of the smallest session for which it is the current window. ''; }; @@ -88,31 +88,31 @@ in { default = 0; example = 1; type = types.int; - description = lib.mdDoc "Base index for windows and panes."; + description = "Base index for windows and panes."; }; clock24 = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Use 24 hour clock."; + description = "Use 24 hour clock."; }; customPaneNavigationAndResize = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode."; + description = "Override the hjkl and HJKL bindings for pane navigation and resizing in VI mode."; }; escapeTime = mkOption { default = 500; example = 0; type = types.int; - description = lib.mdDoc "Time in milliseconds for which tmux waits after an escape is input."; + description = "Time in milliseconds for which tmux waits after an escape is input."; }; extraConfigBeforePlugins = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Additional contents of /etc/tmux.conf, to be run before sourcing plugins. ''; type = types.lines; @@ -120,7 +120,7 @@ in { extraConfig = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Additional contents of /etc/tmux.conf, to be run after sourcing plugins. ''; type = types.lines; @@ -130,47 +130,47 @@ in { default = 2000; example = 5000; type = types.int; - description = lib.mdDoc "Maximum number of lines held in window history."; + description = "Maximum number of lines held in window history."; }; keyMode = mkOption { default = defaultKeyMode; example = "vi"; type = types.enum [ "emacs" "vi" ]; - description = lib.mdDoc "VI or Emacs style shortcuts."; + description = "VI or Emacs style shortcuts."; }; newSession = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Automatically spawn a session if trying to attach and none are running."; + description = "Automatically spawn a session if trying to attach and none are running."; }; reverseSplit = mkOption { default = false; type = types.bool; - description = lib.mdDoc "Reverse the window split shortcuts."; + description = "Reverse the window split shortcuts."; }; resizeAmount = mkOption { default = defaultResize; example = 10; type = types.int; - description = lib.mdDoc "Number of lines/columns when resizing."; + description = "Number of lines/columns when resizing."; }; shortcut = mkOption { default = defaultShortcut; example = "a"; type = types.str; - description = lib.mdDoc "Ctrl following by this key is used as the main shortcut."; + description = "Ctrl following by this key is used as the main shortcut."; }; terminal = mkOption { default = defaultTerminal; example = "screen-256color"; type = types.str; - description = lib.mdDoc '' + description = '' Set the $TERM variable. Use tmux-direct if italics or 24bit true color support is needed. ''; @@ -179,7 +179,7 @@ in { secureSocket = mkOption { default = true; type = types.bool; - description = lib.mdDoc '' + description = '' Store tmux socket under /run, which is more secure than /tmp, but as a downside it doesn't survive user logout. ''; @@ -188,12 +188,12 @@ in { plugins = mkOption { default = []; type = types.listOf types.package; - description = lib.mdDoc "List of plugins to install."; + description = "List of plugins to install."; example = lib.literalExpression "[ pkgs.tmuxPlugins.nord ]"; }; withUtempter = mkOption { - description = lib.mdDoc '' + description = '' Whether to enable libutempter for tmux. This is required so that tmux can write to /var/run/utmp (which can be queried with `who` to display currently connected user sessions). Note, this will add a guid wrapper for the group utmp! diff --git a/nixos/modules/programs/traceroute.nix b/nixos/modules/programs/traceroute.nix index df5f10b87d5f3..6e04057ac5034 100644 --- a/nixos/modules/programs/traceroute.nix +++ b/nixos/modules/programs/traceroute.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to configure a setcap wrapper for traceroute. ''; }; diff --git a/nixos/modules/programs/trippy.nix b/nixos/modules/programs/trippy.nix index 8c82358acff43..707370fb31a51 100644 --- a/nixos/modules/programs/trippy.nix +++ b/nixos/modules/programs/trippy.nix @@ -7,7 +7,7 @@ in { options = { programs.trippy = { - enable = lib.mkEnableOption (lib.mdDoc "trippy, a network diagnostic tool"); + enable = lib.mkEnableOption "trippy, a network diagnostic tool"; }; }; diff --git a/nixos/modules/programs/tsm-client.nix b/nixos/modules/programs/tsm-client.nix index d31a1fb3f375b..5f0d78bfa4a51 100644 --- a/nixos/modules/programs/tsm-client.nix +++ b/nixos/modules/programs/tsm-client.nix @@ -27,7 +27,7 @@ let type = servernameType; default = name; example = "mainTsmServer"; - description = lib.mdDoc '' + description = '' Local name of the IBM TSM server, must not contain space or more than 64 chars. ''; @@ -35,14 +35,14 @@ let options.tcpserveraddress = mkOption { type = nonEmptyStr; example = "tsmserver.company.com"; - description = lib.mdDoc '' + description = '' Host/domain name or IP address of the IBM TSM server. ''; }; options.tcpport = mkOption { type = addCheck port (p: p<=32767); default = 1500; # official default - description = lib.mdDoc '' + description = '' TCP port of the IBM TSM server. TSM does not support ports above 32767. ''; @@ -50,11 +50,11 @@ let options.nodename = mkOption { type = nonEmptyStr; example = "MY-TSM-NODE"; - description = lib.mdDoc '' + description = '' Target node name on the IBM TSM server. ''; }; - options.genPasswd = mkEnableOption (lib.mdDoc '' + options.genPasswd = mkEnableOption '' automatic client password generation. This option does *not* cause a line in {file}`dsm.sys` by itself, but generates a @@ -65,7 +65,7 @@ let If this option is enabled and the server forces to renew the password (e.g. on first connection), a random password will be generated and stored - ''); + ''; options.passwordaccess = mkOption { type = enum [ "generate" "prompt" ]; visible = false; @@ -74,7 +74,7 @@ let type = nullOr path; default = null; example = "/home/alice/tsm-password"; - description = lib.mdDoc '' + description = '' Directory that holds the TSM node's password information. ''; @@ -88,7 +88,7 @@ let exclude.dir /nix/store include.encrypt /home/.../* ''; - description = lib.mdDoc '' + description = '' Text lines with `include.*` and `exclude.*` directives to be used when sending files to the IBM TSM server, or an absolute path pointing to a file with such lines. @@ -112,11 +112,11 @@ let }; options.programs.tsmClient = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' IBM Storage Protect (Tivoli Storage Manager, TSM) client command line applications with a client system-options file "dsm.sys" - ''); + ''; servers = mkOption { type = attrsOf (submodule serverOptions); default = {}; @@ -125,7 +125,7 @@ let nodename = "MY-TSM-NODE"; compression = "yes"; }; - description = lib.mdDoc '' + description = '' Server definitions ("stanzas") for the client system-options file. The name of each entry will be used for @@ -145,7 +145,7 @@ let type = nullOr servernameType; default = null; example = "mainTsmServer"; - description = lib.mdDoc '' + description = '' If multiple server stanzas are declared with {option}`programs.tsmClient.servers`, this option may be used to name a default @@ -158,7 +158,7 @@ let dsmSysText = mkOption { type = lines; readOnly = true; - description = lib.mdDoc '' + description = '' This configuration key contains the effective text of the client system-options file "dsm.sys". It should not be changed, but may be diff --git a/nixos/modules/programs/turbovnc.nix b/nixos/modules/programs/turbovnc.nix index 511b6badc0417..fbb3a7bf22e99 100644 --- a/nixos/modules/programs/turbovnc.nix +++ b/nixos/modules/programs/turbovnc.nix @@ -15,7 +15,7 @@ in ensureHeadlessSoftwareOpenGL = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to set up NixOS such that TurboVNC's built-in software OpenGL implementation works. diff --git a/nixos/modules/programs/udevil.nix b/nixos/modules/programs/udevil.nix index 5ec84d41de841..44b9dd9234b38 100644 --- a/nixos/modules/programs/udevil.nix +++ b/nixos/modules/programs/udevil.nix @@ -6,7 +6,7 @@ let cfg = config.programs.udevil; in { - options.programs.udevil.enable = mkEnableOption (lib.mdDoc "udevil, to mount filesystems without password"); + options.programs.udevil.enable = mkEnableOption "udevil, to mount filesystems without password"; config = mkIf cfg.enable { security.wrappers.udevil = diff --git a/nixos/modules/programs/usbtop.nix b/nixos/modules/programs/usbtop.nix index 0b59d141bcd60..4f13ce5f6262d 100644 --- a/nixos/modules/programs/usbtop.nix +++ b/nixos/modules/programs/usbtop.nix @@ -6,7 +6,7 @@ let cfg = config.programs.usbtop; in { options = { - programs.usbtop.enable = mkEnableOption (lib.mdDoc "usbtop and required kernel module, to show estimated USB bandwidth"); + programs.usbtop.enable = mkEnableOption "usbtop and required kernel module, to show estimated USB bandwidth"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/vim.nix b/nixos/modules/programs/vim.nix index da2813f4bb53f..eb3499fd243f5 100644 --- a/nixos/modules/programs/vim.nix +++ b/nixos/modules/programs/vim.nix @@ -9,7 +9,7 @@ in { defaultEditor = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' When enabled, installs vim and configures vim to be the default editor using the EDITOR environment variable. ''; diff --git a/nixos/modules/programs/wavemon.nix b/nixos/modules/programs/wavemon.nix index 4dbf2748913eb..e5ccacba75d4a 100644 --- a/nixos/modules/programs/wavemon.nix +++ b/nixos/modules/programs/wavemon.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to add wavemon to the global environment and configure a setcap wrapper for it. ''; diff --git a/nixos/modules/programs/wayland/cardboard.nix b/nixos/modules/programs/wayland/cardboard.nix index 0039961927378..96089bdf94edb 100644 --- a/nixos/modules/programs/wayland/cardboard.nix +++ b/nixos/modules/programs/wayland/cardboard.nix @@ -7,7 +7,7 @@ in meta.maintainers = with lib.maintainers; [ AndersonTorres ]; options.programs.cardboard = { - enable = lib.mkEnableOption (lib.mdDoc "cardboard"); + enable = lib.mkEnableOption "cardboard"; package = lib.mkPackageOption pkgs "cardboard" { }; }; diff --git a/nixos/modules/programs/wayland/labwc.nix b/nixos/modules/programs/wayland/labwc.nix index 7f5f54f031eab..c09ab8240d9f2 100644 --- a/nixos/modules/programs/wayland/labwc.nix +++ b/nixos/modules/programs/wayland/labwc.nix @@ -7,7 +7,7 @@ in meta.maintainers = with lib.maintainers; [ AndersonTorres ]; options.programs.labwc = { - enable = lib.mkEnableOption (lib.mdDoc "labwc"); + enable = lib.mkEnableOption "labwc"; package = lib.mkPackageOption pkgs "labwc" { }; }; diff --git a/nixos/modules/programs/wayland/river.nix b/nixos/modules/programs/wayland/river.nix index 133dda539f018..d0e309646b0ef 100644 --- a/nixos/modules/programs/wayland/river.nix +++ b/nixos/modules/programs/wayland/river.nix @@ -8,7 +8,7 @@ with lib; let cfg = config.programs.river; in { options.programs.river = { - enable = mkEnableOption (lib.mdDoc "river, a dynamic tiling Wayland compositor"); + enable = mkEnableOption "river, a dynamic tiling Wayland compositor"; package = mkPackageOption pkgs "river" { nullable = true; @@ -33,7 +33,7 @@ in { termite rofi light ] ''; - description = lib.mdDoc '' + description = '' Extra packages to be installed system wide. See [Common X11 apps used on i3 with Wayland alternatives](https://github.com/swaywm/sway/wiki/i3-Migration-Guide#common-x11-apps-used-on-i3-with-wayland-alternatives) for a list of useful software. diff --git a/nixos/modules/programs/wayland/sway.nix b/nixos/modules/programs/wayland/sway.nix index 08ae162b23b48..348e1db7cdc1c 100644 --- a/nixos/modules/programs/wayland/sway.nix +++ b/nixos/modules/programs/wayland/sway.nix @@ -12,7 +12,7 @@ let type = types.bool; inherit default; example = !default; - description = lib.mdDoc "Whether to make use of the ${description}"; + description = "Whether to make use of the ${description}"; }; in { base = mkWrapperFeature true '' @@ -50,19 +50,19 @@ let }; in { options.programs.sway = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' Sway, the i3-compatible tiling Wayland compositor. You can manually launch Sway by executing "exec sway" on a TTY. Copy /etc/sway/config to ~/.config/sway/config to modify the default configuration. See <https://github.com/swaywm/sway/wiki> and - "man 5 sway" for more information''); + "man 5 sway" for more information''; package = mkOption { type = with types; nullOr package; default = pkgs.sway; apply = p: if p == null then null else genFinalPackage p; defaultText = literalExpression "pkgs.sway"; - description = lib.mdDoc '' + description = '' Sway package to use. If the package does not contain the override arguments `extraSessionCommands`, `extraOptions`, `withBaseWrapper`, `withGtkWrapper`, `isNixOS`, then the module options {option}`wrapperFeatures`, @@ -76,7 +76,7 @@ in { type = wrapperOptions; default = { }; example = { gtk = true; }; - description = lib.mdDoc '' + description = '' Attribute set of features to enable in the wrapper. ''; }; @@ -94,7 +94,7 @@ in { # use this if they aren't displayed properly: export _JAVA_AWT_WM_NONREPARENTING=1 ''; - description = lib.mdDoc '' + description = '' Shell commands executed just before Sway is started. See <https://github.com/swaywm/sway/wiki/Running-programs-natively-under-wayland> and <https://github.com/swaywm/wlroots/blob/master/docs/env_vars.md> @@ -110,7 +110,7 @@ in { "--debug" "--unsupported-gpu" ]; - description = lib.mdDoc '' + description = '' Command line arguments passed to launch Sway. Please DO NOT report issues if you use an unsupported GPU (proprietary drivers). ''; @@ -130,7 +130,7 @@ in { termite rofi light ] ''; - description = lib.mdDoc '' + description = '' Extra packages to be installed system wide. See <https://github.com/swaywm/sway/wiki/Useful-add-ons-for-sway> and <https://github.com/swaywm/sway/wiki/i3-Migration-Guide#common-x11-apps-used-on-i3-with-wayland-alternatives> diff --git a/nixos/modules/programs/wayland/waybar.nix b/nixos/modules/programs/wayland/waybar.nix index f4bd865b221aa..ffe889504cd39 100644 --- a/nixos/modules/programs/wayland/waybar.nix +++ b/nixos/modules/programs/wayland/waybar.nix @@ -7,7 +7,7 @@ let in { options.programs.waybar = { - enable = mkEnableOption (lib.mdDoc "waybar, a highly customizable Wayland bar for Sway and Wlroots based compositors"); + enable = mkEnableOption "waybar, a highly customizable Wayland bar for Sway and Wlroots based compositors"; package = mkPackageOption pkgs "waybar" { }; }; diff --git a/nixos/modules/programs/wayland/wayfire.nix b/nixos/modules/programs/wayland/wayfire.nix index 6f6550edc5a08..7acc5b2739cbf 100644 --- a/nixos/modules/programs/wayland/wayfire.nix +++ b/nixos/modules/programs/wayland/wayfire.nix @@ -6,7 +6,7 @@ in meta.maintainers = with lib.maintainers; [ rewine ]; options.programs.wayfire = { - enable = lib.mkEnableOption (lib.mdDoc "Wayfire, a wayland compositor based on wlroots"); + enable = lib.mkEnableOption "Wayfire, a wayland compositor based on wlroots"; package = lib.mkPackageOption pkgs "wayfire" { }; @@ -21,7 +21,7 @@ in wayfire-plugins-extra ]; ''; - description = lib.mdDoc '' + description = '' Additional plugins to use with the wayfire window manager. ''; }; diff --git a/nixos/modules/programs/weylus.nix b/nixos/modules/programs/weylus.nix index 5c69a6658fae6..a47dccb95cd98 100644 --- a/nixos/modules/programs/weylus.nix +++ b/nixos/modules/programs/weylus.nix @@ -7,12 +7,12 @@ let in { options.programs.weylus = with types; { - enable = mkEnableOption (lib.mdDoc "weylus, which turns your smart phone into a graphic tablet/touch screen for your computer"); + enable = mkEnableOption "weylus, which turns your smart phone into a graphic tablet/touch screen for your computer"; openFirewall = mkOption { type = bool; default = false; - description = lib.mdDoc '' + description = '' Open ports needed for the functionality of the program. ''; }; @@ -20,7 +20,7 @@ in users = mkOption { type = listOf str; default = [ ]; - description = lib.mdDoc '' + description = '' To enable stylus and multi-touch support, the user you're going to use must be added to this list. These users can synthesize input events system-wide, even when another user is logged in - untrusted users should not be added. ''; diff --git a/nixos/modules/programs/wireshark.nix b/nixos/modules/programs/wireshark.nix index c0dc349cca4a2..2d947154e8224 100644 --- a/nixos/modules/programs/wireshark.nix +++ b/nixos/modules/programs/wireshark.nix @@ -11,7 +11,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to add Wireshark to the global environment and configure a setcap wrapper for 'dumpcap' for users in the 'wireshark' group. ''; diff --git a/nixos/modules/programs/wshowkeys.nix b/nixos/modules/programs/wshowkeys.nix index ebb5c5509442e..f7b71d2bb0c89 100644 --- a/nixos/modules/programs/wshowkeys.nix +++ b/nixos/modules/programs/wshowkeys.nix @@ -9,10 +9,10 @@ in { options = { programs.wshowkeys = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' wshowkeys (displays keypresses on screen on supported Wayland compositors). It requires root permissions to read input events, but - these permissions are dropped after startup''); + these permissions are dropped after startup''; }; }; diff --git a/nixos/modules/programs/xastir.nix b/nixos/modules/programs/xastir.nix index 6d5fc59aac506..d9c687289ec2c 100644 --- a/nixos/modules/programs/xastir.nix +++ b/nixos/modules/programs/xastir.nix @@ -8,7 +8,7 @@ in { meta.maintainers = with maintainers; [ melling ]; options.programs.xastir = { - enable = mkEnableOption (mdDoc "Xastir Graphical APRS client"); + enable = mkEnableOption "Xastir Graphical APRS client"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/xfconf.nix b/nixos/modules/programs/xfconf.nix index b0f45339335d6..8e854b40e513d 100644 --- a/nixos/modules/programs/xfconf.nix +++ b/nixos/modules/programs/xfconf.nix @@ -11,7 +11,7 @@ in { options = { programs.xfconf = { - enable = mkEnableOption (lib.mdDoc "Xfconf, the Xfce configuration storage system"); + enable = mkEnableOption "Xfconf, the Xfce configuration storage system"; }; }; diff --git a/nixos/modules/programs/xfs_quota.nix b/nixos/modules/programs/xfs_quota.nix index 0fc2958b3f387..8f70cc2d94163 100644 --- a/nixos/modules/programs/xfs_quota.nix +++ b/nixos/modules/programs/xfs_quota.nix @@ -28,37 +28,37 @@ in options = { id = mkOption { type = types.int; - description = lib.mdDoc "Project ID."; + description = "Project ID."; }; fileSystem = mkOption { type = types.str; - description = lib.mdDoc "XFS filesystem hosting the xfs_quota project."; + description = "XFS filesystem hosting the xfs_quota project."; default = "/"; }; path = mkOption { type = types.str; - description = lib.mdDoc "Project directory."; + description = "Project directory."; }; sizeSoftLimit = mkOption { type = types.nullOr types.str; default = null; example = "30g"; - description = lib.mdDoc "Soft limit of the project size"; + description = "Soft limit of the project size"; }; sizeHardLimit = mkOption { type = types.nullOr types.str; default = null; example = "50g"; - description = lib.mdDoc "Hard limit of the project size."; + description = "Hard limit of the project size."; }; }; }); - description = lib.mdDoc "Setup of xfs_quota projects. Make sure the filesystem is mounted with the pquota option."; + description = "Setup of xfs_quota projects. Make sure the filesystem is mounted with the pquota option."; example = { projname = { diff --git a/nixos/modules/programs/xonsh.nix b/nixos/modules/programs/xonsh.nix index 2ece772c929e2..fefe6b456c960 100644 --- a/nixos/modules/programs/xonsh.nix +++ b/nixos/modules/programs/xonsh.nix @@ -18,7 +18,7 @@ in enable = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to configure xonsh as an interactive shell. ''; type = types.bool; @@ -30,7 +30,7 @@ in config = mkOption { default = ""; - description = lib.mdDoc "Control file to customize your shell behavior."; + description = "Control file to customize your shell behavior."; type = types.lines; }; diff --git a/nixos/modules/programs/xss-lock.nix b/nixos/modules/programs/xss-lock.nix index 2ff45de93b6da..1bb73905599f8 100644 --- a/nixos/modules/programs/xss-lock.nix +++ b/nixos/modules/programs/xss-lock.nix @@ -7,21 +7,21 @@ let in { options.programs.xss-lock = { - enable = mkEnableOption (lib.mdDoc "xss-lock"); + enable = mkEnableOption "xss-lock"; lockerCommand = mkOption { default = "${pkgs.i3lock}/bin/i3lock"; defaultText = literalExpression ''"''${pkgs.i3lock}/bin/i3lock"''; example = literalExpression ''"''${pkgs.i3lock-fancy}/bin/i3lock-fancy"''; type = types.separatedString " "; - description = lib.mdDoc "Locker to be used with xsslock"; + description = "Locker to be used with xsslock"; }; extraOptions = mkOption { default = [ ]; example = [ "--ignore-sleep" ]; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Additional command-line arguments to pass to {command}`xss-lock`. ''; diff --git a/nixos/modules/programs/xwayland.nix b/nixos/modules/programs/xwayland.nix index 8d13e4c22b5b0..3a8080fa4c4d8 100644 --- a/nixos/modules/programs/xwayland.nix +++ b/nixos/modules/programs/xwayland.nix @@ -10,7 +10,7 @@ in { options.programs.xwayland = { - enable = mkEnableOption (lib.mdDoc "Xwayland (an X server for interfacing X11 apps with the Wayland protocol)"); + enable = mkEnableOption "Xwayland (an X server for interfacing X11 apps with the Wayland protocol)"; defaultFontPath = mkOption { type = types.str; @@ -19,7 +19,7 @@ in defaultText = literalExpression '' optionalString config.fonts.fontDir.enable "/run/current-system/sw/share/X11/fonts" ''; - description = lib.mdDoc '' + description = '' Default font path. Setting this option causes Xwayland to be rebuilt. ''; }; @@ -34,7 +34,7 @@ in inherit (config.programs.xwayland) defaultFontPath; }) ''; - description = lib.mdDoc "The Xwayland package to use."; + description = "The Xwayland package to use."; }; }; diff --git a/nixos/modules/programs/yabar.nix b/nixos/modules/programs/yabar.nix index c6223a1c4d92a..6e117506a2dc4 100644 --- a/nixos/modules/programs/yabar.nix +++ b/nixos/modules/programs/yabar.nix @@ -41,7 +41,7 @@ let in { options.programs.yabar = { - enable = mkEnableOption (lib.mdDoc "yabar, a status bar for X window managers"); + enable = mkEnableOption "yabar, a status bar for X window managers"; package = mkOption { default = pkgs.yabar-unstable; @@ -62,7 +62,7 @@ in to use `yabar-unstable'. ''; - description = lib.mdDoc '' + description = '' The package which contains the `yabar` binary. Nixpkgs provides the `yabar` and `yabar-unstable` @@ -79,7 +79,7 @@ in example = "Droid Sans, FontAwesome Bold 9"; type = types.str; - description = lib.mdDoc '' + description = '' The font that will be used to draw the status bar. ''; }; @@ -89,7 +89,7 @@ in example = "bottom"; type = types.enum [ "top" "bottom" ]; - description = lib.mdDoc '' + description = '' The position where the bar will be rendered. ''; }; @@ -98,7 +98,7 @@ in default = {}; type = types.attrsOf types.str; - description = lib.mdDoc '' + description = '' An attribute set which contains further attributes of a bar. ''; }; @@ -109,7 +109,7 @@ in options.exec = mkOption { example = "YABAR_DATE"; type = types.str; - description = lib.mdDoc '' + description = '' The type of the indicator to be executed. ''; }; @@ -119,7 +119,7 @@ in example = "right"; type = types.enum [ "left" "center" "right" ]; - description = lib.mdDoc '' + description = '' Whether to align the indicator at the left or right of the bar. ''; }; @@ -128,20 +128,20 @@ in default = {}; type = types.attrsOf (types.either types.str types.int); - description = lib.mdDoc '' + description = '' An attribute set which contains further attributes of a indicator. ''; }; }); - description = lib.mdDoc '' + description = '' Indicators that should be rendered by yabar. ''; }; }; }); - description = lib.mdDoc '' + description = '' List of bars that should be rendered by yabar. ''; }; diff --git a/nixos/modules/programs/yazi.nix b/nixos/modules/programs/yazi.nix index 338eddb60d80b..5905f2afb946d 100644 --- a/nixos/modules/programs/yazi.nix +++ b/nixos/modules/programs/yazi.nix @@ -9,7 +9,7 @@ let in { options.programs.yazi = { - enable = lib.mkEnableOption (lib.mdDoc "yazi terminal file manager"); + enable = lib.mkEnableOption "yazi terminal file manager"; package = lib.mkPackageOption pkgs "yazi" { }; @@ -19,7 +19,7 @@ in (name: lib.nameValuePair name (lib.mkOption { inherit (settingsFormat) type; default = { }; - description = lib.mdDoc '' + description = '' Configuration included in `${name}.toml`. See https://yazi-rs.github.io/docs/configuration/${name}/ for documentation. @@ -28,7 +28,7 @@ in names); }; default = { }; - description = lib.mdDoc '' + description = '' Configuration included in `$YAZI_CONFIG_HOME`. ''; }; diff --git a/nixos/modules/programs/zmap.nix b/nixos/modules/programs/zmap.nix index 2eb05b97da3d4..827d9bedca13e 100644 --- a/nixos/modules/programs/zmap.nix +++ b/nixos/modules/programs/zmap.nix @@ -6,7 +6,7 @@ let cfg = config.programs.zmap; in { options.programs.zmap = { - enable = mkEnableOption (lib.mdDoc "ZMap, a network scanner designed for Internet-wide network surveys"); + enable = mkEnableOption "ZMap, a network scanner designed for Internet-wide network surveys"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/zsh/oh-my-zsh.nix b/nixos/modules/programs/zsh/oh-my-zsh.nix index 09c3bb974a508..f2a5a7560e409 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.nix +++ b/nixos/modules/programs/zsh/oh-my-zsh.nix @@ -41,7 +41,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enable oh-my-zsh. ''; }; @@ -51,7 +51,7 @@ in plugins = mkOption { default = []; type = types.listOf(types.str); - description = lib.mdDoc '' + description = '' List of oh-my-zsh plugins ''; }; @@ -59,7 +59,7 @@ in custom = mkOption { default = null; type = with types; nullOr str; - description = lib.mdDoc '' + description = '' Path to a custom oh-my-zsh package to override config of oh-my-zsh. (Can't be used along with `customPkgs`). ''; @@ -68,7 +68,7 @@ in customPkgs = mkOption { default = []; type = types.listOf types.package; - description = lib.mdDoc '' + description = '' List of custom packages that should be loaded into `oh-my-zsh`. ''; }; @@ -76,7 +76,7 @@ in theme = mkOption { default = ""; type = types.str; - description = lib.mdDoc '' + description = '' Name of the theme to be used by oh-my-zsh. ''; }; @@ -84,7 +84,7 @@ in cacheDir = mkOption { default = "$HOME/.cache/oh-my-zsh"; type = types.str; - description = lib.mdDoc '' + description = '' Cache directory to be used by `oh-my-zsh`. Without this option it would default to the read-only nix store. ''; diff --git a/nixos/modules/programs/zsh/zsh-autoenv.nix b/nixos/modules/programs/zsh/zsh-autoenv.nix index 0894bfc3fdda7..f07fb5c24d7b3 100644 --- a/nixos/modules/programs/zsh/zsh-autoenv.nix +++ b/nixos/modules/programs/zsh/zsh-autoenv.nix @@ -7,7 +7,7 @@ let in { options = { programs.zsh.zsh-autoenv = { - enable = mkEnableOption (lib.mdDoc "zsh-autoenv"); + enable = mkEnableOption "zsh-autoenv"; package = mkPackageOption pkgs "zsh-autoenv" { }; }; }; diff --git a/nixos/modules/programs/zsh/zsh-autosuggestions.nix b/nixos/modules/programs/zsh/zsh-autosuggestions.nix index d3a9c372e89b2..2e53e907d547a 100644 --- a/nixos/modules/programs/zsh/zsh-autosuggestions.nix +++ b/nixos/modules/programs/zsh/zsh-autosuggestions.nix @@ -12,19 +12,19 @@ in options.programs.zsh.autosuggestions = { - enable = mkEnableOption (lib.mdDoc "zsh-autosuggestions"); + enable = mkEnableOption "zsh-autosuggestions"; highlightStyle = mkOption { type = types.str; default = "fg=8"; # https://github.com/zsh-users/zsh-autosuggestions/tree/v0.4.3#suggestion-highlight-style - description = lib.mdDoc "Highlight style for suggestions ({fore,back}ground color)"; + description = "Highlight style for suggestions ({fore,back}ground color)"; example = "fg=cyan"; }; strategy = mkOption { type = types.listOf (types.enum [ "history" "completion" "match_prev_cmd" ]); default = [ "history" ]; - description = lib.mdDoc '' + description = '' `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from: @@ -40,14 +40,14 @@ in async = mkOption { type = types.bool; default = true; - description = lib.mdDoc "Whether to fetch suggestions asynchronously"; + description = "Whether to fetch suggestions asynchronously"; example = false; }; extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = lib.mdDoc "Attribute set with additional configuration values"; + description = "Attribute set with additional configuration values"; example = literalExpression '' { "ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" = "20"; diff --git a/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix b/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix index cec4be1cb01e8..46bc4fcb87f4f 100644 --- a/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix +++ b/nixos/modules/programs/zsh/zsh-syntax-highlighting.nix @@ -15,7 +15,7 @@ in options = { programs.zsh.syntaxHighlighting = { - enable = mkEnableOption (lib.mdDoc "zsh-syntax-highlighting"); + enable = mkEnableOption "zsh-syntax-highlighting"; highlighters = mkOption { default = [ "main" ]; @@ -31,7 +31,7 @@ in "line" ])); - description = lib.mdDoc '' + description = '' Specifies the highlighters to be used by zsh-syntax-highlighting. The following defined options can be found here: @@ -49,7 +49,7 @@ in } ''; - description = lib.mdDoc '' + description = '' Specifies custom patterns to be highlighted by zsh-syntax-highlighting. Please refer to the docs for more information about the usage: @@ -66,7 +66,7 @@ in } ''; - description = lib.mdDoc '' + description = '' Specifies custom styles to be highlighted by zsh-syntax-highlighting. Please refer to the docs for more information about the usage: diff --git a/nixos/modules/programs/zsh/zsh.nix b/nixos/modules/programs/zsh/zsh.nix index cad639f299c82..d7e300b50136a 100644 --- a/nixos/modules/programs/zsh/zsh.nix +++ b/nixos/modules/programs/zsh/zsh.nix @@ -44,7 +44,7 @@ in enable = mkOption { default = false; - description = lib.mdDoc '' + description = '' Whether to configure zsh as an interactive shell. To enable zsh for a particular user, use the {option}`users.users.<name?>.shell` option for that user. To enable zsh system-wide use the @@ -55,7 +55,7 @@ in shellAliases = mkOption { default = { }; - description = lib.mdDoc '' + description = '' Set of aliases for zsh shell, which overrides {option}`environment.shellAliases`. See {option}`environment.shellAliases` for an option format description. ''; @@ -64,7 +64,7 @@ in shellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during zsh shell initialisation. ''; type = types.lines; @@ -72,7 +72,7 @@ in loginShellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during zsh login shell initialisation. ''; type = types.lines; @@ -80,7 +80,7 @@ in interactiveShellInit = mkOption { default = ""; - description = lib.mdDoc '' + description = '' Shell script code called during interactive zsh shell initialisation. ''; type = types.lines; @@ -94,7 +94,7 @@ in # a lot of different prompt variables. autoload -U promptinit && promptinit && prompt suse && setopt prompt_sp ''; - description = lib.mdDoc '' + description = '' Shell script code used to initialise the zsh prompt. ''; type = types.lines; @@ -102,7 +102,7 @@ in histSize = mkOption { default = 2000; - description = lib.mdDoc '' + description = '' Change history size. ''; type = types.int; @@ -110,7 +110,7 @@ in histFile = mkOption { default = "$HOME/.zsh_history"; - description = lib.mdDoc '' + description = '' Change history file. ''; type = types.str; @@ -124,7 +124,7 @@ in "HIST_FCNTL_LOCK" ]; example = [ "EXTENDED_HISTORY" "RM_STAR_WAIT" ]; - description = lib.mdDoc '' + description = '' Configure zsh options. See {manpage}`zshoptions(1)`. ''; @@ -132,7 +132,7 @@ in enableCompletion = mkOption { default = true; - description = lib.mdDoc '' + description = '' Enable zsh completion for all interactive zsh shells. ''; type = types.bool; @@ -140,7 +140,7 @@ in enableBashCompletion = mkOption { default = false; - description = lib.mdDoc '' + description = '' Enable compatibility with bash's programmable completion system. ''; type = types.bool; @@ -149,7 +149,7 @@ in enableGlobalCompInit = mkOption { default = cfg.enableCompletion; defaultText = literalExpression "config.${opt.enableCompletion}"; - description = lib.mdDoc '' + description = '' Enable execution of compinit call for all interactive zsh shells. This option can be disabled if the user wants to extend its @@ -161,7 +161,7 @@ in enableLsColors = mkOption { default = true; - description = lib.mdDoc '' + description = '' Enable extra colors in directory listings (used by `ls` and `tree`). ''; type = types.bool; |