diff options
author | Graham Christensen <graham@grahamc.com> | 2018-09-01 15:49:04 -0400 |
---|---|---|
committer | Graham Christensen <graham@grahamc.com> | 2018-09-01 16:20:49 -0400 |
commit | 18fd616351a25622b1dc43c59d0c52ace5bfe3ef (patch) | |
tree | e0af257354898c85e75899e9152730de64b72844 /nixos/doc | |
parent | 03b89e3031bb983fcc59a9f7794157e2e7b67102 (diff) |
nixos docs: Give sections IDs
Diffstat (limited to 'nixos/doc')
-rw-r--r-- | nixos/doc/manual/configuration/linux-kernel.xml | 11 | ||||
-rw-r--r-- | nixos/doc/manual/development/assertions.xml | 4 | ||||
-rw-r--r-- | nixos/doc/manual/development/option-types.xml | 12 | ||||
-rw-r--r-- | nixos/doc/manual/development/writing-documentation.xml | 8 | ||||
-rw-r--r-- | nixos/doc/manual/installation/upgrading.xml | 2 |
5 files changed, 19 insertions, 18 deletions
diff --git a/nixos/doc/manual/configuration/linux-kernel.xml b/nixos/doc/manual/configuration/linux-kernel.xml index f4d697c42dbd0..2f766f2b32f77 100644 --- a/nixos/doc/manual/configuration/linux-kernel.xml +++ b/nixos/doc/manual/configuration/linux-kernel.xml @@ -66,14 +66,15 @@ nixpkgs.config.packageOverrides = pkgs: sets the kernel’s TCP keepalive time to 120 seconds. To see the available parameters, run <command>sysctl -a</command>. </para> - <section> + <section xml:id="sec-linux-config-customizing"> <title>Customize your kernel</title> <para> The first step before compiling the kernel is to generate an appropriate - <literal>.config</literal> configuration. Either you pass your own config via - the <literal>configfile</literal> setting of <literal>linuxManualConfig</literal>: - <screen><![CDATA[ + <literal>.config</literal> configuration. Either you pass your own config + via the <literal>configfile</literal> setting of + <literal>linuxManualConfig</literal>: +<screen><![CDATA[ custom-kernel = super.linuxManualConfig { inherit (super) stdenv hostPlatform; inherit (linux_4_9) src; @@ -117,7 +118,7 @@ You can edit the config with this snippet (by default <command>make menuconfig</ ]]></screen> </para> </section> - <section> + <section xml:id="sec-linux-config-developing-modules"> <title>Developing kernel modules</title> <para> diff --git a/nixos/doc/manual/development/assertions.xml b/nixos/doc/manual/development/assertions.xml index 17c38ffcc717b..32f90cf2e7c47 100644 --- a/nixos/doc/manual/development/assertions.xml +++ b/nixos/doc/manual/development/assertions.xml @@ -20,7 +20,7 @@ NixOS module system. </para> - <section> + <section xml:id="sec-assertions-warnings"> <title>Warnings</title> <para> @@ -44,7 +44,7 @@ </programlisting> </section> - <section> + <section xml:id="sec-assertions-assertions"> <title>Assertions</title> <para> diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index 47dd09158e91e..e6c9eae11a728 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -11,7 +11,7 @@ value definitions. </para> - <section> + <section xml:id="sec-option-types-basic"> <title>Basic Types</title> <para> @@ -196,7 +196,7 @@ </variablelist> </section> - <section> + <section xml:id="sec-option-types-value"> <title>Value Types</title> <para> @@ -257,7 +257,7 @@ </variablelist> </section> - <section> + <section xml:id="sec-option-types-composed"> <title>Composed Types</title> <para> @@ -483,7 +483,7 @@ config.mod.two = { foo = 2; bar = "two"; };</screen> </example> </section> - <section> + <section xml:id="sec-option-types-extending"> <title>Extending types</title> <para> @@ -543,14 +543,14 @@ nixThings = mkOption { </variablelist> </section> - <section> + <section xml:id="sec-option-types-custom"> <title>Custom Types</title> <para> Custom types can be created with the <literal>mkOptionType</literal> function. As type creation includes some more complex topics such as submodule handling, it is recommended to get familiar with - <filename + <filename xlink:href="https://github.com/NixOS/nixpkgs/blob/master/lib/types.nix">types.nix</filename> code before creating a new type. </para> diff --git a/nixos/doc/manual/development/writing-documentation.xml b/nixos/doc/manual/development/writing-documentation.xml index 8ecdd1c770f2d..2183937ad0daa 100644 --- a/nixos/doc/manual/development/writing-documentation.xml +++ b/nixos/doc/manual/development/writing-documentation.xml @@ -10,7 +10,7 @@ sources and presenting it in an accessible style would be a worthy contribution to the project. </para> - <section> + <section xml:id="sec-writing-docs-building-the-manual"> <title>Building the Manual</title> <para> @@ -42,7 +42,7 @@ <filename>./result/share/doc/nixos/index.html</filename>. </para> </section> - <section> + <section xml:id="sec-writing-docs-editing-docbook-xml"> <title>Editing DocBook XML</title> <para> @@ -76,7 +76,7 @@ Issue</link> and someone will handle the conversion to XML for you. </para> </section> - <section> + <section xml:id="sec-writing-docs-creating-a-topic"> <title>Creating a Topic</title> <para> @@ -128,7 +128,7 @@ </itemizedlist> </para> </section> - <section> + <section xml:id="sec-writing-docs-adding-a-topic"> <title>Adding a Topic to the Book</title> <para> diff --git a/nixos/doc/manual/installation/upgrading.xml b/nixos/doc/manual/installation/upgrading.xml index 20355812ec635..85e5082575d3f 100644 --- a/nixos/doc/manual/installation/upgrading.xml +++ b/nixos/doc/manual/installation/upgrading.xml @@ -109,7 +109,7 @@ nixos https://nixos.org/channels/nixos-unstable so in that case you will not be able to go back to your original channel. </para> </warning> - <section> + <section xml:id="sec-upgrading-automatic"> <title>Automatic Upgrades</title> <para> |