diff options
author | Robert Hensing <robert@roberthensing.nl> | 2022-09-29 12:41:59 +0200 |
---|---|---|
committer | Robert Hensing <robert@roberthensing.nl> | 2022-09-29 12:41:59 +0200 |
commit | 216c5dc10dd9d842909fe256567e9aeda3212396 (patch) | |
tree | f4f3106f16215b6332e750fd1e97b064fc160fe4 | |
parent | 91879ce1604060e3b91d275f7686b98d2357c9a6 (diff) | |
download | nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.tar nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.tar.gz nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.tar.bz2 nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.tar.lz nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.tar.xz nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.tar.zst nixpkgs-216c5dc10dd9d842909fe256567e9aeda3212396.zip |
nixos/doc: Disambiguate test option ids
Changing this later on would break external links into the manual.
-rw-r--r-- | nixos/doc/manual/default.nix | 1 | ||||
-rw-r--r-- | nixos/doc/manual/development/running-nixos-tests-interactively.section.md | 4 | ||||
-rw-r--r-- | nixos/doc/manual/development/writing-nixos-tests.section.md | 12 | ||||
-rw-r--r-- | nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml | 4 | ||||
-rw-r--r-- | nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml | 12 | ||||
-rw-r--r-- | nixos/lib/testing/driver.nix | 6 | ||||
-rw-r--r-- | nixos/lib/testing/meta.nix | 4 | ||||
-rw-r--r-- | nixos/lib/testing/name.nix | 2 | ||||
-rw-r--r-- | nixos/lib/testing/nodes.nix | 8 |
9 files changed, 27 insertions, 26 deletions
diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix index ecd62eb4e84..6db20cdd641 100644 --- a/nixos/doc/manual/default.nix +++ b/nixos/doc/manual/default.nix @@ -63,6 +63,7 @@ let }; documentType = "none"; variablelistId = "test-options-list"; + optionIdPrefix = "test-opt-"; }; sources = lib.sourceFilesBySuffices ./. [".xml"]; diff --git a/nixos/doc/manual/development/running-nixos-tests-interactively.section.md b/nixos/doc/manual/development/running-nixos-tests-interactively.section.md index d9c316f4b13..1130672cb37 100644 --- a/nixos/doc/manual/development/running-nixos-tests-interactively.section.md +++ b/nixos/doc/manual/development/running-nixos-tests-interactively.section.md @@ -39,11 +39,11 @@ directory. ## Interactive-only test configuration {#sec-nixos-test-interactive-configuration} The `.driverInteractive` attribute combines the regular test configuration with -definitions from the [`interactive` submodule](#opt-interactive). This gives you +definitions from the [`interactive` submodule](#test-opt-interactive). This gives you a more usable, graphical, but slightly different configuration. You can add your own interactive-only test configuration by adding extra -configuration to the [`interactive` submodule](#opt-interactive). +configuration to the [`interactive` submodule](#test-opt-interactive). To interactively run only the regular configuration, build the `<test>.driver` attribute instead, and call it with the flag `result/bin/nixos-test-driver --interactive`. diff --git a/nixos/doc/manual/development/writing-nixos-tests.section.md b/nixos/doc/manual/development/writing-nixos-tests.section.md index 99704ec3c14..2efe52b9883 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.section.md +++ b/nixos/doc/manual/development/writing-nixos-tests.section.md @@ -22,12 +22,12 @@ A NixOS test is a module that has the following structure: ``` We refer to the whole test above as a test module, whereas the values -in [`nodes.<name>`](#opt-nodes) are NixOS modules themselves. +in [`nodes.<name>`](#test-opt-nodes) are NixOS modules themselves. -The option [`testScript`](#opt-testScript) is a piece of Python code that executes the +The option [`testScript`](#test-opt-testScript) is a piece of Python code that executes the test (described below). During the test, it will start one or more virtual machines, the configuration of which is described by -the option [`nodes`](#opt-nodes). +the option [`nodes`](#test-opt-nodes). An example of a single-node test is [`login.nix`](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/login.nix). @@ -171,7 +171,7 @@ The following methods are available on machine objects: least one will be returned. ::: {.note} - This requires [`enableOCR`](#opt-enableOCR) to be set to `true`. + This requires [`enableOCR`](#test-opt-enableOCR) to be set to `true`. ::: `get_screen_text` @@ -180,7 +180,7 @@ The following methods are available on machine objects: machine\'s screen using optical character recognition. ::: {.note} - This requires [`enableOCR`](#opt-enableOCR) to be set to `true`. + This requires [`enableOCR`](#test-opt-enableOCR) to be set to `true`. ::: `send_monitor_command` @@ -291,7 +291,7 @@ The following methods are available on machine objects: `get_screen_text` and `get_screen_text_variants`). ::: {.note} - This requires [`enableOCR`](#opt-enableOCR) to be set to `true`. + This requires [`enableOCR`](#test-opt-enableOCR) to be set to `true`. ::: `wait_for_console_text` diff --git a/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml b/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml index 35d9bbd1c1f..16db709f8b9 100644 --- a/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml +++ b/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml @@ -44,14 +44,14 @@ $ ./result/bin/nixos-test-driver --keep-vm-state <para> The <literal>.driverInteractive</literal> attribute combines the regular test configuration with definitions from the - <link linkend="opt-interactive"><literal>interactive</literal> + <link linkend="test-opt-interactive"><literal>interactive</literal> submodule</link>. This gives you a more usable, graphical, but slightly different configuration. </para> <para> You can add your own interactive-only test configuration by adding extra configuration to the - <link linkend="opt-interactive"><literal>interactive</literal> + <link linkend="test-opt-interactive"><literal>interactive</literal> submodule</link>. </para> <para> diff --git a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml index 32f5fdb77f5..4db196273da 100644 --- a/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml +++ b/nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml @@ -24,16 +24,16 @@ <para> We refer to the whole test above as a test module, whereas the values in - <link linkend="opt-nodes"><literal>nodes.<name></literal></link> + <link linkend="test-opt-nodes"><literal>nodes.<name></literal></link> are NixOS modules themselves. </para> <para> The option - <link linkend="opt-testScript"><literal>testScript</literal></link> + <link linkend="test-opt-testScript"><literal>testScript</literal></link> is a piece of Python code that executes the test (described below). During the test, it will start one or more virtual machines, the configuration of which is described by the option - <link linkend="opt-nodes"><literal>nodes</literal></link>. + <link linkend="test-opt-nodes"><literal>nodes</literal></link>. </para> <para> An example of a single-node test is @@ -263,7 +263,7 @@ start_all() <note> <para> This requires - <link linkend="opt-enableOCR"><literal>enableOCR</literal></link> + <link linkend="test-opt-enableOCR"><literal>enableOCR</literal></link> to be set to <literal>true</literal>. </para> </note> @@ -281,7 +281,7 @@ start_all() <note> <para> This requires - <link linkend="opt-enableOCR"><literal>enableOCR</literal></link> + <link linkend="test-opt-enableOCR"><literal>enableOCR</literal></link> to be set to <literal>true</literal>. </para> </note> @@ -522,7 +522,7 @@ start_all() <note> <para> This requires - <link linkend="opt-enableOCR"><literal>enableOCR</literal></link> + <link linkend="test-opt-enableOCR"><literal>enableOCR</literal></link> to be set to <literal>true</literal>. </para> </note> diff --git a/nixos/lib/testing/driver.nix b/nixos/lib/testing/driver.nix index 04e99f9e21d..fb181c1d7e9 100644 --- a/nixos/lib/testing/driver.nix +++ b/nixos/lib/testing/driver.nix @@ -120,7 +120,7 @@ in }; qemu.package = mkOption { - description = mdDoc "Which qemu package to use for the virtualisation of [{option}`nodes`](#opt-nodes)."; + description = mdDoc "Which qemu package to use for the virtualisation of [{option}`nodes`](#test-opt-nodes)."; type = types.package; default = hostPkgs.qemu_test; defaultText = "hostPkgs.qemu_test"; @@ -152,7 +152,7 @@ in description = mdDoc '' Extra arguments to pass to the test driver. - They become part of [{option}`driver`](#opt-driver) via `wrapProgram`. + They become part of [{option}`driver`](#test-opt-driver) via `wrapProgram`. ''; type = types.listOf types.str; default = []; @@ -172,7 +172,7 @@ in description = mdDoc '' Disable type checking. This must not be enabled for new NixOS tests. - This may speed up your iteration cycle, unless you're working on the [{option}`testScript`](#opt-testScript). + This may speed up your iteration cycle, unless you're working on the [{option}`testScript`](#test-opt-testScript). ''; }; }; diff --git a/nixos/lib/testing/meta.nix b/nixos/lib/testing/meta.nix index 4d8b0e0f1c4..65754fe3c54 100644 --- a/nixos/lib/testing/meta.nix +++ b/nixos/lib/testing/meta.nix @@ -24,14 +24,14 @@ in type = types.nullOr types.int; default = null; # NOTE: null values are filtered out by `meta`. description = mdDoc '' - The [{option}`test`](#opt-test)'s [`meta.timeout`](https://nixos.org/manual/nixpkgs/stable/#var-meta-timeout) in seconds. + The [{option}`test`](#test-opt-test)'s [`meta.timeout`](https://nixos.org/manual/nixpkgs/stable/#var-meta-timeout) in seconds. ''; }; broken = lib.mkOption { type = types.bool; default = false; description = mdDoc '' - Sets the [`meta.broken`](https://nixos.org/manual/nixpkgs/stable/#var-meta-broken) attribute on the [{option}`test`](#opt-test) derivation. + Sets the [`meta.broken`](https://nixos.org/manual/nixpkgs/stable/#var-meta-broken) attribute on the [{option}`test`](#test-opt-test) derivation. ''; }; }; diff --git a/nixos/lib/testing/name.nix b/nixos/lib/testing/name.nix index a54622e139b..0af593169ee 100644 --- a/nixos/lib/testing/name.nix +++ b/nixos/lib/testing/name.nix @@ -7,7 +7,7 @@ in description = mdDoc '' The name of the test. - This is used in the derivation names of the [{option}`driver`](#opt-driver) and [{option}`test`](#opt-test) runner. + This is used in the derivation names of the [{option}`driver`](#test-opt-driver) and [{option}`test`](#test-opt-test) runner. ''; type = types.str; }; diff --git a/nixos/lib/testing/nodes.nix b/nixos/lib/testing/nodes.nix index 765af2878df..0395238cbaa 100644 --- a/nixos/lib/testing/nodes.nix +++ b/nixos/lib/testing/nodes.nix @@ -44,7 +44,7 @@ in description = mdDoc '' An attribute set of NixOS configuration modules. - The configurations are augmented by the [`defaults`](#opt-defaults) option. + The configurations are augmented by the [`defaults`](#test-opt-defaults) option. They are assigned network addresses according to the `nixos/lib/testing/network.nix` module. @@ -54,7 +54,7 @@ in defaults = mkOption { description = mdDoc '' - NixOS configuration that is applied to all [{option}`nodes`](#opt-nodes). + NixOS configuration that is applied to all [{option}`nodes`](#test-opt-nodes). ''; type = types.deferredModule; default = { }; @@ -62,7 +62,7 @@ in extraBaseModules = mkOption { description = mdDoc '' - NixOS configuration that, like [{option}`defaults`](#opt-defaults), is applied to all [{option}`nodes`](#opt-nodes) and can not be undone with [`specialisation.<name>.inheritParentConfig`](https://search.nixos.org/options?show=specialisation.%3Cname%3E.inheritParentConfig&from=0&size=50&sort=relevance&type=packages&query=specialisation). + NixOS configuration that, like [{option}`defaults`](#test-opt-defaults), is applied to all [{option}`nodes`](#test-opt-nodes) and can not be undone with [`specialisation.<name>.inheritParentConfig`](https://search.nixos.org/options?show=specialisation.%3Cname%3E.inheritParentConfig&from=0&size=50&sort=relevance&type=packages&query=specialisation). ''; type = types.deferredModule; default = { }; @@ -82,7 +82,7 @@ in type = types.bool; default = false; description = mdDoc '' - Enable to configure all [{option}`nodes`](#opt-nodes) to run with a minimal kernel. + Enable to configure all [{option}`nodes`](#test-opt-nodes) to run with a minimal kernel. ''; }; |