From 9547123258f69efd92b54763051d6dc7f3bfcaca Mon Sep 17 00:00:00 2001 From: pennae Date: Mon, 29 Aug 2022 01:38:36 +0200 Subject: nixos/*: convert internal option descriptions to MD we'll have to do it eventually, may as well be now. --- nixos/modules/system/activation/activation-script.nix | 6 +++--- nixos/modules/system/activation/top-level.nix | 12 ++++++------ nixos/modules/system/boot/binfmt.nix | 2 +- nixos/modules/system/boot/kernel.nix | 6 +++--- nixos/modules/system/boot/kernel_config.nix | 2 +- nixos/modules/system/boot/luksroot.nix | 6 +++--- nixos/modules/system/boot/networkd.nix | 2 +- nixos/modules/system/boot/stage-1.nix | 8 ++++---- nixos/modules/system/boot/systemd/user.nix | 2 +- 9 files changed, 23 insertions(+), 23 deletions(-) (limited to 'nixos/modules/system') diff --git a/nixos/modules/system/activation/activation-script.nix b/nixos/modules/system/activation/activation-script.nix index 5a61d5463d21..f26b02b9324e 100644 --- a/nixos/modules/system/activation/activation-script.nix +++ b/nixos/modules/system/activation/activation-script.nix @@ -139,7 +139,7 @@ in }; system.dryActivationScript = mkOption { - description = "The shell script that is to be run when dry-activating a system."; + description = lib.mdDoc "The shell script that is to be run when dry-activating a system."; readOnly = true; internal = true; default = systemActivationScript (removeAttrs config.system.activationScripts [ "script" ]) true; @@ -199,9 +199,9 @@ in example = literalExpression ''"''${pkgs.busybox}/bin/env"''; type = types.nullOr types.path; visible = false; - description = '' + description = lib.mdDoc '' The env(1) executable that is linked system-wide to - /usr/bin/env. + `/usr/bin/env`. ''; }; }; diff --git a/nixos/modules/system/activation/top-level.nix b/nixos/modules/system/activation/top-level.nix index 9f27727cbf8b..d3379a7f5369 100644 --- a/nixos/modules/system/activation/top-level.nix +++ b/nixos/modules/system/activation/top-level.nix @@ -207,7 +207,7 @@ in system.boot.loader.id = mkOption { internal = true; default = ""; - description = '' + description = lib.mdDoc '' Id string of the used bootloader. ''; }; @@ -217,7 +217,7 @@ in default = pkgs.stdenv.hostPlatform.linux-kernel.target; defaultText = literalExpression "pkgs.stdenv.hostPlatform.linux-kernel.target"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the kernel file to be passed to the bootloader. ''; }; @@ -226,7 +226,7 @@ in internal = true; default = "initrd"; type = types.str; - description = '' + description = lib.mdDoc '' Name of the initrd file to be passed to the bootloader. ''; }; @@ -238,10 +238,10 @@ in # go to `true` instead of `echo`, hiding the useless path # from the log. default = "echo 'Warning: do not know how to make this configuration bootable; please enable a boot loader.' 1>&2; true"; - description = '' + description = lib.mdDoc '' A program that writes a bootloader installation script to the path passed in the first command line argument. - See nixos/modules/system/activation/switch-to-configuration.pl. + See `nixos/modules/system/activation/switch-to-configuration.pl`. ''; type = types.unique { message = '' @@ -280,7 +280,7 @@ in type = types.lines; internal = true; default = ""; - description = '' + description = lib.mdDoc '' This code will be added to the builder creating the system store path. ''; }; diff --git a/nixos/modules/system/boot/binfmt.nix b/nixos/modules/system/boot/binfmt.nix index 4d95af61ac94..260638ceed50 100644 --- a/nixos/modules/system/boot/binfmt.nix +++ b/nixos/modules/system/boot/binfmt.nix @@ -256,7 +256,7 @@ in { interpreterSandboxPath = mkOption { internal = true; default = null; - description = '' + description = lib.mdDoc '' Path of the interpreter to expose in the build sandbox. ''; type = types.nullOr types.path; diff --git a/nixos/modules/system/boot/kernel.nix b/nixos/modules/system/boot/kernel.nix index 0d2858462214..8a1630f7e3eb 100644 --- a/nixos/modules/system/boot/kernel.nix +++ b/nixos/modules/system/boot/kernel.nix @@ -25,7 +25,7 @@ in default = {}; example = literalExpression "{ debug = true; }"; internal = true; - description = '' + description = lib.mdDoc '' This option allows to enable or disable certain kernel features. It's not API, because it's about kernel feature sets, that make sense for specific use cases. Mostly along with programs, @@ -173,7 +173,7 @@ in type = types.listOf types.path; internal = true; default = []; - description = '' + description = lib.mdDoc '' Tree of kernel modules. This includes the kernel, plus modules built outside of the kernel. Combine these into a single tree of symlinks because modprobe only supports one directory. @@ -193,7 +193,7 @@ in ''; internal = true; type = types.listOf types.attrs; - description = '' + description = lib.mdDoc '' This option allows modules to specify the kernel config options that must be set (or unset) for the module to work. Please use the lib.kernelConfig functions to build list elements. diff --git a/nixos/modules/system/boot/kernel_config.nix b/nixos/modules/system/boot/kernel_config.nix index 997c404be168..31e9ec626ca6 100644 --- a/nixos/modules/system/boot/kernel_config.nix +++ b/nixos/modules/system/boot/kernel_config.nix @@ -14,7 +14,7 @@ let default = null; internal = true; visible = true; - description = '' + description = lib.mdDoc '' Use this field for tristate kernel options expecting a "y" or "m" or "n". ''; }; diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix index 8cd16974916c..a076ea24a422 100644 --- a/nixos/modules/system/boot/luksroot.nix +++ b/nixos/modules/system/boot/luksroot.nix @@ -523,7 +523,7 @@ in type = types.bool; default = false; internal = true; - description = '' + description = lib.mdDoc '' Whether to configure luks support in the initrd, when no luks devices are configured. ''; @@ -563,7 +563,7 @@ in default = name; example = "luksroot"; type = types.str; - description = "Name of the unencrypted device in /dev/mapper."; + description = lib.mdDoc "Name of the unencrypted device in {file}`/dev/mapper`."; }; device = mkOption { @@ -819,7 +819,7 @@ in default = []; example = [ "_netdev" ]; visible = false; - description = '' + description = lib.mdDoc '' Only used with systemd stage 1. Extra options to append to the last column of the generated crypttab file. diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix index 1fe7691fc9a7..a0b433889d66 100644 --- a/nixos/modules/system/boot/networkd.nix +++ b/nixos/modules/system/boot/networkd.nix @@ -1824,7 +1824,7 @@ in }; systemd.network.units = mkOption { - description = "Definition of networkd units."; + description = lib.mdDoc "Definition of networkd units."; default = {}; internal = true; type = with types; attrsOf (submodule ( diff --git a/nixos/modules/system/boot/stage-1.nix b/nixos/modules/system/boot/stage-1.nix index 53d998c48a14..28c76fb169f1 100644 --- a/nixos/modules/system/boot/stage-1.nix +++ b/nixos/modules/system/boot/stage-1.nix @@ -575,7 +575,7 @@ in internal = true; default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed in the builder of the extra-utils derivation. This can be used to provide additional utilities in the initial ramdisk. @@ -586,7 +586,7 @@ in internal = true; default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed in the builder of the extra-utils derivation after patchelf has done its job. This can be used to test additional utilities @@ -598,7 +598,7 @@ in internal = true; default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Shell commands to be executed in the builder of the udev-rules derivation. This can be used to add additional udev rules in the initial ramdisk. @@ -676,7 +676,7 @@ in default = false; type = types.bool; description = - '' + lib.mdDoc '' Whether the bootloader setup runs append-initrd-secrets. If not, any needed secrets must be copied into the initrd and thus added to the store. diff --git a/nixos/modules/system/boot/systemd/user.nix b/nixos/modules/system/boot/systemd/user.nix index 3200a58d73c9..46d66fe4e688 100644 --- a/nixos/modules/system/boot/systemd/user.nix +++ b/nixos/modules/system/boot/systemd/user.nix @@ -97,7 +97,7 @@ in { default = []; type = types.listOf types.str; example = []; - description = '' + description = lib.mdDoc '' Additional units shipped with systemd that should be enabled for per-user systemd instances. ''; internal = true; -- cgit 1.4.1