diff options
| author | xeji <36407913+xeji@users.noreply.github.com> | 2018-06-05 23:50:44 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-06-05 23:50:44 +0200 |
| commit | c958516cb3e8b68433097c15f49eedcac781b93d (patch) | |
| tree | 4933f21b4e68e3364cf4c008c27d2fe6d2c100b2 /nixos | |
| parent | 44f3a1dd41bc6ec78d827bb2aa5997a4cb67be70 (diff) | |
| parent | 6bf54191fb3a7328fa701e408419f29d7bc7ba79 (diff) | |
| download | nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.tar nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.tar.gz nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.tar.bz2 nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.tar.lz nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.tar.xz nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.tar.zst nixpkgs-c958516cb3e8b68433097c15f49eedcac781b93d.zip | |
Merge pull request #41342 from samueldr/fix/doc/formatting-oopsies
Fixes doc auto-formatting oopsies
Diffstat (limited to 'nixos')
20 files changed, 687 insertions, 272 deletions
diff --git a/nixos/doc/manual/Makefile b/nixos/doc/manual/Makefile index 2e2322d5fb5..5cbbf140869 100644 --- a/nixos/doc/manual/Makefile +++ b/nixos/doc/manual/Makefile @@ -14,6 +14,11 @@ format: find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \ xmlformat --config-file "../xmlformat.conf" -i {} +.PHONY: fix-misc-xml +fix-misc-xml: + find . -iname '*.xml' -type f \ + -exec ../varlistentry-fixer.rb {} ';' + .PHONY: clean clean: rm -f manual-combined.xml generated diff --git a/nixos/doc/manual/administration/boot-problems.xml b/nixos/doc/manual/administration/boot-problems.xml index 5f05ad261ef..de3d8ac21ae 100644 --- a/nixos/doc/manual/administration/boot-problems.xml +++ b/nixos/doc/manual/administration/boot-problems.xml @@ -14,7 +14,8 @@ NixOS boot scripts or by systemd: <variablelist> <varlistentry> - <term><literal>boot.shell_on_fail</literal> + <term> + <literal>boot.shell_on_fail</literal> </term> <listitem> <para> @@ -25,7 +26,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>boot.debug1</literal> + <term> + <literal>boot.debug1</literal> </term> <listitem> <para> @@ -37,7 +39,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>boot.trace</literal> + <term> + <literal>boot.trace</literal> </term> <listitem> <para> @@ -46,7 +49,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>single</literal> + <term> + <literal>single</literal> </term> <listitem> <para> @@ -59,7 +63,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>systemd.log_level=debug systemd.log_target=console</literal> + <term> + <literal>systemd.log_level=debug systemd.log_target=console</literal> </term> <listitem> <para> diff --git a/nixos/doc/manual/configuration/config-file.xml b/nixos/doc/manual/configuration/config-file.xml index a9420b3fc92..8a1a39c98c1 100644 --- a/nixos/doc/manual/configuration/config-file.xml +++ b/nixos/doc/manual/configuration/config-file.xml @@ -80,7 +80,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no Options have various types of values. The most important are: <variablelist> <varlistentry> - <term>Strings</term> + <term> + Strings + </term> <listitem> <para> Strings are enclosed in double quotes, e.g. @@ -112,7 +114,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no </listitem> </varlistentry> <varlistentry> - <term>Booleans</term> + <term> + Booleans + </term> <listitem> <para> These can be <literal>true</literal> or <literal>false</literal>, e.g. @@ -124,7 +128,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no </listitem> </varlistentry> <varlistentry> - <term>Integers</term> + <term> + Integers + </term> <listitem> <para> For example, @@ -141,7 +147,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no </listitem> </varlistentry> <varlistentry> - <term>Sets</term> + <term> + Sets + </term> <listitem> <para> Sets were introduced above. They are name/value pairs enclosed in braces, @@ -157,7 +165,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no </listitem> </varlistentry> <varlistentry> - <term>Lists</term> + <term> + Lists + </term> <listitem> <para> The important thing to note about lists is that list elements are @@ -173,7 +183,9 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; </listitem> </varlistentry> <varlistentry> - <term>Packages</term> + <term> + Packages + </term> <listitem> <para> Usually, the packages you need are already part of the Nix Packages diff --git a/nixos/doc/manual/development/building-parts.xml b/nixos/doc/manual/development/building-parts.xml index 031048aaa37..eaffc0ef47c 100644 --- a/nixos/doc/manual/development/building-parts.xml +++ b/nixos/doc/manual/development/building-parts.xml @@ -15,7 +15,8 @@ $ nix-build -A config.<replaceable>option</replaceable></screen> include: <variablelist> <varlistentry> - <term><varname>system.build.toplevel</varname> + <term> + <varname>system.build.toplevel</varname> </term> <listitem> <para> @@ -32,7 +33,8 @@ $ nix-build -A system</screen> </listitem> </varlistentry> <varlistentry> - <term><varname>system.build.manual.manual</varname> + <term> + <varname>system.build.manual.manual</varname> </term> <listitem> <para> @@ -41,7 +43,8 @@ $ nix-build -A system</screen> </listitem> </varlistentry> <varlistentry> - <term><varname>system.build.etc</varname> + <term> + <varname>system.build.etc</varname> </term> <listitem> <para> @@ -51,9 +54,11 @@ $ nix-build -A system</screen> </listitem> </varlistentry> <varlistentry> - <term><varname>system.build.initialRamdisk</varname> + <term> + <varname>system.build.initialRamdisk</varname> </term> - <term><varname>system.build.kernel</varname> + <term> + <varname>system.build.kernel</varname> </term> <listitem> <para> @@ -69,11 +74,14 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/ </listitem> </varlistentry> <varlistentry> - <term><varname>system.build.nixos-rebuild</varname> + <term> + <varname>system.build.nixos-rebuild</varname> </term> - <term><varname>system.build.nixos-install</varname> + <term> + <varname>system.build.nixos-install</varname> </term> - <term><varname>system.build.nixos-generate-config</varname> + <term> + <varname>system.build.nixos-generate-config</varname> </term> <listitem> <para> @@ -82,7 +90,8 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/ </listitem> </varlistentry> <varlistentry> - <term><varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname> + <term> + <varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname> </term> <listitem> <para> diff --git a/nixos/doc/manual/development/option-declarations.xml b/nixos/doc/manual/development/option-declarations.xml index a8f528a0a80..eee81bf6426 100644 --- a/nixos/doc/manual/development/option-declarations.xml +++ b/nixos/doc/manual/development/option-declarations.xml @@ -32,7 +32,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> The function <varname>mkOption</varname> accepts the following arguments. <variablelist> <varlistentry> - <term><varname>type</varname> + <term> + <varname>type</varname> </term> <listitem> <para> @@ -43,7 +44,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> </listitem> </varlistentry> <varlistentry> - <term><varname>default</varname> + <term> + <varname>default</varname> </term> <listitem> <para> @@ -55,7 +57,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> </listitem> </varlistentry> <varlistentry> - <term><varname>example</varname> + <term> + <varname>example</varname> </term> <listitem> <para> @@ -64,7 +67,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> </listitem> </varlistentry> <varlistentry> - <term><varname>description</varname> + <term> + <varname>description</varname> </term> <listitem> <para> diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index 5cb747e6d9f..47dd09158e9 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -22,7 +22,8 @@ <variablelist> <varlistentry> - <term><varname>types.attrs</varname> + <term> + <varname>types.attrs</varname> </term> <listitem> <para> @@ -31,7 +32,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.bool</varname> + <term> + <varname>types.bool</varname> </term> <listitem> <para> @@ -41,7 +43,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.path</varname> + <term> + <varname>types.path</varname> </term> <listitem> <para> @@ -52,7 +55,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.package</varname> + <term> + <varname>types.package</varname> </term> <listitem> <para> @@ -68,7 +72,8 @@ <variablelist> <varlistentry> - <term><varname>types.int</varname> + <term> + <varname>types.int</varname> </term> <listitem> <para> @@ -77,7 +82,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.ints.{s8, s16, s32}</varname> + <term> + <varname>types.ints.{s8, s16, s32}</varname> </term> <listitem> <para> @@ -91,7 +97,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.ints.unsigned</varname> + <term> + <varname>types.ints.unsigned</varname> </term> <listitem> <para> @@ -100,7 +107,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.ints.{u8, u16, u32}</varname> + <term> + <varname>types.ints.{u8, u16, u32}</varname> </term> <listitem> <para> @@ -114,7 +122,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.ints.positive</varname> + <term> + <varname>types.ints.positive</varname> </term> <listitem> <para> @@ -130,7 +139,8 @@ <variablelist> <varlistentry> - <term><varname>types.str</varname> + <term> + <varname>types.str</varname> </term> <listitem> <para> @@ -139,7 +149,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.lines</varname> + <term> + <varname>types.lines</varname> </term> <listitem> <para> @@ -149,7 +160,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.commas</varname> + <term> + <varname>types.commas</varname> </term> <listitem> <para> @@ -159,7 +171,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.envVar</varname> + <term> + <varname>types.envVar</varname> </term> <listitem> <para> @@ -169,7 +182,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.strMatching</varname> + <term> + <varname>types.strMatching</varname> </term> <listitem> <para> @@ -191,7 +205,8 @@ <variablelist> <varlistentry> - <term><varname>types.enum</varname><replaceable>l</replaceable> + <term> + <varname>types.enum</varname> <replaceable>l</replaceable> </term> <listitem> <para> @@ -202,7 +217,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.separatedString</varname><replaceable>sep</replaceable> + <term> + <varname>types.separatedString</varname> <replaceable>sep</replaceable> </term> <listitem> <para> @@ -212,7 +228,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.ints.between</varname><replaceable>lowest</replaceable><replaceable>highest</replaceable> + <term> + <varname>types.ints.between</varname> <replaceable>lowest</replaceable> <replaceable>highest</replaceable> </term> <listitem> <para> @@ -223,7 +240,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.submodule</varname><replaceable>o</replaceable> + <term> + <varname>types.submodule</varname> <replaceable>o</replaceable> </term> <listitem> <para> @@ -250,7 +268,8 @@ <variablelist> <varlistentry> - <term><varname>types.listOf</varname><replaceable>t</replaceable> + <term> + <varname>types.listOf</varname> <replaceable>t</replaceable> </term> <listitem> <para> @@ -260,7 +279,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.attrsOf</varname><replaceable>t</replaceable> + <term> + <varname>types.attrsOf</varname> <replaceable>t</replaceable> </term> <listitem> <para> @@ -271,7 +291,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.loaOf</varname><replaceable>t</replaceable> + <term> + <varname>types.loaOf</varname> <replaceable>t</replaceable> </term> <listitem> <para> @@ -281,7 +302,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.nullOr</varname><replaceable>t</replaceable> + <term> + <varname>types.nullOr</varname> <replaceable>t</replaceable> </term> <listitem> <para> @@ -291,7 +313,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.uniq</varname><replaceable>t</replaceable> + <term> + <varname>types.uniq</varname> <replaceable>t</replaceable> </term> <listitem> <para> @@ -301,7 +324,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.either</varname><replaceable>t1</replaceable><replaceable>t2</replaceable> + <term> + <varname>types.either</varname> <replaceable>t1</replaceable> <replaceable>t2</replaceable> </term> <listitem> <para> @@ -312,7 +336,8 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>types.coercedTo</varname><replaceable>from</replaceable><replaceable>f</replaceable><replaceable>to</replaceable> + <term> + <varname>types.coercedTo</varname> <replaceable>from</replaceable> <replaceable>f</replaceable> <replaceable>to</replaceable> </term> <listitem> <para> @@ -468,7 +493,8 @@ config.mod.two = { foo = 2; bar = "two"; };</screen> <variablelist> <varlistentry> - <term><varname>check</varname> + <term> + <varname>check</varname> </term> <listitem> <para> @@ -501,7 +527,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>merge</varname> + <term> + <varname>merge</varname> </term> <listitem> <para> @@ -534,7 +561,8 @@ nixThings = mkOption { <variablelist> <varlistentry> - <term><varname>name</varname> + <term> + <varname>name</varname> </term> <listitem> <para> @@ -543,7 +571,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>definition</varname> + <term> + <varname>definition</varname> </term> <listitem> <para> @@ -553,7 +582,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>check</varname> + <term> + <varname>check</varname> </term> <listitem> <para> @@ -565,7 +595,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>merge</varname> + <term> + <varname>merge</varname> </term> <listitem> <para> @@ -573,7 +604,8 @@ nixThings = mkOption { </para> <variablelist> <varlistentry> - <term><replaceable>loc</replaceable> + <term> + <replaceable>loc</replaceable> </term> <listitem> <para> @@ -583,7 +615,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><replaceable>defs</replaceable> + <term> + <replaceable>defs</replaceable> </term> <listitem> <para> @@ -600,7 +633,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>getSubOptions</varname> + <term> + <varname>getSubOptions</varname> </term> <listitem> <para> @@ -615,7 +649,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>getSubModules</varname> + <term> + <varname>getSubModules</varname> </term> <listitem> <para> @@ -628,7 +663,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>substSubModules</varname> + <term> + <varname>substSubModules</varname> </term> <listitem> <para> @@ -644,7 +680,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>typeMerge</varname> + <term> + <varname>typeMerge</varname> </term> <listitem> <para> @@ -654,7 +691,8 @@ nixThings = mkOption { </para> <variablelist> <varlistentry> - <term><replaceable>f</replaceable> + <term> + <replaceable>f</replaceable> </term> <listitem> <para> @@ -670,7 +708,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>functor</varname> + <term> + <varname>functor</varname> </term> <listitem> <para> @@ -679,7 +718,8 @@ nixThings = mkOption { </para> <variablelist> <varlistentry> - <term><varname>type</varname> + <term> + <varname>type</varname> </term> <listitem> <para> @@ -688,7 +728,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>wrapped</varname> + <term> + <varname>wrapped</varname> </term> <listitem> <para> @@ -697,7 +738,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>payload</varname> + <term> + <varname>payload</varname> </term> <listitem> <para> @@ -709,7 +751,8 @@ nixThings = mkOption { </listitem> </varlistentry> <varlistentry> - <term><varname>binOp</varname> + <term> + <varname>binOp</varname> </term> <listitem> <para> diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml index 89a6a442362..5935fbc049b 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.xml +++ b/nixos/doc/manual/development/writing-nixos-tests.xml @@ -54,7 +54,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf <!-- FIXME: would be nice to generate this automatically. --> <variablelist> <varlistentry> - <term><option>virtualisation.memorySize</option> + <term> + <option>virtualisation.memorySize</option> </term> <listitem> <para> @@ -63,7 +64,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf </listitem> </varlistentry> <varlistentry> - <term><option>virtualisation.vlans</option> + <term> + <option>virtualisation.vlans</option> </term> <listitem> <para> @@ -75,7 +77,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf </listitem> </varlistentry> <varlistentry> - <term><option>virtualisation.writableStore</option> + <term> + <option>virtualisation.writableStore</option> </term> <listitem> <para> @@ -120,7 +123,8 @@ startAll; The following methods are available on machine objects: <variablelist> <varlistentry> - <term><methodname>start</methodname> + <term> + <methodname>start</methodname> </term> <listitem> <para> @@ -130,7 +134,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>shutdown</methodname> + <term> + <methodname>shutdown</methodname> </term> <listitem> <para> @@ -139,7 +144,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>crash</methodname> + <term> + <methodname>crash</methodname> </term> <listitem> <para> @@ -148,7 +154,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>block</methodname> + <term> + <methodname>block</methodname> </term> <listitem> <para> @@ -158,7 +165,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>unblock</methodname> + <term> + <methodname>unblock</methodname> </term> <listitem> <para> @@ -167,7 +175,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>screenshot</methodname> + <term> + <methodname>screenshot</methodname> </term> <listitem> <para> @@ -177,7 +186,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>getScreenText</methodname> + <term> + <methodname>getScreenText</methodname> </term> <listitem> <para> @@ -193,7 +203,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>sendMonitorCommand</methodname> + <term> + <methodname>sendMonitorCommand</methodname> </term> <listitem> <para> @@ -203,7 +214,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>sendKeys</methodname> + <term> + <methodname>sendKeys</methodname> </term> <listitem> <para> @@ -213,7 +225,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>sendChars</methodname> + <term> + <methodname>sendChars</methodname> </term> <listitem> <para> @@ -224,7 +237,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>execute</methodname> + <term> + <methodname>execute</methodname> </term> <listitem> <para> @@ -235,7 +249,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>succeed</methodname> + <term> + <methodname>succeed</methodname> </term> <listitem> <para> @@ -245,7 +260,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>fail</methodname> + <term> + <methodname>fail</methodname> </term> <listitem> <para> @@ -255,7 +271,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitUntilSucceeds</methodname> + <term> + <methodname>waitUntilSucceeds</methodname> </term> <listitem> <para> @@ -264,7 +281,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitUntilFails</methodname> + <term> + <methodname>waitUntilFails</methodname> </term> <listitem> <para> @@ -273,7 +291,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForUnit</methodname> + <term> + <methodname>waitForUnit</methodname> </term> <listitem> <para> @@ -282,7 +301,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForFile</methodname> + <term> + <methodname>waitForFile</methodname> </term> <listitem> <para> @@ -291,7 +311,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForOpenPort</methodname> + <term> + <methodname>waitForOpenPort</methodname> </term> <listitem> <para> @@ -301,7 +322,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForClosedPort</methodname> + <term> + <methodname>waitForClosedPort</methodname> </term> <listitem> <para> @@ -310,7 +332,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForX</methodname> + <term> + <methodname>waitForX</methodname> </term> <listitem> <para> @@ -319,7 +342,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForText</methodname> + <term> + <methodname>waitForText</methodname> </term> <listitem> <para> @@ -336,7 +360,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>waitForWindow</methodname> + <term> + <methodname>waitForWindow</methodname> </term> <listitem> <para> @@ -346,7 +371,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>copyFileFromHost</methodname> + <term> + <methodname>copyFileFromHost</methodname> </term> <listitem> <para> @@ -361,7 +387,8 @@ startAll; </listitem> </varlistentry> <varlistentry> - <term><methodname>systemctl</methodname> + <term> + <methodname>systemctl</methodname> </term> <listitem> <para> diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 4e1fde662d6..6066d025adb 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -16,7 +16,9 @@ </para> <variablelist> <varlistentry> - <term>UEFI systems</term> + <term> + UEFI systems + </term> <listitem> <para> You should boot the live CD in UEFI mode (consult your specific @@ -138,7 +140,9 @@ <listitem> <variablelist> <varlistentry> - <term>UEFI systems</term> + <term> + UEFI systems + </term> <listitem> <para> For creating boot partitions: <command>mkfs.fat</command>. Again @@ -178,7 +182,9 @@ <listitem> <variablelist> <varlistentry> - <term>UEFI systems</term> + <term> + UEFI systems + </term> <listitem> <para> Mount the boot file system on <filename>/mnt/boot</filename>, e.g. @@ -234,7 +240,9 @@ </para> <variablelist> <varlistentry> - <term>BIOS systems</term> + <term> + BIOS systems + </term> <listitem> <para> You <emphasis>must</emphasis> set the option @@ -244,7 +252,9 @@ </listitem> </varlistentry> <varlistentry> - <term>UEFI systems</term> + <term> + UEFI systems + </term> <listitem> <para> You <emphasis>must</emphasis> set the option diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml index 02dad4c548b..87e4f3dae86 100644 --- a/nixos/doc/manual/man-nixos-build-vms.xml +++ b/nixos/doc/manual/man-nixos-build-vms.xml @@ -12,14 +12,22 @@ </refname><refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-build-vms</command> - <arg><option>--show-trace</option> + <cmdsynopsis> + <command>nixos-build-vms</command> + <arg> + <option>--show-trace</option> </arg> - <arg><option>--no-out-link</option> + + <arg> + <option>--no-out-link</option> </arg> - <arg><option>--help</option> + + <arg> + <option>--help</option> </arg> - <arg choice="plain"><replaceable>network.nix</replaceable> + + <arg choice="plain"> + <replaceable>network.nix</replaceable> </arg> </cmdsynopsis> </refsynopsisdiv> @@ -78,7 +86,8 @@ </para> <variablelist> <varlistentry> - <term><option>--show-trace</option> + <term> + <option>--show-trace</option> </term> <listitem> <para> @@ -87,7 +96,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--no-out-link</option> + <term> + <option>--no-out-link</option> </term> <listitem> <para> @@ -96,7 +106,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>-h</option>, <option>--help</option> + <term> + <option>-h</option>, <option>--help</option> </term> <listitem> <para> diff --git a/nixos/doc/manual/man-nixos-enter.xml b/nixos/doc/manual/man-nixos-enter.xml index 7db4b72ee36..42edaa1ae5b 100644 --- a/nixos/doc/manual/man-nixos-enter.xml +++ b/nixos/doc/manual/man-nixos-enter.xml @@ -12,26 +12,40 @@ </refname><refpurpose>run a command in a NixOS chroot environment</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-enter</command> + <cmdsynopsis> + <command>nixos-enter</command> <arg> - <arg choice='plain'><option>--root</option> - </arg><replaceable>root</replaceable> + <arg choice='plain'> + <option>--root</option> + </arg> + <replaceable>root</replaceable> </arg> + <arg> - <arg choice='plain'><option>--system</option> - </arg><replaceable>system</replaceable> + <arg choice='plain'> + <option>--system</option> + </arg> + <replaceable>system</replaceable> </arg> + <arg> - <arg choice='plain'><option>-c</option> - </arg><replaceable>shell-command</replaceable> + <arg choice='plain'> + <option>-c</option> + </arg> + <replaceable>shell-command</replaceable> </arg> + <arg> - <arg choice='plain'><option>--help</option> + <arg choice='plain'> + <option>--help</option> </arg> </arg> + <arg> - <arg choice='plain'><option>--</option> - </arg><replaceable>arguments</replaceable> + <arg choice='plain'> + <option>--</option> + </arg> + <replaceable>arguments</replaceable> </arg> </cmdsynopsis> </refsynopsisdiv> @@ -50,7 +64,8 @@ </para> <variablelist> <varlistentry> - <term><option>--root</option> + <term> + <option>--root</option> </term> <listitem> <para> @@ -60,7 +75,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--system</option> + <term> + <option>--system</option> </term> <listitem> <para> @@ -72,9 +88,11 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--command</option> + <term> + <option>--command</option> </term> - <term><option>-c</option> + <term> + <option>-c</option> </term> <listitem> <para> @@ -83,7 +101,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--</option> + <term> + <option>--</option> </term> <listitem> <para> diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml index 8bf90f452db..1227873f578 100644 --- a/nixos/doc/manual/man-nixos-generate-config.xml +++ b/nixos/doc/manual/man-nixos-generate-config.xml @@ -12,16 +12,24 @@ </refname><refpurpose>generate NixOS configuration modules</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-generate-config</command> - <arg><option>--force</option> + <cmdsynopsis> + <command>nixos-generate-config</command> + <arg> + <option>--force</option> </arg> + <arg> - <arg choice='plain'><option>--root</option> - </arg><replaceable>root</replaceable> + <arg choice='plain'> + <option>--root</option> + </arg> + <replaceable>root</replaceable> </arg> + <arg> - <arg choice='plain'><option>--dir</option> - </arg><replaceable>dir</replaceable> + <arg choice='plain'> + <option>--dir</option> + </arg> + <replaceable>dir</replaceable> </arg> </cmdsynopsis> </refsynopsisdiv> @@ -31,7 +39,8 @@ This command writes two NixOS configuration modules: <variablelist> <varlistentry> - <term><option>/etc/nixos/hardware-configuration.nix</option> + <term> + <option>/etc/nixos/hardware-configuration.nix</option> </term> <listitem> <para> @@ -53,7 +62,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>/etc/nixos/configuration.nix</option> + <term> + <option>/etc/nixos/configuration.nix</option> </term> <listitem> <para> @@ -74,7 +84,8 @@ </para> <variablelist> <varlistentry> - <term><option>--root</option> + <term> + <option>--root</option> </term> <listitem> <para> @@ -88,7 +99,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--dir</option> + <term> + <option>--dir</option> </term> <listitem> <para> @@ -99,7 +111,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--force</option> + <term> + <option>--force</option> </term> <listitem> <para> @@ -109,7 +122,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--no-filesystems</option> + <term> + <option>--no-filesystems</option> </term> <listitem> <para> @@ -119,7 +133,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--show-hardware-config</option> + <term> + <option>--show-hardware-config</option> </term> <listitem> <para> diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index 2d45e83a863..25f4f40613a 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -12,47 +12,76 @@ </refname><refpurpose>install bootloader and NixOS</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-install</command> + <cmdsynopsis> + <command>nixos-install</command> <arg> - <arg choice='plain'><option>-I</option> - </arg><replaceable>path</replaceable> + <arg choice='plain'> + <option>-I</option> + </arg> + <replaceable>path</replaceable> </arg> + <arg> - <arg choice='plain'><option>--root</option> - </arg><replaceable>root</replaceable> + <arg choice='plain'> + <option>--root</option> + </arg> + <replaceable>root</replaceable> </arg> + <arg> - <arg choice='plain'><option>--system</option> - </arg><replaceable>path</replaceable> + <arg choice='plain'> + <option>--system</option> + </arg> + <replaceable>path</replaceable> </arg> + <arg> - <arg choice='plain'><option>--no-channel-copy</option> + <arg choice='plain'> + <option>--no-channel-copy</option> </arg> </arg> + <arg> - <arg choice='plain'><option>--no-root-passwd</option> + <arg choice='plain'> + <option>--no-root-passwd</option> </arg> </arg> + <arg> - <arg choice='plain'><option>--no-bootloader</option> + <arg choice='plain'> + <option>--no-bootloader</option> </arg> </arg> - <arg><group choice='req'> - <arg choice='plain'><option>--max-jobs</option> + + <arg> + <group choice='req'> + <arg choice='plain'> + <option>--max-jobs</option> </arg> - <arg choice='plain'><option>-j</option> - </arg></group><replaceable>number</replaceable> + + <arg choice='plain'> + <option>-j</option> + </arg> + </group> <replaceable>number</replaceable> </arg> - <arg><option>--cores</option><replaceable>number</replaceable> + + <arg> + <option>--cores</option> <replaceable>number</replaceable> </arg> - <arg><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> + + <arg> + <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> </arg> + <arg> - <arg choice='plain'><option>--show-trace</option> + <arg choice='plain'> + <option>--show-trace</option> </arg> </arg> + <arg> - <arg choice='plain'><option>--help</option> + <arg choice='plain'> + <option>--help</option> </arg> </arg> </cmdsynopsis> @@ -106,7 +135,8 @@ </para> <variablelist> <varlistentry> - <term><option>--root</option> + <term> + <option>--root</option> </term> <listitem> <para> @@ -117,7 +147,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--system</option> + <term> + <option>--system</option> </term> <listitem> <para> @@ -135,7 +166,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>-I</option> + <term> + <option>-I</option> </term> <listitem> <para> @@ -147,9 +179,11 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--max-jobs</option> + <term> + <option>--max-jobs</option> </term> - <term><option>-j</option> + <term> + <option>-j</option> </term> <listitem> <para> @@ -160,7 +194,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--cores</option> + <term> + <option>--cores</option> </term> <listitem> <para> @@ -177,7 +212,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> + <term> + <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> </term> <listitem> <para> @@ -187,7 +223,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--show-trace</option> + <term> + <option>--show-trace</option> </term> <listitem> <para> @@ -197,7 +234,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--help</option> + <term> + <option>--help</option> </term> <listitem> <para> diff --git a/nixos/doc/manual/man-nixos-option.xml b/nixos/doc/manual/man-nixos-option.xml index c22c3811ded..d436cce742a 100644 --- a/nixos/doc/manual/man-nixos-option.xml +++ b/nixos/doc/manual/man-nixos-option.xml @@ -12,14 +12,22 @@ </refname><refpurpose>inspect a NixOS configuration</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-option</command> - <arg><option>-I</option><replaceable>path</replaceable> + <cmdsynopsis> + <command>nixos-option</command> + <arg> + <option>-I</option> <replaceable>path</replaceable> </arg> - <arg><option>--verbose</option> + + <arg> + <option>--verbose</option> </arg> - <arg><option>--xml</option> + + <arg> + <option>--xml</option> </arg> - <arg choice="plain"><replaceable>option.name</replaceable> + + <arg choice="plain"> + <replaceable>option.name</replaceable> </arg> </cmdsynopsis> </refsynopsisdiv> @@ -42,7 +50,8 @@ </para> <variablelist> <varlistentry> - <term><option>-I</option><replaceable>path</replaceable> + <term> + <option>-I</option> <replaceable>path</replaceable> </term> <listitem> <para> @@ -52,7 +61,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--verbose</option> + <term> + <option>--verbose</option> </term> <listitem> <para> @@ -62,7 +72,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>--xml</option> + <term> + <option>--xml</option> </term> <listitem> <para> @@ -76,7 +87,8 @@ <title>Environment</title> <variablelist> <varlistentry> - <term><envar>NIXOS_CONFIG</envar> + <term> + <envar>NIXOS_CONFIG</envar> </term> <listitem> <para> diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml index e1a2c7108d1..551a65f5e96 100644 --- a/nixos/doc/manual/man-nixos-rebuild.xml +++ b/nixos/doc/manual/man-nixos-rebuild.xml @@ -12,43 +12,75 @@ </refname><refpurpose>reconfigure a NixOS machine</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-rebuild</command><group choice='req'> - <arg choice='plain'><option>switch</option> + <cmdsynopsis> + <command>nixos-rebuild</command><group choice='req'> + <arg choice='plain'> + <option>switch</option> </arg> - <arg choice='plain'><option>boot</option> + + <arg choice='plain'> + <option>boot</option> </arg> - <arg choice='plain'><option>test</option> + + <arg choice='plain'> + <option>test</option> </arg> - <arg choice='plain'><option>build</option> + + <arg choice='plain'> + <option>build</option> </arg> - <arg choice='plain'><option>dry-build</option> + + <arg choice='plain'> + <option>dry-build</option> </arg> - <arg choice='plain'><option>dry-activate</option> + + <arg choice='plain'> + <option>dry-activate</option> </arg> - <arg choice='plain'><option>build-vm</option> + + <arg choice='plain'> + <option>build-vm</option> </arg> - <arg choice='plain'><option>build-vm-with-bootloader</option> - </arg></group> + + <arg choice='plain'> + <option>build-vm-with-bootloader</option> + </arg> + </group> <sbr /> - <arg><option>--upgrade</option> + <arg> + <option>--upgrade</option> </arg> - <arg><option>--install-bootloader</option> + + <arg> + <option>--install-bootloader</option> </arg> - <arg><option>--no-build-nix</option> + + <arg> + <option>--no-build-nix</option> </arg> - <arg><option>--fast</option> + + <arg> + <option>--fast</option> </arg> - <arg><option>--rollback</option> + + <arg> + <option>--rollback</option> </arg> <sbr /> - <arg><group choice='req'> - <arg choice='plain'><option>--profile-name</option> + <arg> + <group choice='req'> + <arg choice='plain'> + <option>--profile-name</option> + </arg> + + <arg choice='plain'> + <option>-p</option> </arg> - <arg choice='plain'><option>-p</option> - </arg></group><replaceable>name</replaceable> + </group> <replaceable>name</replaceable> </arg> <sbr /> - <arg><option>--show-trace</option> + <arg> + <option>--show-trace</option> </arg> </cmdsynopsis> </refsynopsisdiv> @@ -68,7 +100,8 @@ operation. It must be one of the following: <variablelist> <varlistentry> - <term><option>switch</option> + <term> + <option>switch</option> </term> <listitem> <para> @@ -82,7 +115,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>boot</option> + <term> + <option>boot</option> </term> <listitem> <para> @@ -94,7 +128,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>test</option> + <term> + <option>test</option> </term> <listitem> <para> @@ -107,7 +142,8 @@ </listitem> </varlistentry> <varlistentry> - <term><option>build</option> + <term> + <option>build</option> </term> <listitem> <para> @@ -124,7 +160,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system </listitem> </varlistentry> <varlistentry> - <term><option>dry-build</option> + <term> + <option>dry-build</option> </term> <listitem> <para> @@ -134,7 +171,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system </listitem> </varlistentry> <varlistentry> - <term><option>dry-activate</option> + <term> + <option>dry-activate</option> </term> <listitem> <para> @@ -147,7 +185,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system </listitem> </varlistentry> <varlistentry> - <term><option>build-vm</option> + <term> + <option>build-vm</option> </term> <listitem> <para> @@ -186,7 +225,8 @@ $ ./result/bin/run-*-vm </listitem> </varlistentry> <varlistentry> - <term><option>build-vm-with-bootloader</option> + <term> + <option>build-vm-with-bootloader</option> </term> <listitem> <para> @@ -213,7 +253,8 @@ $ ./result/bin/run-*-vm </para> <variablelist> <varlistentry> - <term><option>--upgrade</option> + <term> + <option>--upgrade</option> </term> <listitem> <para> @@ -222,7 +263,8 @@ $ ./result/bin/run-*-vm </listitem> </varlistentry> <varlistentry> - <term><option>--install-bootloader</option> + <term> + <option>--install-bootloader</option> </term> <listitem> <para> @@ -232,7 +274,8 @@ $ ./result/bin/run-*-vm </listitem> </varlistentry> <varlistentry> - <term><option>--no-build-nix</option> + <term> + <option>--no-build-nix</option> </term> <listitem> <para> @@ -246,7 +289,8 @@ $ ./result/bin/run-*-vm </listitem> </varlistentry> <varlistentry> - <term><option>--fast</option> + <term> + <option>--fast</option> </term> <listitem> <para> @@ -258,7 +302,8 @@ $ ./result/bin/run-*-vm </listitem> </varlistentry> <varlistentry> - <term><option>--rollback</option> + <term> + <option>--rollback</option> </term> <listitem> <para> @@ -271,9 +316,11 @@ $ ./result/bin/run-*-vm </listitem> </varlistentry> <varlistentry> - <term><option>--profile-name</option> + <term> + <option>--profile-name</option> </term> - <term><option>-p</option> + <term> + <option>-p</option> </term> <listitem> <para> @@ -299,7 +346,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix </listitem> </varlistentry> <varlistentry> - <term><option>--build-host</option> + <term> + <option>--build-host</option> </term> <listitem> <para> @@ -323,7 +371,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix </listitem> </varlistentry> <varlistentry> - <term><option>--target-host</option> + <term> + <option>--target-host</option> </term> <listitem> <para> @@ -361,7 +410,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix <title>Environment</title> <variablelist> <varlistentry> - <term><envar>NIXOS_CONFIG</envar> + <term> + <envar>NIXOS_CONFIG</envar> </term> <listitem> <para> @@ -371,7 +421,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix </listitem> </varlistentry> <varlistentry> - <term><envar>NIX_SSHOPTS</envar> + <term> + <envar>NIX_SSHOPTS</envar> </term> <listitem> <para> @@ -386,7 +437,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix <title>Files</title> <variablelist> <varlistentry> - <term><filename>/run/current-system</filename> + <term> + <filename>/run/current-system</filename> </term> <listitem> <para> @@ -395,7 +447,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix </listitem> </varlistentry> <varlistentry> - <term><filename>/nix/var/nix/profiles/system</filename> + <term> + <filename>/nix/var/nix/profiles/system</filename> </term> <listitem> <para> diff --git a/nixos/doc/manual/man-nixos-version.xml b/nixos/doc/manual/man-nixos-version.xml index c173bce1913..931c4a5ad02 100644 --- a/nixos/doc/manual/man-nixos-version.xml +++ b/nixos/doc/manual/man-nixos-version.xml @@ -11,10 +11,14 @@ </refname><refpurpose>show the NixOS version</refpurpose> </refnamediv> <refsynopsisdiv> - <cmdsynopsis><command>nixos-version</command> - <arg><option>--hash</option> + <cmdsynopsis> + <command>nixos-version</command> + <arg> + <option>--hash</option> </arg> - <arg><option>--revision</option> + + <arg> + <option>--revision</option> </arg> </cmdsynopsis> </refsynopsisdiv> @@ -29,7 +33,8 @@ The version consists of the following elements: <variablelist> <varlistentry> - <term><literal>16.03</literal> + <term> + <literal>16.03</literal> </term> <listitem> <para> @@ -39,7 +44,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>1011</literal> + <term> + <literal>1011</literal> </term> <listitem> <para> @@ -53,7 +59,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>6317da4</literal> + <term> + <literal>6317da4</literal> </term> <listitem> <para> @@ -63,7 +70,8 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>Emu</literal> + <term> + <literal>Emu</literal> </term> <listitem> <para> @@ -83,9 +91,11 @@ </para> <variablelist> <varlistentry> - <term><option>--hash</option> + <term> + <option>--hash</option> </term> - <term><option>--revision</option> + <term> + <option>--revision</option> </term> <listitem> <para> diff --git a/nixos/doc/manual/release-notes/rl-1509.xml b/nixos/doc/manual/release-notes/rl-1509.xml index 734bc076b85..2465f370cf1 100644 --- a/nixos/doc/manual/release-notes/rl-1509.xml +++ b/nixos/doc/manual/release-notes/rl-1509.xml @@ -435,11 +435,11 @@ system.autoUpgrade.enable = true; <programlisting> system.nixos.stateVersion = "14.12"; </programlisting> - The new option <option>system.nixos.stateVersion</option> ensures that certain - configuration changes that could break existing systems (such as the - <command>sshd</command> host key setting) will maintain compatibility with - the specified NixOS release. NixOps sets the state version of existing - deployments automatically. + The new option <option>system.nixos.stateVersion</option> ensures that + certain configuration changes that could break existing systems (such as + the <command>sshd</command> host key setting) will maintain compatibility + with the specified NixOS release. NixOps sets the state version of + existing deployments automatically. </para> </listitem> <listitem> diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml index 35dc69515ff..ae0f35046ff 100644 --- a/nixos/doc/manual/release-notes/rl-1809.xml +++ b/nixos/doc/manual/release-notes/rl-1809.xml @@ -53,10 +53,12 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' <itemizedlist> <listitem> - <para>When enabled the <literal>iproute2</literal> will copy the files - expected by ip route (e.g., <filename>rt_tables</filename>) in - <filename>/run/iproute2</filename>. This allows to write aliases for - routing tables for instance.</para> + <para> + When enabled the <literal>iproute2</literal> will copy the files expected + by ip route (e.g., <filename>rt_tables</filename>) in + <filename>/run/iproute2</filename>. This allows to write aliases for + routing tables for instance. + </para> </listitem> </itemizedlist> </section> @@ -99,20 +101,24 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' </listitem> <listitem> <para> - The <varname>services.docker-registry.extraConfig</varname> object doesn't contain - environment variables anymore. Instead it needs to provide an object structure - that can be mapped onto the YAML configuration defined in <link xlink:href="https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md">the <varname>docker/distribution</varname> docs</link>. + The <varname>services.docker-registry.extraConfig</varname> object doesn't + contain environment variables anymore. Instead it needs to provide an + object structure that can be mapped onto the YAML configuration defined in + <link xlink:href="https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md">the + <varname>docker/distribution</varname> docs</link>. </para> </listitem> <listitem> <para> - <literal>gnucash</literal> has changed from version 2.4 to 3.x. - If you've been using <literal>gnucash</literal> (version 2.4) instead of - <literal>gnucash26</literal> (version 2.6) you must open your Gnucash - data file(s) with <literal>gnucash26</literal> and then save them to - upgrade the file format. Then you may use your data file(s) with - Gnucash 3.x. See the upgrade <link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>. - Gnucash 2.4 is still available under the attribute <literal>gnucash24</literal>. + <literal>gnucash</literal> has changed from version 2.4 to 3.x. If you've + been using <literal>gnucash</literal> (version 2.4) instead of + <literal>gnucash26</literal> (version 2.6) you must open your Gnucash data + file(s) with <literal>gnucash26</literal> and then save them to upgrade + the file format. Then you may use your data file(s) with Gnucash 3.x. See + the upgrade + <link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>. + Gnucash 2.4 is still available under the attribute + <literal>gnucash24</literal>. </para> </listitem> </itemizedlist> @@ -128,9 +134,9 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' <itemizedlist> <listitem> <para> - <literal>dockerTools.pullImage</literal> relies on image digest - instead of image tag to download the image. The - <literal>sha256</literal> of a pulled image has to be updated. + <literal>dockerTools.pullImage</literal> relies on image digest instead of + image tag to download the image. The <literal>sha256</literal> of a pulled + image has to be updated. </para> </listitem> <listitem> @@ -187,32 +193,40 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' <para> The module for <option>security.dhparams</option> has two new options now: </para> - <variablelist> <varlistentry> - <term><option>security.dhparams.stateless</option></term> - <listitem><para> - Puts the generated Diffie-Hellman parameters into the Nix store instead - of managing them in a stateful manner in - <filename class="directory">/var/lib/dhparams</filename>. - </para></listitem> + <term> + <option>security.dhparams.stateless</option> + </term> + <listitem> + <para> + Puts the generated Diffie-Hellman parameters into the Nix store instead + of managing them in a stateful manner in + <filename class="directory">/var/lib/dhparams</filename>. + </para> + </listitem> </varlistentry> <varlistentry> - <term><option>security.dhparams.defaultBitSize</option></term> - <listitem><para> - The default bit size to use for the generated Diffie-Hellman parameters. - </para></listitem> + <term> + <option>security.dhparams.defaultBitSize</option> + </term> + <listitem> + <para> + The default bit size to use for the generated Diffie-Hellman + parameters. + </para> + </listitem> </varlistentry> </variablelist> - - <note><para> - The path to the actual generated parameter files should now be queried - using - <literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal> - because it might be either in the Nix store or in a directory configured - by <option>security.dhparams.path</option>. - </para></note> - + <note> + <para> + The path to the actual generated parameter files should now be queried + using + <literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal> + because it might be either in the Nix store or in a directory configured + by <option>security.dhparams.path</option>. + </para> + </note> <note> <title>For developers:</title> <para> @@ -237,20 +251,23 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' </listitem> <listitem> <para> - <literal>networking.networkmanager.useDnsmasq</literal> has been deprecated. Use - <literal>networking.networkmanager.dns</literal> instead. + <literal>networking.networkmanager.useDnsmasq</literal> has been + deprecated. Use <literal>networking.networkmanager.dns</literal> instead. </para> </listitem> <listitem> <para> - The option <varname>services.kubernetes.apiserver.admissionControl</varname> - was renamed to <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>. + The option + <varname>services.kubernetes.apiserver.admissionControl</varname> was + renamed to + <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>. </para> </listitem> <listitem> <para> Recommented way to access the Kubernetes Dashboard is with HTTPS (TLS) - Therefore; public service port for the dashboard has changed to 443 (container port 8443) and scheme to https. + Therefore; public service port for the dashboard has changed to 443 + (container port 8443) and scheme to https. </para> </listitem> </itemizedlist> diff --git a/nixos/doc/manual/shell.nix b/nixos/doc/manual/shell.nix index 7f8422b4ec1..cc3609d750e 100644 --- a/nixos/doc/manual/shell.nix +++ b/nixos/doc/manual/shell.nix @@ -4,5 +4,5 @@ in pkgs.mkShell { name = "nixos-manual"; - buildInputs = with pkgs; [ xmlformat jing xmloscopy ]; + buildInputs = with pkgs; [ xmlformat jing xmloscopy ruby ]; } diff --git a/nixos/doc/varlistentry-fixer.rb b/nixos/doc/varlistentry-fixer.rb new file mode 100755 index 00000000000..6c7cc1e6439 --- /dev/null +++ b/nixos/doc/varlistentry-fixer.rb @@ -0,0 +1,124 @@ +#!/usr/bin/env ruby + +# This script is written intended as a living, evolving tooling +# to fix oopsies within the docbook documentation. +# +# This is *not* a formatter. It, instead, handles some known cases +# where something bad happened, and fixing it manually is tedious. +# +# Read the code to see the different cases it handles. +# +# ALWAYS `make format` after fixing with this! +# ALWAYS read the changes, this tool isn't yet proven to be always right. + +require "rexml/document" +include REXML + +if ARGV.length < 1 then + $stderr.puts "Needs a filename." + exit 1 +end + +filename = ARGV.shift +doc = Document.new(File.open(filename)) + +$touched = false + +# Fixing varnames having a sibling element without spacing. +# This is to fix an initial `xmlformat` issue where `term` +# would mangle as spaces. +# +# <varlistentry> +# <term><varname>types.separatedString</varname><replaceable>sep</replaceable> <---- +# </term> +# ... +# +# Generates: types.separatedStringsep +# ^^^^ +# +# <varlistentry xml:id='fun-makeWrapper'> +# <term> +# <function>makeWrapper</function><replaceable>executable</replaceable><replaceable>wrapperfile</replaceable><replaceable>args</replaceable> <---- +# </term> +# +# Generates: makeWrapperexecutablewrapperfileargs +# ^^^^ ^^^^ ^^ ^^ +# +# <term> +# <option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> <----- +# </term> +# +# Generates: --optionnamevalue +# ^^ ^^ +doc.elements.each("//varlistentry/term") do |term| + ["varname", "function", "option", "replaceable"].each do |prev_name| + term.elements.each(prev_name) do |el| + if el.next_element and + el.next_element.name == "replaceable" and + el.next_sibling_node.class == Element + then + $touched = true + term.insert_after(el, Text.new(" ")) + end + end + end +end + + + +# <cmdsynopsis> +# <command>nixos-option</command> +# <arg> +# <option>-I</option><replaceable>path</replaceable> <------ +# </arg> +# +# Generates: -Ipath +# ^^ +doc.elements.each("//cmdsynopsis/arg") do |term| + ["option", "replaceable"].each do |prev_name| + term.elements.each(prev_name) do |el| + if el.next_element and + el.next_element.name == "replaceable" and + el.next_sibling_node.class == Element + then + $touched = true + term.insert_after(el, Text.new(" ")) + end + end + end +end + +# <cmdsynopsis> +# <arg> +# <group choice='req'> +# <arg choice='plain'> +# <option>--profile-name</option> +# </arg> +# +# <arg choice='plain'> +# <option>-p</option> +# </arg> +# </group><replaceable>name</replaceable> <---- +# </arg> +# +# Generates: [{--profile-name | -p }name] +# ^^^^ +doc.elements.each("//cmdsynopsis/arg") do |term| + ["group"].each do |prev_name| + term.elements.each(prev_name) do |el| + if el.next_element and + el.next_element.name == "replaceable" and + el.next_sibling_node.class == Element + then + $touched = true + term.insert_after(el, Text.new(" ")) + end + end + end +end + + +if $touched then + doc.context[:attribute_quote] = :quote + doc.write(output: File.open(filename, "w")) +end diff --git a/nixos/doc/xmlformat.conf b/nixos/doc/xmlformat.conf index 50255857b24..4a565c8465b 100644 --- a/nixos/doc/xmlformat.conf +++ b/nixos/doc/xmlformat.conf @@ -67,6 +67,7 @@ programlisting screen entry-break = 0 exit-break = 0 - -#term -# format inline +# This is needed so that the spacing inside those tags is kept. +term cmdsynopsis arg + normalize yes + format block |