diff options
Diffstat (limited to 'nixos/modules/system/boot')
| -rw-r--r-- | nixos/modules/system/boot/initrd-network.nix | 13 | ||||
| -rw-r--r-- | nixos/modules/system/boot/loader/grub/grub.nix | 12 | ||||
| -rw-r--r-- | nixos/modules/system/boot/luksroot.nix | 4 | ||||
| -rw-r--r-- | nixos/modules/system/boot/networkd.nix | 11 | ||||
| -rw-r--r-- | nixos/modules/system/boot/stage-1.nix | 2 | ||||
| -rw-r--r-- | nixos/modules/system/boot/systemd/logind.nix | 9 | ||||
| -rw-r--r-- | nixos/modules/system/boot/systemd/tmpfiles.nix | 10 |
7 files changed, 27 insertions, 34 deletions
diff --git a/nixos/modules/system/boot/initrd-network.nix b/nixos/modules/system/boot/initrd-network.nix index 43327fdd9da..a1017c3e242 100644 --- a/nixos/modules/system/boot/initrd-network.nix +++ b/nixos/modules/system/boot/initrd-network.nix @@ -50,18 +50,17 @@ in boot.initrd.network.enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Add network connectivity support to initrd. The network may be - configured using the <literal>ip</literal> kernel parameter, - as described in <link - xlink:href="https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt">the - kernel documentation</link>. Otherwise, if - <option>networking.useDHCP</option> is enabled, an IP address + configured using the `ip` kernel parameter, + as described in [the kernel documentation](https://www.kernel.org/doc/Documentation/filesystems/nfs/nfsroot.txt). + Otherwise, if + {option}`networking.useDHCP` is enabled, an IP address is acquired using DHCP. You should add the module(s) required for your network card to boot.initrd.availableKernelModules. - <literal>lspci -v | grep -iA8 'network\|ethernet'</literal> + `lspci -v | grep -iA8 'network\|ethernet'` will tell you which. ''; }; diff --git a/nixos/modules/system/boot/loader/grub/grub.nix b/nixos/modules/system/boot/loader/grub/grub.nix index 00ec3d237d5..1ad7cd81094 100644 --- a/nixos/modules/system/boot/loader/grub/grub.nix +++ b/nixos/modules/system/boot/loader/grub/grub.nix @@ -624,9 +624,9 @@ in type = types.bool; description = '' Whether to invoke <literal>grub-install</literal> with - <literal>--removable</literal>.</para> + <literal>--removable</literal>. - <para>Unless you turn this on, GRUB will install itself somewhere in + Unless you turn this on, GRUB will install itself somewhere in <literal>boot.loader.efi.efiSysMountPoint</literal> (exactly where depends on other config variables). If you've set <literal>boot.loader.efi.canTouchEfiVariables</literal> *AND* you @@ -637,14 +637,14 @@ in NVRAM will not be modified, and your system will not find GRUB at boot time. However, GRUB will still return success so you may miss the warning that gets printed ("<literal>efibootmgr: EFI variables - are not supported on this system.</literal>").</para> + are not supported on this system.</literal>"). - <para>If you turn this feature on, GRUB will install itself in a + If you turn this feature on, GRUB will install itself in a special location within <literal>efiSysMountPoint</literal> (namely <literal>EFI/boot/boot$arch.efi</literal>) which the firmwares - are hardcoded to try first, regardless of NVRAM EFI variables.</para> + are hardcoded to try first, regardless of NVRAM EFI variables. - <para>To summarize, turn this on if: + To summarize, turn this on if: <itemizedlist> <listitem><para>You are installing NixOS and want it to boot in UEFI mode, but you are currently booted in legacy mode</para></listitem> diff --git a/nixos/modules/system/boot/luksroot.nix b/nixos/modules/system/boot/luksroot.nix index a48cc5ec489..78301a57bd9 100644 --- a/nixos/modules/system/boot/luksroot.nix +++ b/nixos/modules/system/boot/luksroot.nix @@ -548,11 +548,11 @@ in boot.initrd.luks.devices = mkOption { default = { }; example = { luksroot.device = "/dev/disk/by-uuid/430e9eff-d852-4f68-aa3b-2fa3599ebe08"; }; - description = '' + description = lib.mdDoc '' The encrypted disk that should be opened before the root filesystem is mounted. Both LVM-over-LUKS and LUKS-over-LVM setups are supported. The unencrypted devices can be accessed as - <filename>/dev/mapper/<replaceable>name</replaceable></filename>. + {file}`/dev/mapper/«name»`. ''; type = with types; attrsOf (submodule ( diff --git a/nixos/modules/system/boot/networkd.nix b/nixos/modules/system/boot/networkd.nix index ba335bcd769..dd4c63ab725 100644 --- a/nixos/modules/system/boot/networkd.nix +++ b/nixos/modules/system/boot/networkd.nix @@ -1170,8 +1170,7 @@ let <citerefentry><refentrytitle>systemd.netdev</refentrytitle> <manvolnum>5</manvolnum></citerefentry> for details. A detailed explanation about how VRFs work can be found in the - <link xlink:href="https://www.kernel.org/doc/Documentation/networking/vrf.txt">kernel - docs</link>. + <link xlink:href="https://www.kernel.org/doc/Documentation/networking/vrf.txt">kernel docs</link>. ''; }; @@ -1905,13 +1904,11 @@ in }; extraArgs = mkOption { - description = '' + description = lib.mdDoc '' Extra command-line arguments to pass to systemd-networkd-wait-online. - These also affect per-interface <literal>systemd-network-wait-online@</literal> services. + These also affect per-interface `systemd-network-wait-online@` services. - See <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.service.html"> - <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry></link> for all available options. + See [{manpage}`systemd-networkd-wait-online.service(8)`](https://www.freedesktop.org/software/systemd/man/systemd-networkd-wait-online.service.html) for all available options. ''; type = with types; listOf str; default = []; diff --git a/nixos/modules/system/boot/stage-1.nix b/nixos/modules/system/boot/stage-1.nix index f3b9d798f61..ec2f3d18c68 100644 --- a/nixos/modules/system/boot/stage-1.nix +++ b/nixos/modules/system/boot/stage-1.nix @@ -480,7 +480,7 @@ in if you want to resume from file. If left empty, the swap partitions are used. Specify here the device where the file resides. You should also use <varname>boot.kernelParams</varname> to specify - <literal><replaceable>resume_offset</replaceable></literal>. + <literal>«resume_offset»</literal>. ''; }; diff --git a/nixos/modules/system/boot/systemd/logind.nix b/nixos/modules/system/boot/systemd/logind.nix index cb8fc448a9e..59801603213 100644 --- a/nixos/modules/system/boot/systemd/logind.nix +++ b/nixos/modules/system/boot/systemd/logind.nix @@ -26,17 +26,14 @@ in services.logind.killUserProcesses = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Specifies whether the processes of a user should be killed when the user logs out. If true, the scope unit corresponding to the session and all processes inside that scope will be terminated. If false, the scope is "abandoned" (see - <link xlink:href="https://www.freedesktop.org/software/systemd/man/systemd.scope.html#"> - systemd.scope(5)</link>), and processes are not killed. - </para> + [systemd.scope(5)](https://www.freedesktop.org/software/systemd/man/systemd.scope.html#)), and processes are not killed. - <para> - See <link xlink:href="https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=">logind.conf(5)</link> + See [logind.conf(5)](https://www.freedesktop.org/software/systemd/man/logind.conf.html#KillUserProcesses=) for more details. ''; }; diff --git a/nixos/modules/system/boot/systemd/tmpfiles.nix b/nixos/modules/system/boot/systemd/tmpfiles.nix index eaa0ddf6387..e990e953b05 100644 --- a/nixos/modules/system/boot/systemd/tmpfiles.nix +++ b/nixos/modules/system/boot/systemd/tmpfiles.nix @@ -25,16 +25,16 @@ in default = []; example = literalExpression "[ pkgs.lvm2 ]"; apply = map getLib; - description = '' - List of packages containing <command>systemd-tmpfiles</command> rules. + description = lib.mdDoc '' + List of packages containing {command}`systemd-tmpfiles` rules. All files ending in .conf found in - <filename><replaceable>pkg</replaceable>/lib/tmpfiles.d</filename> + {file}`«pkg»/lib/tmpfiles.d` will be included. If this folder does not exist or does not contain any files an error will be returned instead. - If a <filename>lib</filename> output is available, rules are searched there and only there. - If there is no <filename>lib</filename> output it will fall back to <filename>out</filename> + If a {file}`lib` output is available, rules are searched there and only there. + If there is no {file}`lib` output it will fall back to {file}`out` and if that does not exist either, the default output will be used. ''; }; |