diff options
author | Robert Hensing <robert@roberthensing.nl> | 2022-08-19 12:09:58 +0200 |
---|---|---|
committer | Robert Hensing <robert@roberthensing.nl> | 2022-09-24 17:42:52 +0100 |
commit | 7cdc9bc34012e367522b6ac7ed98631fa95c5deb (patch) | |
tree | bdc43a037a100379fe9950430125ff60acf04b41 /nixos/doc | |
parent | 6a78b414768de3f8107e1eecdf79121f3ee0c8a0 (diff) | |
download | nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.tar nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.tar.gz nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.tar.bz2 nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.tar.lz nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.tar.xz nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.tar.zst nixpkgs-7cdc9bc34012e367522b6ac7ed98631fa95c5deb.zip |
nixos/testing: Improve interactive docs
Diffstat (limited to 'nixos/doc')
-rw-r--r-- | nixos/doc/manual/development/running-nixos-tests-interactively.section.md | 12 | ||||
-rw-r--r-- | nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml | 23 |
2 files changed, 26 insertions, 9 deletions
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 6170057442d..d9c316f4b13 100644 --- a/nixos/doc/manual/development/running-nixos-tests-interactively.section.md +++ b/nixos/doc/manual/development/running-nixos-tests-interactively.section.md @@ -38,6 +38,12 @@ directory. ## Interactive-only test configuration {#sec-nixos-test-interactive-configuration} -You can add configuration that is specific to the interactive test driver, by adding to the `interactive` option. -`interactive` is a copy of the regular test options namespace, and is used by the interactive test driver. -It can be helpful for troubleshooting changes that you don't want to apply to regular test runs. +The `.driverInteractive` attribute combines the regular test configuration with +definitions from the [`interactive` submodule](#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). + +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/from_md/development/running-nixos-tests-interactively.section.xml b/nixos/doc/manual/from_md/development/running-nixos-tests-interactively.section.xml index edd3c33ff40..35d9bbd1c1f 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 @@ -42,12 +42,23 @@ $ ./result/bin/nixos-test-driver --keep-vm-state <section xml:id="sec-nixos-test-interactive-configuration"> <title>Interactive-only test configuration</title> <para> - You can add configuration that is specific to the interactive test - driver, by adding to the <literal>interactive</literal> option. - <literal>interactive</literal> is a copy of the regular test - options namespace, and is used by the interactive test driver. It - can be helpful for troubleshooting changes that you don’t want to - apply to regular test runs. + The <literal>.driverInteractive</literal> attribute combines the + regular test configuration with definitions from the + <link linkend="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> + submodule</link>. + </para> + <para> + To interactively run only the regular configuration, build the + <literal><test>.driver</literal> attribute instead, and call + it with the flag + <literal>result/bin/nixos-test-driver --interactive</literal>. </para> </section> </section> |