summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorBobby Rong <rjl931189261@126.com>2021-07-04 08:42:44 +0800
committerBobby Rong <rjl931189261@126.com>2021-07-04 08:42:44 +0800
commit227811ac97db3e1b158a91815d0c521e4f56ae20 (patch)
treef1047e783835a0f48419f413e05de478b54f1af8 /nixos
parent9c1623cbe45600298c152250e2a41342131aa7bd (diff)
downloadnixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.tar
nixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.tar.gz
nixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.tar.bz2
nixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.tar.lz
nixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.tar.xz
nixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.tar.zst
nixpkgs-227811ac97db3e1b158a91815d0c521e4f56ae20.zip
nixos: use only URI fragment in manual options links
Diffstat (limited to 'nixos')
-rw-r--r--nixos/doc/manual/configuration/profiles/all-hardware.section.md2
-rw-r--r--nixos/doc/manual/configuration/profiles/demo.section.md2
-rw-r--r--nixos/doc/manual/configuration/profiles/docker-container.section.md2
-rw-r--r--nixos/doc/manual/configuration/profiles/graphical.section.md8
-rw-r--r--nixos/doc/manual/configuration/profiles/hardened.section.md2
-rw-r--r--nixos/doc/manual/configuration/profiles/headless.section.md8
-rw-r--r--nixos/doc/manual/configuration/profiles/installation-device.section.md6
-rw-r--r--nixos/doc/manual/configuration/profiles/minimal.section.md8
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/all-hardware.section.xml5
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/demo.section.xml2
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/docker-container.section.xml2
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/graphical.section.xml13
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/hardened.section.xml3
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/headless.section.xml11
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/installation-device.section.xml9
-rw-r--r--nixos/doc/manual/from_md/configuration/profiles/minimal.section.xml12
16 files changed, 42 insertions, 53 deletions
diff --git a/nixos/doc/manual/configuration/profiles/all-hardware.section.md b/nixos/doc/manual/configuration/profiles/all-hardware.section.md
index 0344b32c52f..e2dd7c76089 100644
--- a/nixos/doc/manual/configuration/profiles/all-hardware.section.md
+++ b/nixos/doc/manual/configuration/profiles/all-hardware.section.md
@@ -6,6 +6,6 @@ use is in the NixOS installation CDs.
 
 The enabled kernel modules include support for SATA and PATA, SCSI
 (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
 installed.
diff --git a/nixos/doc/manual/configuration/profiles/demo.section.md b/nixos/doc/manual/configuration/profiles/demo.section.md
index a50f5a00ada..0a0df483c12 100644
--- a/nixos/doc/manual/configuration/profiles/demo.section.md
+++ b/nixos/doc/manual/configuration/profiles/demo.section.md
@@ -1,4 +1,4 @@
 # Demo {#sec-profile-demo}
 
 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).
