nixos: use only URI fragment in manual options links

This commit is contained in:
Bobby Rong 2021-07-04 08:42:44 +08:00
parent 9c1623cbe4
commit 227811ac97
16 changed files with 42 additions and 53 deletions

View file

@ -6,6 +6,6 @@ use is in the NixOS installation CDs.
The enabled kernel modules include support for SATA and PATA, SCSI The enabled kernel modules include support for SATA and PATA, SCSI
(partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.), VMware, and (partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.), VMware, and
Hyper-V. Additionally, [`hardware.enableAllFirmware`](options.html#opt-hardware.enableAllFirmware) is Hyper-V. Additionally, [](#opt-hardware.enableAllFirmware) is
enabled, and the firmware for the ZyDAS ZD1211 chipset is specifically enabled, and the firmware for the ZyDAS ZD1211 chipset is specifically
installed. installed.

View file

@ -1,4 +1,4 @@
# Demo {#sec-profile-demo} # Demo {#sec-profile-demo}
This profile just enables a `demo` user, with password `demo`, uid `1000`, `wheel` group and This profile just enables a `demo` user, with password `demo`, uid `1000`, `wheel` group and
[autologin in the SDDM display manager](options.html#opt-services.xserver.displayManager.autoLogin). [autologin in the SDDM display manager](#opt-services.xserver.displayManager.autoLogin).

View file

@ -4,4 +4,4 @@ This is the profile from which the Docker images are generated. It prepares a
working system by importing the [Minimal](#sec-profile-minimal) and working system by importing the [Minimal](#sec-profile-minimal) and
[Clone Config](#sec-profile-clone-config) profiles, and [Clone Config](#sec-profile-clone-config) profiles, and
setting appropriate configuration options that are useful inside a container setting appropriate configuration options that are useful inside a container
context, like [`boot.isContainer`](options.html#opt-boot.isContainer). context, like [](#opt-boot.isContainer).

View file

@ -3,8 +3,8 @@
Defines a NixOS configuration with the Plasma 5 desktop. It's used by the Defines a NixOS configuration with the Plasma 5 desktop. It's used by the
graphical installation CD. graphical installation CD.
It sets [`services.xserver.enable`](options.html#opt-services.xserver.enable), It sets [](#opt-services.xserver.enable),
[`services.xserver.displayManager.sddm.enable`](options.html#opt-services.xserver.displayManager.sddm.enable), [](#opt-services.xserver.displayManager.sddm.enable),
[`services.xserver.desktopManager.plasma5.enable`](options.html#opt-services.xserver.desktopManager.plasma5.enable), [](#opt-services.xserver.desktopManager.plasma5.enable),
and [`services.xserver.libinput.enable`](options.html#opt-services.xserver.libinput.enable) to true. It also and [](#opt-services.xserver.libinput.enable) to true. It also
includes glxinfo and firefox in the system packages list. includes glxinfo and firefox in the system packages list.

View file

@ -8,7 +8,7 @@ available to processes through the `/sys` and
`/proc` filesystems. It also disables the User Namespaces `/proc` filesystems. It also disables the User Namespaces
feature of the kernel, which stops Nix from being able to build anything feature of the kernel, which stops Nix from being able to build anything
(this particular setting can be overriden via (this particular setting can be overriden via
[`security.allowUserNamespaces`](options.html#opt-security.allowUserNamespaces)). See the [](#opt-security.allowUserNamespaces)). See the
[profile source](https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix) [profile source](https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix)
for further detail on which settings are altered. for further detail on which settings are altered.

View file

@ -2,8 +2,8 @@
Common configuration for headless machines (e.g., Amazon EC2 instances). Common configuration for headless machines (e.g., Amazon EC2 instances).
Disables [sound](options.html#opt-sound.enable), Disables [sound](#opt-sound.enable),
[vesa](options.html#opt-boot.vesa), serial consoles, [vesa](#opt-boot.vesa), serial consoles,
[emergency mode](options.html#opt-systemd.enableEmergencyMode), [emergency mode](#opt-systemd.enableEmergencyMode),
[grub splash images](options.html#opt-boot.loader.grub.splashImage) [grub splash images](#opt-boot.loader.grub.splashImage)
and configures the kernel to reboot automatically on panic. and configures the kernel to reboot automatically on panic.

View file

@ -6,15 +6,15 @@ This enables redistributable firmware, includes the
and a copy of the Nixpkgs channel, so `nixos-install` and a copy of the Nixpkgs channel, so `nixos-install`
works out of the box. works out of the box.
Documentation for [Nixpkgs](options.html#opt-documentation.enable) Documentation for [Nixpkgs](#opt-documentation.enable)
and [NixOS](options.html#opt-documentation.nixos.enable) are and [NixOS](#opt-documentation.nixos.enable) are
forcefully enabled (to override the forcefully enabled (to override the
[Minimal profile](#sec-profile-minimal) preference); the [Minimal profile](#sec-profile-minimal) preference); the
NixOS manual is shown automatically on TTY 8, udisks is disabled. NixOS manual is shown automatically on TTY 8, udisks is disabled.
Autologin is enabled as `nixos` user, while passwordless Autologin is enabled as `nixos` user, while passwordless
login as both `root` and `nixos` is possible. login as both `root` and `nixos` is possible.
Passwordless `sudo` is enabled too. Passwordless `sudo` is enabled too.
[wpa_supplicant](options.html#opt-networking.wireless.enable) is [wpa_supplicant](#opt-networking.wireless.enable) is
enabled, but configured to not autostart. enabled, but configured to not autostart.
It is explained how to login, start the ssh server, and if available, It is explained how to login, start the ssh server, and if available,

View file

@ -2,8 +2,8 @@
This profile defines a small NixOS configuration. It does not contain any This profile defines a small NixOS configuration. It does not contain any
graphical stuff. It's a very short file that enables graphical stuff. It's a very short file that enables
[noXlibs](options.html#opt-environment.noXlibs), sets [noXlibs](#opt-environment.noXlibs), sets
[`i18n.supportedLocales`](options.html#opt-i18n.supportedLocales) to [](#opt-i18n.supportedLocales) to
only support the user-selected locale, only support the user-selected locale,
[disables packages' documentation](options.html#opt-documentation.enable), [disables packages' documentation](#opt-documentation.enable),
and [disables sound](options.html#opt-sound.enable). and [disables sound](#opt-sound.enable).

View file

@ -9,8 +9,7 @@
The enabled kernel modules include support for SATA and PATA, SCSI The enabled kernel modules include support for SATA and PATA, SCSI
(partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.), (partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.),
VMware, and Hyper-V. Additionally, VMware, and Hyper-V. Additionally,
<link xlink:href="options.html#opt-hardware.enableAllFirmware"><literal>hardware.enableAllFirmware</literal></link> <xref linkend="opt-hardware.enableAllFirmware" /> is enabled, and
is enabled, and the firmware for the ZyDAS ZD1211 chipset is the firmware for the ZyDAS ZD1211 chipset is specifically installed.
specifically installed.
</para> </para>
</section> </section>

View file

@ -4,7 +4,7 @@
This profile just enables a <literal>demo</literal> user, with This profile just enables a <literal>demo</literal> user, with
password <literal>demo</literal>, uid <literal>1000</literal>, password <literal>demo</literal>, uid <literal>1000</literal>,
<literal>wheel</literal> group and <literal>wheel</literal> group and
<link xlink:href="options.html#opt-services.xserver.displayManager.autoLogin">autologin <link linkend="opt-services.xserver.displayManager.autoLogin">autologin
in the SDDM display manager</link>. in the SDDM display manager</link>.
</para> </para>
</section> </section>

View file

@ -7,6 +7,6 @@
<link linkend="sec-profile-clone-config">Clone Config</link> <link linkend="sec-profile-clone-config">Clone Config</link>
profiles, and setting appropriate configuration options that are profiles, and setting appropriate configuration options that are
useful inside a container context, like useful inside a container context, like
<link xlink:href="options.html#opt-boot.isContainer"><literal>boot.isContainer</literal></link>. <xref linkend="opt-boot.isContainer" />.
</para> </para>
</section> </section>

View file

@ -5,13 +5,10 @@
by the graphical installation CD. by the graphical installation CD.
</para> </para>
<para> <para>
It sets It sets <xref linkend="opt-services.xserver.enable" />,
<link xlink:href="options.html#opt-services.xserver.enable"><literal>services.xserver.enable</literal></link>, <xref linkend="opt-services.xserver.displayManager.sddm.enable" />,
<link xlink:href="options.html#opt-services.xserver.displayManager.sddm.enable"><literal>services.xserver.displayManager.sddm.enable</literal></link>, <xref linkend="opt-services.xserver.desktopManager.plasma5.enable" />,
<link xlink:href="options.html#opt-services.xserver.desktopManager.plasma5.enable"><literal>services.xserver.desktopManager.plasma5.enable</literal></link>, and <xref linkend="opt-services.xserver.libinput.enable" /> to true.
and It also includes glxinfo and firefox in the system packages list.
<link xlink:href="options.html#opt-services.xserver.libinput.enable"><literal>services.xserver.libinput.enable</literal></link>
to true. It also includes glxinfo and firefox in the system packages
list.
</para> </para>
</section> </section>

View file

@ -10,8 +10,7 @@
<literal>/proc</literal> filesystems. It also disables the User <literal>/proc</literal> filesystems. It also disables the User
Namespaces feature of the kernel, which stops Nix from being able to Namespaces feature of the kernel, which stops Nix from being able to
build anything (this particular setting can be overriden via build anything (this particular setting can be overriden via
<link xlink:href="options.html#opt-security.allowUserNamespaces"><literal>security.allowUserNamespaces</literal></link>). <xref linkend="opt-security.allowUserNamespaces" />). See the
See the
<link xlink:href="https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix">profile <link xlink:href="https://github.com/nixos/nixpkgs/tree/master/nixos/modules/profiles/hardened.nix">profile
source</link> for further detail on which settings are altered. source</link> for further detail on which settings are altered.
</para> </para>

View file

@ -5,13 +5,10 @@
instances). instances).
</para> </para>
<para> <para>
Disables Disables <link linkend="opt-sound.enable">sound</link>,
<link xlink:href="options.html#opt-sound.enable">sound</link>, <link linkend="opt-boot.vesa">vesa</link>, serial consoles,
<link xlink:href="options.html#opt-boot.vesa">vesa</link>, serial <link linkend="opt-systemd.enableEmergencyMode">emergency
consoles, mode</link>, <link linkend="opt-boot.loader.grub.splashImage">grub
<link xlink:href="options.html#opt-systemd.enableEmergencyMode">emergency
mode</link>,
<link xlink:href="options.html#opt-boot.loader.grub.splashImage">grub
splash images</link> and configures the kernel to reboot splash images</link> and configures the kernel to reboot
automatically on panic. automatically on panic.
</para> </para>

View file

@ -9,17 +9,16 @@
</para> </para>
<para> <para>
Documentation for Documentation for
<link xlink:href="options.html#opt-documentation.enable">Nixpkgs</link> <link linkend="opt-documentation.enable">Nixpkgs</link> and
and <link linkend="opt-documentation.nixos.enable">NixOS</link> are
<link xlink:href="options.html#opt-documentation.nixos.enable">NixOS</link> forcefully enabled (to override the
are forcefully enabled (to override the
<link linkend="sec-profile-minimal">Minimal profile</link> <link linkend="sec-profile-minimal">Minimal profile</link>
preference); the NixOS manual is shown automatically on TTY 8, preference); the NixOS manual is shown automatically on TTY 8,
udisks is disabled. Autologin is enabled as <literal>nixos</literal> udisks is disabled. Autologin is enabled as <literal>nixos</literal>
user, while passwordless login as both <literal>root</literal> and user, while passwordless login as both <literal>root</literal> and
<literal>nixos</literal> is possible. Passwordless <literal>nixos</literal> is possible. Passwordless
<literal>sudo</literal> is enabled too. <literal>sudo</literal> is enabled too.
<link xlink:href="options.html#opt-networking.wireless.enable">wpa_supplicant</link> <link linkend="opt-networking.wireless.enable">wpa_supplicant</link>
is enabled, but configured to not autostart. is enabled, but configured to not autostart.
</para> </para>
<para> <para>

View file

@ -3,13 +3,11 @@
<para> <para>
This profile defines a small NixOS configuration. It does not This profile defines a small NixOS configuration. It does not
contain any graphical stuff. Its a very short file that enables contain any graphical stuff. Its a very short file that enables
<link xlink:href="options.html#opt-environment.noXlibs">noXlibs</link>, <link linkend="opt-environment.noXlibs">noXlibs</link>, sets
sets <xref linkend="opt-i18n.supportedLocales" /> to only support the
<link xlink:href="options.html#opt-i18n.supportedLocales"><literal>i18n.supportedLocales</literal></link> user-selected locale,
to only support the user-selected locale, <link linkend="opt-documentation.enable">disables packages
<link xlink:href="options.html#opt-documentation.enable">disables documentation</link>, and <link linkend="opt-sound.enable">disables
packages documentation</link>, and
<link xlink:href="options.html#opt-sound.enable">disables
sound</link>. sound</link>.
</para> </para>
</section> </section>