diff options
Diffstat (limited to 'nixos/doc/manual/development')
-rw-r--r-- | nixos/doc/manual/development/building-parts.xml | 27 | ||||
-rw-r--r-- | nixos/doc/manual/development/option-declarations.xml | 12 | ||||
-rw-r--r-- | nixos/doc/manual/development/option-types.xml | 129 | ||||
-rw-r--r-- | nixos/doc/manual/development/writing-nixos-tests.xml | 81 |
4 files changed, 166 insertions, 83 deletions
diff --git a/nixos/doc/manual/development/building-parts.xml b/nixos/doc/manual/development/building-parts.xml index 031048aaa377..eaffc0ef47c2 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 a8f528a0a804..eee81bf64263 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 5cb747e6d9f1..bf2e38b4c4d6 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 89a6a4423627..5935fbc049bd 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> |