diff --git a/nixos/doc/manual/configuration/profiles/docker-container.section.md b/nixos/doc/manual/configuration/profiles/docker-container.section.md
index 59954112c30..f3e29b92f5e 100644
--- a/nixos/doc/manual/configuration/profiles/docker-container.section.md
+++ b/nixos/doc/manual/configuration/profiles/docker-container.section.md
@@ -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
 [Clone Config](#sec-profile-clone-config) profiles, and
 setting appropriate configuration options that are useful inside a container
-context, like [`boot.isContainer`](options.html#opt-boot.isContainer).
+context, like [](#opt-boot.isContainer).
diff --git a/nixos/doc/manual/configuration/profiles/graphical.section.md b/nixos/doc/manual/configuration/profiles/graphical.section.md
index 767cde9b79e..aaea5c8c028 100644
--- a/nixos/doc/manual/configuration/profiles/graphical.section.md
+++ b/nixos/doc/manual/configuration/profiles/graphical.section.md
@@ -3,8 +3,8 @@
 Defines a NixOS configuration with the Plasma 5 desktop. It's used by the
 graphical installation CD.
 
-It sets [`services.xserver.enable`](options.html#opt-services.xserver.enable),
-[`services.xserver.displayManager.sddm.enable`](options.html#opt-services.xserver.displayManager.sddm.enable),
-[`services.xserver.desktopManager.plasma5.enable`](options.html#opt-services.xserver.desktopManager.plasma5.enable),
-and [`services.xserver.libinput.enable`](options.html#opt-services.xserver.libinput.enable) to true. It also
+It sets [](#opt-services.xserver.enable),
+[](#opt-services.xserver.displayManager.sddm.enable),
+[](#opt-services.xserver.desktopManager.plasma5.enable),
+and [](#opt-services.xserver.libinput.enable) to true. It also
 includes glxinfo and firefox in the system packages list.
diff --git a/nixos/doc/manual/configuration/profiles/hardened.section.md b/nixos/doc/manual/configuration/profiles/hardened.section.md
index 958da94d261..9fb5e18c384 100644
--- a/nixos/doc/manual/configuration/profiles/hardened.section.md
+++ b/nixos/doc/manual/configuration/profiles/hardened.section.md
@@ -8,7 +8,7 @@ available to processes through the `/sys` and
 `/proc` filesystems. It also disables the User Namespaces
 feature of the kernel, which stops Nix from being able to build anything
 (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)
 for further detail on which settings are altered.
 
diff --git a/nixos/doc/manual/configuration/profiles/headless.section.md b/nixos/doc/manual/configuration/profiles/headless.section.md
index 1db4a82a4de..d185a9a774b 100644
--- a/nixos/doc/manual/configuration/profiles/headless.section.md
+++ b/nixos/doc/manual/configuration/profiles/headless.section.md
@@ -2,8 +2,8 @@
 
 Common configuration for headless machines (e.g., Amazon EC2 instances).
 
-Disables [sound](options.html#opt-sound.enable),
-[vesa](options.html#opt-boot.vesa), serial consoles,
-[emergency mode](options.html#opt-systemd.enableEmergencyMode),
-[grub splash images](options.html#opt-boot.loader.grub.splashImage)
+Disables [sound](#opt-sound.enable),
+[vesa](#opt-boot.vesa), serial consoles,
+[emergency mode](#opt-systemd.enableEmergencyMode),
+[grub splash images](#opt-boot.loader.grub.splashImage)
 and configures the kernel to reboot automatically on panic.
diff --git a/nixos/doc/manual/configuration/profiles/installation-device.section.md b/nixos/doc/manual/configuration/profiles/installation-device.section.md
index aa5678c031a..ae9f8fa7757 100644
--- a/nixos/doc/manual/configuration/profiles/installation-device.section.md
+++ b/nixos/doc/manual/configuration/profiles/installation-device.section.md
@@ -6,15 +6,15 @@ This enables redistributable firmware, includes the
 and a copy of the Nixpkgs channel, so `nixos-install`
 works out of the box.
 
-Documentation for [Nixpkgs](options.html#opt-documentation.enable)
-and [NixOS](options.html#opt-documentation.nixos.enable) are
+Documentation for [Nixpkgs](#opt-documentation.enable)
+and [NixOS](#opt-documentation.nixos.enable) are
 forcefully enabled (to override the
 [Minimal profile](#sec-profile-minimal) preference); the
 NixOS manual is shown automatically on TTY 8, udisks is disabled.
 Autologin is enabled as `nixos` user, while passwordless
 login as both `root` and `nixos` is possible.
 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.
 
 It is explained how to login, start the ssh server, and if available,
diff --git a/nixos/doc/manual/configuration/profiles/minimal.section.md b/nixos/doc/manual/configuration/profiles/minimal.section.md
index d5a569d6620..02a3b65ae42 100644
--- a/nixos/doc/manual/configuration/profiles/minimal.section.md
+++ b/nixos/doc/manual/configuration/profiles/minimal.section.md
@@ -2,8 +2,8 @@
 
 This profile defines a small NixOS configuration. It does not contain any
 graphical stuff. It's a very short file that enables
-[noXlibs](options.html#opt-environment.noXlibs), sets
-[`i18n.supportedLocales`](options.html#opt-i18n.supportedLocales) to
+[noXlibs](#opt-environment.noXlibs), sets
+[](#opt-i18n.supportedLocales) to
 only support the user-selected locale,
-[disables packages' documentation](options.html#opt-documentation.enable),
-and [disables sound](options.html#opt-sound.enable).
+[disables packages' documentation](#opt-documentation.enable),
+and [disables sound](#opt-sound.enable).
diff --git a/nixos/doc/manual/from_md/configuration/profiles/all-hardware.section.xml b/nixos/doc/manual/from_md/configuration/profiles/all-hardware.section.xml
index e355ffb752d..43ac5edea7f 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/all-hardware.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/all-hardware.section.xml
@@ -9,8 +9,7 @@
     The enabled kernel modules include support for SATA and PATA, SCSI
     (partially), USB, Firewire (untested), Virtio (QEMU, KVM, etc.),
     VMware, and Hyper-V. Additionally,
-    <link xlink:href="options.html#opt-hardware.enableAllFirmware"><literal>hardware.enableAllFirmware</literal></link>
-    is enabled, and the firmware for the ZyDAS ZD1211 chipset is
-    specifically installed.
+    <xref linkend="opt-hardware.enableAllFirmware" /> is enabled, and
+    the firmware for the ZyDAS ZD1211 chipset is specifically installed.
   </para>
 </section>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/demo.section.xml b/nixos/doc/manual/from_md/configuration/profiles/demo.section.xml
index 8b8c09118d9..09c2680a106 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/demo.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/demo.section.xml
@@ -4,7 +4,7 @@
     This profile just enables a <literal>demo</literal> user, with
     password <literal>demo</literal>, uid <literal>1000</literal>,
     <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>.
   </para>
 </section>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/docker-container.section.xml b/nixos/doc/manual/from_md/configuration/profiles/docker-container.section.xml
index 28dcd2b1a2d..97c2a92dcab 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/docker-container.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/docker-container.section.xml
@@ -7,6 +7,6 @@
     <link linkend="sec-profile-clone-config">Clone Config</link>
     profiles, and setting appropriate configuration options that are
     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>
 </section>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/graphical.section.xml b/nixos/doc/manual/from_md/configuration/profiles/graphical.section.xml
index 644a8ea590b..1b109519d43 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/graphical.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/graphical.section.xml
@@ -5,13 +5,10 @@
     by the graphical installation CD.
   </para>
   <para>
-    It sets
-    <link xlink:href="options.html#opt-services.xserver.enable"><literal>services.xserver.enable</literal></link>,
-    <link xlink:href="options.html#opt-services.xserver.displayManager.sddm.enable"><literal>services.xserver.displayManager.sddm.enable</literal></link>,
-    <link xlink:href="options.html#opt-services.xserver.desktopManager.plasma5.enable"><literal>services.xserver.desktopManager.plasma5.enable</literal></link>,
-    and
-    <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.
+    It sets <xref linkend="opt-services.xserver.enable" />,
+    <xref linkend="opt-services.xserver.displayManager.sddm.enable" />,
+    <xref linkend="opt-services.xserver.desktopManager.plasma5.enable" />,
+    and <xref linkend="opt-services.xserver.libinput.enable" /> to true.
+    It also includes glxinfo and firefox in the system packages list.
   </para>
 </section>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/hardened.section.xml b/nixos/doc/manual/from_md/configuration/profiles/hardened.section.xml
index a08bc843230..44c11786d94 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/hardened.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/hardened.section.xml
@@ -10,8 +10,7 @@
     <literal>/proc</literal> filesystems. It also disables the User
     Namespaces feature of the kernel, which stops Nix from being able to
     build anything (this particular setting can be overriden via
-    <link xlink:href="options.html#opt-security.allowUserNamespaces"><literal>security.allowUserNamespaces</literal></link>).
-    See the
+    <xref linkend="opt-security.allowUserNamespaces" />). See the
     <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.
   </para>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/headless.section.xml b/nixos/doc/manual/from_md/configuration/profiles/headless.section.xml
index a89551abd41..0910b9ffaad 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/headless.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/headless.section.xml
@@ -5,13 +5,10 @@
     instances).
   </para>
   <para>
-    Disables
-    <link xlink:href="options.html#opt-sound.enable">sound</link>,
-    <link xlink:href="options.html#opt-boot.vesa">vesa</link>, serial
-    consoles,
-    <link xlink:href="options.html#opt-systemd.enableEmergencyMode">emergency
-    mode</link>,
-    <link xlink:href="options.html#opt-boot.loader.grub.splashImage">grub
+    Disables <link linkend="opt-sound.enable">sound</link>,
+    <link linkend="opt-boot.vesa">vesa</link>, serial consoles,
+    <link linkend="opt-systemd.enableEmergencyMode">emergency
+    mode</link>, <link linkend="opt-boot.loader.grub.splashImage">grub
     splash images</link> and configures the kernel to reboot
     automatically on panic.
   </para>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/installation-device.section.xml b/nixos/doc/manual/from_md/configuration/profiles/installation-device.section.xml
index 8a8265c03c0..837e69df06e 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/installation-device.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/installation-device.section.xml
@@ -9,17 +9,16 @@
   </para>
   <para>
     Documentation for
-    <link xlink:href="options.html#opt-documentation.enable">Nixpkgs</link>
-    and
-    <link xlink:href="options.html#opt-documentation.nixos.enable">NixOS</link>
-    are forcefully enabled (to override the
+    <link linkend="opt-documentation.enable">Nixpkgs</link> and
+    <link linkend="opt-documentation.nixos.enable">NixOS</link> are
+    forcefully enabled (to override the
     <link linkend="sec-profile-minimal">Minimal profile</link>
     preference); the NixOS manual is shown automatically on TTY 8,
     udisks is disabled. Autologin is enabled as <literal>nixos</literal>
     user, while passwordless login as both <literal>root</literal> and
     <literal>nixos</literal> is possible. Passwordless
     <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.
   </para>
   <para>
diff --git a/nixos/doc/manual/from_md/configuration/profiles/minimal.section.xml b/nixos/doc/manual/from_md/configuration/profiles/minimal.section.xml
index 5653b3f01c3..a3fe30357df 100644
--- a/nixos/doc/manual/from_md/configuration/profiles/minimal.section.xml
+++ b/nixos/doc/manual/from_md/configuration/profiles/minimal.section.xml
@@ -3,13 +3,11 @@
   <para>
     This profile defines a small NixOS configuration. It does not
     contain any graphical stuff. It’s a very short file that enables
-    <link xlink:href="options.html#opt-environment.noXlibs">noXlibs</link>,
-    sets
-    <link xlink:href="options.html#opt-i18n.supportedLocales"><literal>i18n.supportedLocales</literal></link>
-    to only support the user-selected locale,
-    <link xlink:href="options.html#opt-documentation.enable">disables
-    packages’ documentation</link>, and
-    <link xlink:href="options.html#opt-sound.enable">disables
+    <link linkend="opt-environment.noXlibs">noXlibs</link>, sets
+    <xref linkend="opt-i18n.supportedLocales" /> to only support the
+    user-selected locale,
+    <link linkend="opt-documentation.enable">disables packages’
+    documentation</link>, and <link linkend="opt-sound.enable">disables
     sound</link>.
   </para>
 </section>