From 18fd616351a25622b1dc43c59d0c52ace5bfe3ef Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Sat, 1 Sep 2018 15:49:04 -0400 Subject: nixos docs: Give sections IDs --- nixos/doc/manual/configuration/linux-kernel.xml | 11 ++++++----- nixos/doc/manual/development/assertions.xml | 4 ++-- nixos/doc/manual/development/option-types.xml | 12 ++++++------ nixos/doc/manual/development/writing-documentation.xml | 8 ++++---- 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 sysctl -a. -
+
Customize your kernel The first step before compiling the kernel is to generate an appropriate - .config configuration. Either you pass your own config via - the configfile setting of linuxManualConfig: - .config configuration. Either you pass your own config + via the configfile setting of + linuxManualConfig: +make menuconfig
-
+
Developing kernel modules 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. -
+
Warnings @@ -44,7 +44,7 @@
-
+
Assertions 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. -
+
Basic Types @@ -196,7 +196,7 @@
-
+
Value Types @@ -257,7 +257,7 @@
-
+
Composed Types @@ -483,7 +483,7 @@ config.mod.two = { foo = 2; bar = "two"; };
-
+
Extending types @@ -543,14 +543,14 @@ nixThings = mkOption {
-
+
Custom Types Custom types can be created with the mkOptionType function. As type creation includes some more complex topics such as submodule handling, it is recommended to get familiar with - types.nix code before creating a new type. 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. -
+
Building the Manual @@ -42,7 +42,7 @@ ./result/share/doc/nixos/index.html.
-
+
Editing DocBook XML @@ -76,7 +76,7 @@ Issue and someone will handle the conversion to XML for you.
-
+
Creating a Topic @@ -128,7 +128,7 @@
-
+
Adding a Topic to the Book 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. -
+
Automatic Upgrades -- cgit 1.4.1 From 34d2ec7c09ec01f1205d1a949a33bd6fdf1417fc Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Sat, 1 Sep 2018 16:15:29 -0400 Subject: nixos docs: give IDs to things --- nixos/doc/manual/manual.xml | 2 +- nixos/doc/manual/options-to-docbook.xsl | 2 +- nixos/modules/i18n/input-method/default.xml | 8 ++++---- nixos/modules/programs/zsh/oh-my-zsh.xml | 8 ++++---- nixos/modules/security/acme.xml | 6 +++--- nixos/modules/services/databases/foundationdb.xml | 18 ++++++++-------- nixos/modules/services/databases/postgresql.xml | 6 +++--- nixos/modules/services/editors/emacs.xml | 24 +++++++++++----------- nixos/modules/services/misc/gitlab.xml | 6 +++--- nixos/modules/services/misc/taskserver/doc.xml | 8 ++++---- .../services/monitoring/prometheus/exporters.xml | 4 ++-- .../modules/services/networking/dnscrypt-proxy.xml | 8 ++++---- nixos/modules/services/web-apps/matomo-doc.xml | 8 ++++---- 13 files changed, 54 insertions(+), 54 deletions(-) diff --git a/nixos/doc/manual/manual.xml b/nixos/doc/manual/manual.xml index e9338efbc025d..a5efde32885cf 100644 --- a/nixos/doc/manual/manual.xml +++ b/nixos/doc/manual/manual.xml @@ -8,7 +8,7 @@ Version - + Preface This manual describes how to install, use and extend NixOS, a Linux diff --git a/nixos/doc/manual/options-to-docbook.xsl b/nixos/doc/manual/options-to-docbook.xsl index 43a69806a2b0f..2038b0dff63ee 100644 --- a/nixos/doc/manual/options-to-docbook.xsl +++ b/nixos/doc/manual/options-to-docbook.xsl @@ -15,7 +15,7 @@ - + Configuration Options diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml index eb75b7415c9c4..524fbbb19e91d 100644 --- a/nixos/modules/i18n/input-method/default.xml +++ b/nixos/modules/i18n/input-method/default.xml @@ -23,7 +23,7 @@ bridge. -
IBus +
IBus IBus is an Intelligent Input Bus. It provides full featured and user friendly input method user interface. @@ -82,7 +82,7 @@ ibus.engines = with pkgs.ibus-engines; [ table table-others ];
-
Fcitx +
Fcitx Fcitx is an input method framework with extension support. It has three built-in Input Method Engine, Pinyin, QuWei and Table-based input @@ -122,7 +122,7 @@ i18n.inputMethod = {
-
Nabi +
Nabi Nabi is an easy to use Korean X input method. It allows you to enter phonetic Korean characters (hangul) and pictographic Korean characters @@ -136,7 +136,7 @@ i18n.inputMethod = {
-
Uim +
Uim Uim (short for "universal input method") is a multilingual input method framework. Applications can use it through so-called bridges. diff --git a/nixos/modules/programs/zsh/oh-my-zsh.xml b/nixos/modules/programs/zsh/oh-my-zsh.xml index b74da8630ee77..6567d4a42facd 100644 --- a/nixos/modules/programs/zsh/oh-my-zsh.xml +++ b/nixos/modules/programs/zsh/oh-my-zsh.xml @@ -10,7 +10,7 @@ to manage your ZSH configuration including completion scripts for several CLI tools or custom prompt themes. -
Basic usage +
Basic usage The module uses the oh-my-zsh package with all available features. The initial setup using Nix expressions is fairly similar to the configuration format of oh-my-zsh. @@ -32,7 +32,7 @@ For a detailed explanation of these arguments please refer to the configuration and writes it into your /etc/zshrc.
-
Custom additions +
Custom additions Sometimes third-party or custom scripts such as a modified theme may be needed. oh-my-zsh provides the @@ -48,7 +48,7 @@ environment variable for this which points to a directory with additional script
-
Custom environments +
Custom environments There are several extensions for oh-my-zsh packaged in nixpkgs. One of them is nix-zsh-completions @@ -77,7 +77,7 @@ as it requires an immutable store path while custom shall rem will be thrown if both custom and customPkgs are set.
-
Package your own customizations +
Package your own customizations If third-party customizations (e.g. new themes) are supposed to be added to oh-my-zsh there are several pitfalls to keep in mind: diff --git a/nixos/modules/security/acme.xml b/nixos/modules/security/acme.xml index 7cdc554989ea4..b4cd83f6632c7 100644 --- a/nixos/modules/security/acme.xml +++ b/nixos/modules/security/acme.xml @@ -11,7 +11,7 @@ retrieval and renewal using the ACME protocol. This is currently only implemented by and for Let's Encrypt. The alternative ACME client simp_le is used under the hood. -
Prerequisites +
Prerequisites You need to have a running HTTP server for verification. The server must have a webroot defined that can serve @@ -41,7 +41,7 @@ http {
-
Configuring +
Configuring To enable ACME certificate retrieval & renewal for a certificate for foo.example.com, add the following in your @@ -66,7 +66,7 @@ options for the security.acme mod
-
Using ACME certificates in Nginx +
Using ACME certificates in Nginx NixOS supports fetching ACME certificates for you by setting enableACME = true; in a virtualHost config. We first create self-signed placeholder certificates in place of the diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index f4090c4927641..7883680d46cc3 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -17,7 +17,7 @@ FoundationDB (or "FDB") is an open source, distributed, transactional key-value store. -
Configuring and basic setup +
Configuring and basic setup To enable FoundationDB, add the following to your configuration.nix: @@ -133,7 +133,7 @@ corresponding as well.
-
Scaling processes and backup agents +
Scaling processes and backup agents Scaling the number of server processes is quite easy; simply specify to be the number of @@ -151,7 +151,7 @@ available backup processes.
-
Clustering +
Clustering FoundationDB on NixOS works similarly to other Linux systems, so this section will be brief. Please refer to the full FoundationDB documentation for @@ -221,7 +221,7 @@ informing all client processes to do the same.
-
Client connectivity +
Client connectivity By default, all clients must use the current fdb.cluster file to access a given FoundationDB cluster. @@ -232,7 +232,7 @@ to a new node in order to connect, if it is not part of the cluster.
-
Client authorization and TLS +
Client authorization and TLS By default, any user who can connect to a FoundationDB process with the correct cluster configuration can access anything. FoundationDB uses a @@ -270,7 +270,7 @@ on.
-
Backups and Disaster Recovery +
Backups and Disaster Recovery The usual rules for doing FoundationDB backups apply on NixOS as written in the FoundationDB manual. However, one important difference is the security @@ -316,7 +316,7 @@ $ sudo -u foundationdb fdbbackup status -t default
-
Known limitations +
Known limitations The FoundationDB setup for NixOS should currently be considered beta. FoundationDB is not new software, but the NixOS compilation and integration has @@ -333,7 +333,7 @@ only undergone fairly basic testing of all the available functionality.
-
Options +
Options NixOS's FoundationDB module allows you to configure all of the most relevant configuration options for fdbmonitor, matching it @@ -343,7 +343,7 @@ also read the FoundationDB documentation as well.
-
Full documentation +
Full documentation FoundationDB is a complex piece of software, and requires careful administration to properly use. Full documentation for administration can be diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index 98a631c0cd32a..1aaf339632454 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -17,7 +17,7 @@ PostgreSQL is an advanced, free relational database. -
Configuring +
Configuring To enable PostgreSQL, add the following to your configuration.nix: @@ -60,14 +60,14 @@ alice=>
-
Upgrading +
Upgrading FIXME: document dump/upgrade/load cycle.
-
Options +
Options A complete list of options for the PostgreSQL module may be found here. diff --git a/nixos/modules/services/editors/emacs.xml b/nixos/modules/services/editors/emacs.xml index dfab5ce4a79d3..631570d6dec2b 100644 --- a/nixos/modules/services/editors/emacs.xml +++ b/nixos/modules/services/editors/emacs.xml @@ -39,7 +39,7 @@ starting the Emacs daemon. -
+
Installing <application>Emacs</application> @@ -49,7 +49,7 @@ can be enabled. -
+
The Different Releases of Emacs @@ -100,7 +100,7 @@
-
+
Adding Packages to Emacs Emacs includes an entire ecosystem of functionality beyond @@ -339,7 +339,7 @@ https://nixos.org/nixpkgs/manual/#sec-modify-via-packageOverrides
-
+
Advanced Emacs Configuration @@ -380,7 +380,7 @@ in [...]
-
+
Running Emacs as a Service NixOS provides an optional @@ -396,7 +396,7 @@ in [...] modules/services/editors/emacs.nix -
+
Enabling the Service @@ -438,7 +438,7 @@ $ systemctl --user start emacs.service # to start the Emacs daemon
-
+
Starting the client Ensure that the emacs server is enabled, either by customizing @@ -457,7 +457,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
-
+
Configuring the <varname>EDITOR</varname> variable @@ -487,7 +487,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
-
+
Per-User Enabling of the Service @@ -515,7 +515,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
-
+
Configuring Emacs @@ -548,7 +548,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal server-switch-hook, server-done-hook? --> -
+
A Major Mode for Nix Expressions @@ -558,7 +558,7 @@ emacsclient --create-frame --tty # opens a new frame on the current terminal
-
+
Accessing man pages You can use woman to get completion of all diff --git a/nixos/modules/services/misc/gitlab.xml b/nixos/modules/services/misc/gitlab.xml index 3306ba8e9b11e..67b9f1d3e474e 100644 --- a/nixos/modules/services/misc/gitlab.xml +++ b/nixos/modules/services/misc/gitlab.xml @@ -8,7 +8,7 @@ Gitlab is a feature-rich git hosting service. -
Prerequisites +
Prerequisites The gitlab service exposes only an Unix socket at /run/gitlab/gitlab-workhorse.socket. You need to configure a @@ -35,7 +35,7 @@ webserver to proxy HTTP requests to the socket.
-
Configuring +
Configuring Gitlab depends on both PostgreSQL and Redis and will automatically enable both services. In the case of PostgreSQL, a database and a role will be created. @@ -119,7 +119,7 @@ options for the services.gitlab -
Maintenance +
Maintenance You can run Gitlab's rake tasks with gitlab-rake which will be available on the system when gitlab is enabled. You will diff --git a/nixos/modules/services/misc/taskserver/doc.xml b/nixos/modules/services/misc/taskserver/doc.xml index 75493ac1394f6..21d25ecf391f1 100644 --- a/nixos/modules/services/misc/taskserver/doc.xml +++ b/nixos/modules/services/misc/taskserver/doc.xml @@ -16,7 +16,7 @@ -
+
Configuration @@ -48,7 +48,7 @@
-
+
The nixos-taskserver tool @@ -78,7 +78,7 @@ switch.
-
+
Declarative/automatic CA management @@ -131,7 +131,7 @@ $ ssh server nixos-taskserver user export my-company alice | sh task sync after that stage.
-
+
Manual CA management diff --git a/nixos/modules/services/monitoring/prometheus/exporters.xml b/nixos/modules/services/monitoring/prometheus/exporters.xml index 4f0bcb2981067..be86abb74b44c 100644 --- a/nixos/modules/services/monitoring/prometheus/exporters.xml +++ b/nixos/modules/services/monitoring/prometheus/exporters.xml @@ -8,7 +8,7 @@ Prometheus exporters provide metrics for the prometheus monitoring system. -
Configuration +
Configuration One of the most common exporters is the node exporter, it provides hardware and OS metrics from the host it's running on. The exporter could be configured as follows: services.promtheus.exporters.node = { @@ -33,7 +33,7 @@ For more information about configuration see man configuration.nixavailable options.
-
Adding a new exporter +
Adding a new exporter To add a new exporter, it has to be packaged first (see nixpkgs/pkgs/servers/monitoring/prometheus/ for examples), then a module can be added. The postfix exporter is used in this example: diff --git a/nixos/modules/services/networking/dnscrypt-proxy.xml b/nixos/modules/services/networking/dnscrypt-proxy.xml index ff10886985891..a97579202523e 100644 --- a/nixos/modules/services/networking/dnscrypt-proxy.xml +++ b/nixos/modules/services/networking/dnscrypt-proxy.xml @@ -14,7 +14,7 @@ upstream is trustworthy). - Basic configuration + Basic configuration To enable the client proxy, set @@ -31,7 +31,7 @@ - As a forwarder for another DNS client + As a forwarder for another DNS client To run the DNSCrypt proxy client as a forwarder for another @@ -42,7 +42,7 @@ - dnsmasq + dnsmasq { @@ -53,7 +53,7 @@ - unbound + unbound { diff --git a/nixos/modules/services/web-apps/matomo-doc.xml b/nixos/modules/services/web-apps/matomo-doc.xml index 456aae6cc3662..6f878015c5148 100644 --- a/nixos/modules/services/web-apps/matomo-doc.xml +++ b/nixos/modules/services/web-apps/matomo-doc.xml @@ -15,7 +15,7 @@ -
+
Database Setup @@ -51,7 +51,7 @@
-
+
Backup You only need to take backups of your MySQL database and the @@ -62,7 +62,7 @@
-
+
Issues @@ -83,7 +83,7 @@
-
+
Using other Web Servers than nginx -- cgit 1.4.1 From 73bff467d2c95f33a99adf58588c66624d34fa12 Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Sat, 1 Sep 2018 16:18:18 -0400 Subject: makefile: auto-format xml docs outside of the doc subdir --- nixos/doc/manual/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nixos/doc/manual/Makefile b/nixos/doc/manual/Makefile index 5cbbf140869a6..2e9adf70c3963 100644 --- a/nixos/doc/manual/Makefile +++ b/nixos/doc/manual/Makefile @@ -11,7 +11,7 @@ manual-combined.xml: generated *.xml .PHONY: format format: - find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ + find ../../ -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ xmlformat --config-file "../xmlformat.conf" -i {} .PHONY: fix-misc-xml -- cgit 1.4.1 From 53c77e64fec665bbd2a807c5b3500912b7dad1f7 Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Sat, 1 Sep 2018 16:24:37 -0400 Subject: nixos docs: footnotes: give IDs --- nixos/doc/manual/configuration/modularity.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nixos/doc/manual/configuration/modularity.xml b/nixos/doc/manual/configuration/modularity.xml index 3ff96f719ec57..298ffd661f678 100644 --- a/nixos/doc/manual/configuration/modularity.xml +++ b/nixos/doc/manual/configuration/modularity.xml @@ -74,7 +74,7 @@ The unique option `services.httpd.adminAddr' is defined multiple times, in `/etc argument is for: it contains the complete, merged system configuration. That is, config is the result of combining the configurations returned by every module - + If you’re wondering how it’s possible that the (indirect) result of a function is passed as an -- cgit 1.4.1