diff options
author | stuebinm <stuebinm@disroot.org> | 2024-04-13 14:54:15 +0200 |
---|---|---|
committer | Jonathan Ringer <jonringer@users.noreply.github.com> | 2024-04-13 10:07:35 -0700 |
commit | 6afb255d976f85f3359e4929abd6f5149c323a02 (patch) | |
tree | ced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/hardware | |
parent | 1dd996e59a5e67694b7a252aacba71a88d51b41e (diff) |
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running
nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix
two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.
Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/hardware')
62 files changed, 191 insertions, 191 deletions
diff --git a/nixos/modules/hardware/acpilight.nix b/nixos/modules/hardware/acpilight.nix index d8d82b0e81a4..2de448a265c7 100644 --- a/nixos/modules/hardware/acpilight.nix +++ b/nixos/modules/hardware/acpilight.nix @@ -10,7 +10,7 @@ in enable = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Enable acpilight. This will allow brightness control via xbacklight from users in the video group ''; diff --git a/nixos/modules/hardware/bladeRF.nix b/nixos/modules/hardware/bladeRF.nix index 52a1f52024c8..35b74b8382e3 100644 --- a/nixos/modules/hardware/bladeRF.nix +++ b/nixos/modules/hardware/bladeRF.nix @@ -12,7 +12,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enables udev rules for BladeRF devices. By default grants access to users in the "bladerf" group. You may want to install the libbladeRF package. diff --git a/nixos/modules/hardware/brillo.nix b/nixos/modules/hardware/brillo.nix index 612061718fad..8e36022a9a30 100644 --- a/nixos/modules/hardware/brillo.nix +++ b/nixos/modules/hardware/brillo.nix @@ -7,10 +7,10 @@ in { options = { hardware.brillo = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' brillo in userspace. This will allow brightness control from users in the video group - ''); + ''; }; }; diff --git a/nixos/modules/hardware/ckb-next.nix b/nixos/modules/hardware/ckb-next.nix index 34f951a7446f..65e73833a759 100644 --- a/nixos/modules/hardware/ckb-next.nix +++ b/nixos/modules/hardware/ckb-next.nix @@ -13,13 +13,13 @@ in ]; options.hardware.ckb-next = { - enable = mkEnableOption (lib.mdDoc "the Corsair keyboard/mouse driver"); + enable = mkEnableOption "the Corsair keyboard/mouse driver"; gid = mkOption { type = types.nullOr types.int; default = null; example = 100; - description = lib.mdDoc '' + description = '' Limit access to the ckb daemon to a particular group. ''; }; diff --git a/nixos/modules/hardware/corectrl.nix b/nixos/modules/hardware/corectrl.nix index b1d3f2f0ce7e..9e8b69cf6277 100644 --- a/nixos/modules/hardware/corectrl.nix +++ b/nixos/modules/hardware/corectrl.nix @@ -7,24 +7,24 @@ let in { options.programs.corectrl = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' CoreCtrl, a tool to overclock amd graphics cards and processors. Add your user to the corectrl group to run corectrl without needing to enter your password - ''); + ''; package = mkPackageOption pkgs "corectrl" { extraDescription = "Useful for overriding the configuration options used for the package."; }; gpuOverclock = { - enable = mkEnableOption (lib.mdDoc '' + enable = mkEnableOption '' GPU overclocking - ''); + ''; ppfeaturemask = mkOption { type = types.str; default = "0xfffd7fff"; example = "0xffffffff"; - description = lib.mdDoc '' + description = '' Sets the `amdgpu.ppfeaturemask` kernel option. In particular, it is used here to set the overdrive bit. Default is `0xfffd7fff` as it is less likely to cause flicker issues. diff --git a/nixos/modules/hardware/cpu/amd-microcode.nix b/nixos/modules/hardware/cpu/amd-microcode.nix index 3f52cb1fca3e..621c7066bfe1 100644 --- a/nixos/modules/hardware/cpu/amd-microcode.nix +++ b/nixos/modules/hardware/cpu/amd-microcode.nix @@ -11,7 +11,7 @@ with lib; hardware.cpu.amd.updateMicrocode = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Update the CPU microcode for AMD processors. ''; }; diff --git a/nixos/modules/hardware/cpu/amd-sev.nix b/nixos/modules/hardware/cpu/amd-sev.nix index 08e1de496383..d6225bc35a1e 100644 --- a/nixos/modules/hardware/cpu/amd-sev.nix +++ b/nixos/modules/hardware/cpu/amd-sev.nix @@ -5,19 +5,19 @@ let cfgSevGuest = config.hardware.cpu.amd.sevGuest; optionsFor = device: group: { - enable = mkEnableOption (lib.mdDoc "access to the AMD ${device} device"); + enable = mkEnableOption "access to the AMD ${device} device"; user = mkOption { - description = lib.mdDoc "Owner to assign to the ${device} device."; + description = "Owner to assign to the ${device} device."; type = types.str; default = "root"; }; group = mkOption { - description = lib.mdDoc "Group to assign to the ${device} device."; + description = "Group to assign to the ${device} device."; type = types.str; default = group; }; mode = mkOption { - description = lib.mdDoc "Mode to set for the ${device} device."; + description = "Mode to set for the ${device} device."; type = types.str; default = "0660"; }; diff --git a/nixos/modules/hardware/cpu/intel-microcode.nix b/nixos/modules/hardware/cpu/intel-microcode.nix index d30ebfefeeac..acce565fd808 100644 --- a/nixos/modules/hardware/cpu/intel-microcode.nix +++ b/nixos/modules/hardware/cpu/intel-microcode.nix @@ -11,7 +11,7 @@ with lib; hardware.cpu.intel.updateMicrocode = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Update the CPU microcode for Intel processors. ''; }; diff --git a/nixos/modules/hardware/cpu/intel-sgx.nix b/nixos/modules/hardware/cpu/intel-sgx.nix index 38a484cb126e..c66b43a2ec27 100644 --- a/nixos/modules/hardware/cpu/intel-sgx.nix +++ b/nixos/modules/hardware/cpu/intel-sgx.nix @@ -6,7 +6,7 @@ let in { options.hardware.cpu.intel.sgx.enableDcapCompat = mkOption { - description = lib.mdDoc '' + description = '' Whether to enable backward compatibility for SGX software build for the out-of-tree Intel SGX DCAP driver. @@ -20,19 +20,19 @@ in }; options.hardware.cpu.intel.sgx.provision = { - enable = mkEnableOption (lib.mdDoc "access to the Intel SGX provisioning device"); + enable = mkEnableOption "access to the Intel SGX provisioning device"; user = mkOption { - description = lib.mdDoc "Owner to assign to the SGX provisioning device."; + description = "Owner to assign to the SGX provisioning device."; type = types.str; default = "root"; }; group = mkOption { - description = lib.mdDoc "Group to assign to the SGX provisioning device."; + description = "Group to assign to the SGX provisioning device."; type = types.str; default = defaultPrvGroup; }; mode = mkOption { - description = lib.mdDoc "Mode to set for the SGX provisioning device."; + description = "Mode to set for the SGX provisioning device."; type = types.str; default = "0660"; }; diff --git a/nixos/modules/hardware/cpu/x86-msr.nix b/nixos/modules/hardware/cpu/x86-msr.nix index 554bec1b7db1..95e1be23cd95 100644 --- a/nixos/modules/hardware/cpu/x86-msr.nix +++ b/nixos/modules/hardware/cpu/x86-msr.nix @@ -5,7 +5,7 @@ }: let inherit (builtins) hasAttr; - inherit (lib) mkIf mdDoc; + inherit (lib) mkIf; cfg = config.hardware.cpu.x86.msr; opt = options.hardware.cpu.x86.msr; defaultGroup = "msr"; @@ -28,24 +28,24 @@ let in { options.hardware.cpu.x86.msr = with lib.options; with lib.types; { - enable = mkEnableOption (mdDoc "the `msr` (Model-Specific Registers) kernel module and configure `udev` rules for its devices (usually `/dev/cpu/*/msr`)"); + enable = mkEnableOption "the `msr` (Model-Specific Registers) kernel module and configure `udev` rules for its devices (usually `/dev/cpu/*/msr`)"; owner = mkOption { type = str; default = "root"; example = "nobody"; - description = mdDoc "Owner ${set}"; + description = "Owner ${set}"; }; group = mkOption { type = str; default = defaultGroup; example = "nobody"; - description = mdDoc "Group ${set}"; + description = "Group ${set}"; }; mode = mkOption { type = str; default = "0640"; example = "0660"; - description = mdDoc "Mode ${set}"; + description = "Mode ${set}"; }; settings = mkOption { type = submodule { diff --git a/nixos/modules/hardware/device-tree.nix b/nixos/modules/hardware/device-tree.nix index 6ab13c0eb709..a29cc76ea8f9 100644 --- a/nixos/modules/hardware/device-tree.nix +++ b/nixos/modules/hardware/device-tree.nix @@ -9,7 +9,7 @@ let options = { name = mkOption { type = types.str; - description = lib.mdDoc '' + description = '' Name of this overlay ''; }; @@ -18,14 +18,14 @@ let type = types.nullOr types.str; default = null; example = "*rpi*.dtb"; - description = lib.mdDoc '' + description = '' Only apply to .dtb files matching glob expression. ''; }; dtsFile = mkOption { type = types.nullOr types.path; - description = lib.mdDoc '' + description = '' Path to .dts overlay file, overlay is applied to each .dtb file matching "compatible" of the overlay. ''; @@ -36,7 +36,7 @@ let dtsText = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Literal DTS contents, overlay is applied to each .dtb file matching "compatible" of the overlay. ''; @@ -58,7 +58,7 @@ let dtboFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Path to .dtbo compiled overlay file. ''; }; @@ -105,7 +105,7 @@ in enable = mkOption { default = pkgs.stdenv.hostPlatform.linux-kernel.DTB or false; type = types.bool; - description = lib.mdDoc '' + description = '' Build device tree files. These are used to describe the non-discoverable hardware of a system. ''; @@ -116,7 +116,7 @@ in defaultText = literalExpression "config.boot.kernelPackages.kernel"; example = literalExpression "pkgs.linux_latest"; type = types.path; - description = lib.mdDoc '' + description = '' Kernel package where device tree include directory is from. Also used as default source of dtb package to apply overlays to ''; }; @@ -125,7 +125,7 @@ in default = []; example = literalExpression "[ \"-DMY_DTB_DEFINE\" ]"; type = types.listOf types.str; - description = lib.mdDoc '' + description = '' Additional flags to pass to the preprocessor during dtbo compilations ''; }; @@ -139,7 +139,7 @@ in ] ''; type = types.listOf types.path; - description = lib.mdDoc '' + description = '' Additional include paths that will be passed to the preprocessor when creating the final .dts to compile into .dtbo ''; }; @@ -148,7 +148,7 @@ in default = "${cfg.kernelPackage}/dtbs"; defaultText = literalExpression "\${cfg.kernelPackage}/dtbs"; type = types.path; - description = lib.mdDoc '' + description = '' Path to dtb directory that overlays and other processing will be applied to. Uses device trees bundled with the Linux kernel by default. ''; @@ -158,7 +158,7 @@ in default = null; example = "some-dtb.dtb"; type = types.nullOr types.str; - description = lib.mdDoc '' + description = '' The name of an explicit dtb to be loaded, relative to the dtb base. Useful in extlinux scenarios if the bootloader doesn't pick the right .dtb file from FDTDIR. @@ -169,7 +169,7 @@ in type = types.nullOr types.str; default = null; example = "*rpi*.dtb"; - description = lib.mdDoc '' + description = '' Only include .dtb files matching glob expression. ''; }; @@ -190,7 +190,7 @@ in filter = null; dtboFile = path; }) overlayType); - description = lib.mdDoc '' + description = '' List of overlays to apply to base device-tree (.dtb) files. ''; }; @@ -199,7 +199,7 @@ in default = null; type = types.nullOr types.path; internal = true; - description = lib.mdDoc '' + description = '' A path containing the result of applying `overlays` to `kernelPackage`. ''; }; diff --git a/nixos/modules/hardware/digitalbitbox.nix b/nixos/modules/hardware/digitalbitbox.nix index ea04d72a63a5..7df15288ecfe 100644 --- a/nixos/modules/hardware/digitalbitbox.nix +++ b/nixos/modules/hardware/digitalbitbox.nix @@ -11,7 +11,7 @@ in enable = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Enables udev rules for Digital Bitbox devices. ''; }; diff --git a/nixos/modules/hardware/flipperzero.nix b/nixos/modules/hardware/flipperzero.nix index 82f9b76fa3a7..3a6d29d0f9eb 100644 --- a/nixos/modules/hardware/flipperzero.nix +++ b/nixos/modules/hardware/flipperzero.nix @@ -9,7 +9,7 @@ let in { - options.hardware.flipperzero.enable = mkEnableOption (mdDoc "udev rules and software for Flipper Zero devices"); + options.hardware.flipperzero.enable = mkEnableOption "udev rules and software for Flipper Zero devices"; config = mkIf cfg.enable { environment.systemPackages = [ pkgs.qFlipper ]; diff --git a/nixos/modules/hardware/flirc.nix b/nixos/modules/hardware/flirc.nix index 2fe40db947e4..94ec715b9fa5 100644 --- a/nixos/modules/hardware/flirc.nix +++ b/nixos/modules/hardware/flirc.nix @@ -3,7 +3,7 @@ let cfg = config.hardware.flirc; in { - options.hardware.flirc.enable = lib.mkEnableOption (lib.mdDoc "software to configure a Flirc USB device"); + options.hardware.flirc.enable = lib.mkEnableOption "software to configure a Flirc USB device"; config = lib.mkIf cfg.enable { environment.systemPackages = [ pkgs.flirc ]; diff --git a/nixos/modules/hardware/gkraken.nix b/nixos/modules/hardware/gkraken.nix index f427fec0a7cc..97d15369db0a 100644 --- a/nixos/modules/hardware/gkraken.nix +++ b/nixos/modules/hardware/gkraken.nix @@ -7,7 +7,7 @@ let in { options.hardware.gkraken = { - enable = mkEnableOption (lib.mdDoc "gkraken's udev rules for NZXT AIO liquid coolers"); + enable = mkEnableOption "gkraken's udev rules for NZXT AIO liquid coolers"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/hardware/glasgow.nix b/nixos/modules/hardware/glasgow.nix index f8ebb772c47b..e63aa8bdb4bd 100644 --- a/nixos/modules/hardware/glasgow.nix +++ b/nixos/modules/hardware/glasgow.nix @@ -9,7 +9,7 @@ in enable = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc '' + description = '' Enables Glasgow udev rules and ensures 'plugdev' group exists. This is a prerequisite to using Glasgow without being root. ''; diff --git a/nixos/modules/hardware/gpgsmartcards.nix b/nixos/modules/hardware/gpgsmartcards.nix index 68e1e5f74e2e..cc3f4c769976 100644 --- a/nixos/modules/hardware/gpgsmartcards.nix +++ b/nixos/modules/hardware/gpgsmartcards.nix @@ -28,7 +28,7 @@ let cfg = config.hardware.gpgSmartcards; in { options.hardware.gpgSmartcards = { - enable = mkEnableOption (lib.mdDoc "udev rules for gnupg smart cards"); + enable = mkEnableOption "udev rules for gnupg smart cards"; }; config = mkIf cfg.enable { diff --git a/nixos/modules/hardware/hackrf.nix b/nixos/modules/hardware/hackrf.nix index 38ef7fa6d3d4..7f03b765bbda 100644 --- a/nixos/modules/hardware/hackrf.nix +++ b/nixos/modules/hardware/hackrf.nix @@ -9,7 +9,7 @@ in enable = lib.mkOption { |